{ "author": { "email": "thorsten.hoeger@taimos.de", "name": "Open Construct Foundation", "roles": [ "author" ] }, "dependencies": { "aws-cdk-lib": "^2.168.0", "constructs": "^10.3.0" }, "dependencyClosure": { "@aws-cdk/asset-awscli-v1": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Asset.AwsCliV1", "packageId": "Amazon.CDK.Asset.AwsCliV1" }, "go": { "moduleName": "github.com/cdklabs/awscdk-asset-awscli-go", "packageName": "awscliv1" }, "java": { "maven": { "artifactId": "cdk-asset-awscli-v1", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cdk.asset.awscli.v1" }, "js": { "npm": "@aws-cdk/asset-awscli-v1" }, "python": { "distName": "aws-cdk.asset-awscli-v1", "module": "aws_cdk.asset_awscli_v1" } } }, "@aws-cdk/asset-kubectl-v20": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Asset.KubectlV20", "packageId": "Amazon.CDK.Asset.KubectlV20" }, "go": { "moduleName": "github.com/cdklabs/awscdk-asset-kubectl-go", "packageName": "kubectlv20" }, "java": { "maven": { "artifactId": "cdk-asset-kubectl-v20", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cdk.asset.kubectl.v20" }, "js": { "npm": "@aws-cdk/asset-kubectl-v20" }, "python": { "distName": "aws-cdk.asset-kubectl-v20", "module": "aws_cdk.asset_kubectl_v20" } } }, "@aws-cdk/asset-node-proxy-agent-v6": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Asset.NodeProxyAgentV6", "packageId": "Amazon.CDK.Asset.NodeProxyAgentV6" }, "go": { "moduleName": "github.com/cdklabs/awscdk-asset-node-proxy-agent-go", "packageName": "nodeproxyagentv6" }, "java": { "maven": { "artifactId": "cdk-asset-node-proxy-agent-v6", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cdk.asset.node.proxy.agent.v6" }, "js": { "npm": "@aws-cdk/asset-node-proxy-agent-v6" }, "python": { "distName": "aws-cdk.asset-node-proxy-agent-v6", "module": "aws_cdk.asset_node_proxy_agent_v6" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/main/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "go": { "moduleName": "github.com/cdklabs/cloud-assembly-schema-go" }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 2" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "aws-cdk-lib": { "submodules": { "aws-cdk-lib.alexa_ask": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Alexa.Ask" }, "java": { "package": "software.amazon.awscdk.alexa.ask" }, "python": { "module": "aws_cdk.alexa_ask" } } }, "aws-cdk-lib.assertions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Assertions" }, "java": { "package": "software.amazon.awscdk.assertions" }, "python": { "module": "aws_cdk.assertions" } } }, "aws-cdk-lib.assets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Assets" }, "java": { "package": "software.amazon.awscdk.assets" }, "python": { "module": "aws_cdk.assets" } } }, "aws-cdk-lib.aws_accessanalyzer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AccessAnalyzer" }, "java": { "package": "software.amazon.awscdk.services.accessanalyzer" }, "python": { "module": "aws_cdk.aws_accessanalyzer" } } }, "aws-cdk-lib.aws_acmpca": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ACMPCA" }, "java": { "package": "software.amazon.awscdk.services.acmpca" }, "python": { "module": "aws_cdk.aws_acmpca" } } }, "aws-cdk-lib.aws_amazonmq": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AmazonMQ" }, "java": { "package": "software.amazon.awscdk.services.amazonmq" }, "python": { "module": "aws_cdk.aws_amazonmq" } } }, "aws-cdk-lib.aws_amplify": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Amplify" }, "java": { "package": "software.amazon.awscdk.services.amplify" }, "python": { "module": "aws_cdk.aws_amplify" } } }, "aws-cdk-lib.aws_amplifyuibuilder": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AmplifyUIBuilder" }, "java": { "package": "software.amazon.awscdk.services.amplifyuibuilder" }, "python": { "module": "aws_cdk.aws_amplifyuibuilder" } } }, "aws-cdk-lib.aws_apigateway": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.APIGateway" }, "java": { "package": "software.amazon.awscdk.services.apigateway" }, "python": { "module": "aws_cdk.aws_apigateway" } } }, "aws-cdk-lib.aws_apigatewayv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Apigatewayv2" }, "java": { "package": "software.amazon.awscdk.services.apigatewayv2" }, "python": { "module": "aws_cdk.aws_apigatewayv2" } } }, "aws-cdk-lib.aws_apigatewayv2_authorizers": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AwsApigatewayv2Authorizers" }, "java": { "package": "software.amazon.awscdk.aws_apigatewayv2_authorizers" }, "python": { "module": "aws_cdk.aws_apigatewayv2_authorizers" } } }, "aws-cdk-lib.aws_apigatewayv2_integrations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AwsApigatewayv2Integrations" }, "java": { "package": "software.amazon.awscdk.aws_apigatewayv2_integrations" }, "python": { "module": "aws_cdk.aws_apigatewayv2_integrations" } } }, "aws-cdk-lib.aws_appconfig": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppConfig" }, "java": { "package": "software.amazon.awscdk.services.appconfig" }, "python": { "module": "aws_cdk.aws_appconfig" } } }, "aws-cdk-lib.aws_appflow": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppFlow" }, "java": { "package": "software.amazon.awscdk.services.appflow" }, "python": { "module": "aws_cdk.aws_appflow" } } }, "aws-cdk-lib.aws_appintegrations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppIntegrations" }, "java": { "package": "software.amazon.awscdk.services.appintegrations" }, "python": { "module": "aws_cdk.aws_appintegrations" } } }, "aws-cdk-lib.aws_applicationautoscaling": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ApplicationAutoScaling" }, "java": { "package": "software.amazon.awscdk.services.applicationautoscaling" }, "python": { "module": "aws_cdk.aws_applicationautoscaling" } } }, "aws-cdk-lib.aws_applicationinsights": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ApplicationInsights" }, "java": { "package": "software.amazon.awscdk.services.applicationinsights" }, "python": { "module": "aws_cdk.aws_applicationinsights" } } }, "aws-cdk-lib.aws_applicationsignals": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.ApplicationSignals" }, "java": { "package": "software.amazon.awscdk.services.applicationsignals" }, "python": { "module": "aws_cdk.aws_applicationsignals" } } }, "aws-cdk-lib.aws_appmesh": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppMesh" }, "java": { "package": "software.amazon.awscdk.services.appmesh" }, "python": { "module": "aws_cdk.aws_appmesh" } } }, "aws-cdk-lib.aws_apprunner": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppRunner" }, "java": { "package": "software.amazon.awscdk.services.apprunner" }, "python": { "module": "aws_cdk.aws_apprunner" } } }, "aws-cdk-lib.aws_appstream": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppStream" }, "java": { "package": "software.amazon.awscdk.services.appstream" }, "python": { "module": "aws_cdk.aws_appstream" } } }, "aws-cdk-lib.aws_appsync": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AppSync" }, "java": { "package": "software.amazon.awscdk.services.appsync" }, "python": { "module": "aws_cdk.aws_appsync" } } }, "aws-cdk-lib.aws_apptest": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.AppTest" }, "java": { "package": "software.amazon.awscdk.services.apptest" }, "python": { "module": "aws_cdk.aws_apptest" } } }, "aws-cdk-lib.aws_aps": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.APS" }, "java": { "package": "software.amazon.awscdk.services.aps" }, "python": { "module": "aws_cdk.aws_aps" } } }, "aws-cdk-lib.aws_arczonalshift": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.ARCZonalShift" }, "java": { "package": "software.amazon.awscdk.services.arczonalshift" }, "python": { "module": "aws_cdk.aws_arczonalshift" } } }, "aws-cdk-lib.aws_athena": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Athena" }, "java": { "package": "software.amazon.awscdk.services.athena" }, "python": { "module": "aws_cdk.aws_athena" } } }, "aws-cdk-lib.aws_auditmanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AuditManager" }, "java": { "package": "software.amazon.awscdk.services.auditmanager" }, "python": { "module": "aws_cdk.aws_auditmanager" } } }, "aws-cdk-lib.aws_autoscaling": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScaling" }, "java": { "package": "software.amazon.awscdk.services.autoscaling" }, "python": { "module": "aws_cdk.aws_autoscaling" } } }, "aws-cdk-lib.aws_autoscaling_common": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScaling.Common" }, "java": { "package": "software.amazon.awscdk.services.autoscaling.common" }, "python": { "module": "aws_cdk.aws_autoscaling_common" } } }, "aws-cdk-lib.aws_autoscaling_hooktargets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScaling.HookTargets" }, "java": { "package": "software.amazon.awscdk.services.autoscaling.hooktargets" }, "python": { "module": "aws_cdk.aws_autoscaling_hooktargets" } } }, "aws-cdk-lib.aws_autoscalingplans": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.AutoScalingPlans" }, "java": { "package": "software.amazon.awscdk.services.autoscalingplans" }, "python": { "module": "aws_cdk.aws_autoscalingplans" } } }, "aws-cdk-lib.aws_b2bi": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.B2BI" }, "java": { "package": "software.amazon.awscdk.services.b2bi" }, "python": { "module": "aws_cdk.aws_b2bi" } } }, "aws-cdk-lib.aws_backup": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Backup" }, "java": { "package": "software.amazon.awscdk.services.backup" }, "python": { "module": "aws_cdk.aws_backup" } } }, "aws-cdk-lib.aws_backupgateway": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.BackupGateway" }, "java": { "package": "software.amazon.awscdk.services.backupgateway" }, "python": { "module": "aws_cdk.aws_backupgateway" } } }, "aws-cdk-lib.aws_batch": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Batch" }, "java": { "package": "software.amazon.awscdk.services.batch" }, "python": { "module": "aws_cdk.aws_batch" } } }, "aws-cdk-lib.aws_bcmdataexports": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.BCMDataExports" }, "java": { "package": "software.amazon.awscdk.services.bcmdataexports" }, "python": { "module": "aws_cdk.aws_bcmdataexports" } } }, "aws-cdk-lib.aws_bedrock": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Bedrock" }, "java": { "package": "software.amazon.awscdk.services.bedrock" }, "python": { "module": "aws_cdk.aws_bedrock" } } }, "aws-cdk-lib.aws_billingconductor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.BillingConductor" }, "java": { "package": "software.amazon.awscdk.services.billingconductor" }, "python": { "module": "aws_cdk.aws_billingconductor" } } }, "aws-cdk-lib.aws_budgets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Budgets" }, "java": { "package": "software.amazon.awscdk.services.budgets" }, "python": { "module": "aws_cdk.aws_budgets" } } }, "aws-cdk-lib.aws_cassandra": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cassandra" }, "java": { "package": "software.amazon.awscdk.services.cassandra" }, "python": { "module": "aws_cdk.aws_cassandra" } } }, "aws-cdk-lib.aws_ce": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CE" }, "java": { "package": "software.amazon.awscdk.services.ce" }, "python": { "module": "aws_cdk.aws_ce" } } }, "aws-cdk-lib.aws_certificatemanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CertificateManager" }, "java": { "package": "software.amazon.awscdk.services.certificatemanager" }, "python": { "module": "aws_cdk.aws_certificatemanager" } } }, "aws-cdk-lib.aws_chatbot": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Chatbot" }, "java": { "package": "software.amazon.awscdk.services.chatbot" }, "python": { "module": "aws_cdk.aws_chatbot" } } }, "aws-cdk-lib.aws_cleanrooms": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.CleanRooms" }, "java": { "package": "software.amazon.awscdk.services.cleanrooms" }, "python": { "module": "aws_cdk.aws_cleanrooms" } } }, "aws-cdk-lib.aws_cleanroomsml": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.CleanRoomsML" }, "java": { "package": "software.amazon.awscdk.services.cleanroomsml" }, "python": { "module": "aws_cdk.aws_cleanroomsml" } } }, "aws-cdk-lib.aws_cloud9": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cloud9" }, "java": { "package": "software.amazon.awscdk.services.cloud9" }, "python": { "module": "aws_cdk.aws_cloud9" } } }, "aws-cdk-lib.aws_cloudformation": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudFormation" }, "java": { "package": "software.amazon.awscdk.services.cloudformation" }, "python": { "module": "aws_cdk.aws_cloudformation" } } }, "aws-cdk-lib.aws_cloudfront": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudFront" }, "java": { "package": "software.amazon.awscdk.services.cloudfront" }, "python": { "module": "aws_cdk.aws_cloudfront" } } }, "aws-cdk-lib.aws_cloudfront.experimental": {}, "aws-cdk-lib.aws_cloudfront_origins": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudFront.Origins" }, "java": { "package": "software.amazon.awscdk.services.cloudfront.origins" }, "python": { "module": "aws_cdk.aws_cloudfront_origins" } } }, "aws-cdk-lib.aws_cloudtrail": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudTrail" }, "java": { "package": "software.amazon.awscdk.services.cloudtrail" }, "python": { "module": "aws_cdk.aws_cloudtrail" } } }, "aws-cdk-lib.aws_cloudwatch": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudWatch" }, "java": { "package": "software.amazon.awscdk.services.cloudwatch" }, "python": { "module": "aws_cdk.aws_cloudwatch" } } }, "aws-cdk-lib.aws_cloudwatch_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CloudWatch.Actions" }, "java": { "package": "software.amazon.awscdk.services.cloudwatch.actions" }, "python": { "module": "aws_cdk.aws_cloudwatch_actions" } } }, "aws-cdk-lib.aws_codeartifact": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeArtifact" }, "java": { "package": "software.amazon.awscdk.services.codeartifact" }, "python": { "module": "aws_cdk.aws_codeartifact" } } }, "aws-cdk-lib.aws_codebuild": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeBuild" }, "java": { "package": "software.amazon.awscdk.services.codebuild" }, "python": { "module": "aws_cdk.aws_codebuild" } } }, "aws-cdk-lib.aws_codecommit": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeCommit" }, "java": { "package": "software.amazon.awscdk.services.codecommit" }, "python": { "module": "aws_cdk.aws_codecommit" } } }, "aws-cdk-lib.aws_codeconnections": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.CodeConnections" }, "java": { "package": "software.amazon.awscdk.services.codeconnections" }, "python": { "module": "aws_cdk.aws_codeconnections" } } }, "aws-cdk-lib.aws_codedeploy": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeDeploy" }, "java": { "package": "software.amazon.awscdk.services.codedeploy" }, "python": { "module": "aws_cdk.aws_codedeploy" } } }, "aws-cdk-lib.aws_codeguruprofiler": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeGuruProfiler" }, "java": { "package": "software.amazon.awscdk.services.codeguruprofiler" }, "python": { "module": "aws_cdk.aws_codeguruprofiler" } } }, "aws-cdk-lib.aws_codegurureviewer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeGuruReviewer" }, "java": { "package": "software.amazon.awscdk.services.codegurureviewer" }, "python": { "module": "aws_cdk.aws_codegurureviewer" } } }, "aws-cdk-lib.aws_codepipeline": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodePipeline" }, "java": { "package": "software.amazon.awscdk.services.codepipeline" }, "python": { "module": "aws_cdk.aws_codepipeline" } } }, "aws-cdk-lib.aws_codepipeline_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodePipeline.Actions" }, "java": { "package": "software.amazon.awscdk.services.codepipeline.actions" }, "python": { "module": "aws_cdk.aws_codepipeline_actions" } } }, "aws-cdk-lib.aws_codestar": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Codestar" }, "java": { "package": "software.amazon.awscdk.services.codestar" }, "python": { "module": "aws_cdk.aws_codestar" } } }, "aws-cdk-lib.aws_codestarconnections": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeStarConnections" }, "java": { "package": "software.amazon.awscdk.services.codestarconnections" }, "python": { "module": "aws_cdk.aws_codestarconnections" } } }, "aws-cdk-lib.aws_codestarnotifications": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CodeStarNotifications" }, "java": { "package": "software.amazon.awscdk.services.codestarnotifications" }, "python": { "module": "aws_cdk.aws_codestarnotifications" } } }, "aws-cdk-lib.aws_cognito": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Cognito" }, "java": { "package": "software.amazon.awscdk.services.cognito" }, "python": { "module": "aws_cdk.aws_cognito" } } }, "aws-cdk-lib.aws_comprehend": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Comprehend" }, "java": { "package": "software.amazon.awscdk.services.comprehend" }, "python": { "module": "aws_cdk.aws_comprehend" } } }, "aws-cdk-lib.aws_config": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Config" }, "java": { "package": "software.amazon.awscdk.services.config" }, "python": { "module": "aws_cdk.aws_config" } } }, "aws-cdk-lib.aws_connect": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Connect" }, "java": { "package": "software.amazon.awscdk.services.connect" }, "python": { "module": "aws_cdk.aws_connect" } } }, "aws-cdk-lib.aws_connectcampaigns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ConnectCampaigns" }, "java": { "package": "software.amazon.awscdk.services.connectcampaigns" }, "python": { "module": "aws_cdk.aws_connectcampaigns" } } }, "aws-cdk-lib.aws_connectcampaignsv2": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.ConnectCampaignsV2" }, "java": { "package": "software.amazon.awscdk.services.connectcampaignsv2" }, "python": { "module": "aws_cdk.aws_connectcampaignsv2" } } }, "aws-cdk-lib.aws_controltower": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ControlTower" }, "java": { "package": "software.amazon.awscdk.services.controltower" }, "python": { "module": "aws_cdk.aws_controltower" } } }, "aws-cdk-lib.aws_cur": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CUR" }, "java": { "package": "software.amazon.awscdk.services.cur" }, "python": { "module": "aws_cdk.aws_cur" } } }, "aws-cdk-lib.aws_customerprofiles": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.CustomerProfiles" }, "java": { "package": "software.amazon.awscdk.services.customerprofiles" }, "python": { "module": "aws_cdk.aws_customerprofiles" } } }, "aws-cdk-lib.aws_databrew": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DataBrew" }, "java": { "package": "software.amazon.awscdk.services.databrew" }, "python": { "module": "aws_cdk.aws_databrew" } } }, "aws-cdk-lib.aws_datapipeline": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DataPipeline" }, "java": { "package": "software.amazon.awscdk.services.datapipeline" }, "python": { "module": "aws_cdk.aws_datapipeline" } } }, "aws-cdk-lib.aws_datasync": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DataSync" }, "java": { "package": "software.amazon.awscdk.services.datasync" }, "python": { "module": "aws_cdk.aws_datasync" } } }, "aws-cdk-lib.aws_datazone": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.DataZone" }, "java": { "package": "software.amazon.awscdk.services.datazone" }, "python": { "module": "aws_cdk.aws_datazone" } } }, "aws-cdk-lib.aws_dax": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DAX" }, "java": { "package": "software.amazon.awscdk.services.dax" }, "python": { "module": "aws_cdk.aws_dax" } } }, "aws-cdk-lib.aws_deadline": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Deadline" }, "java": { "package": "software.amazon.awscdk.services.deadline" }, "python": { "module": "aws_cdk.aws_deadline" } } }, "aws-cdk-lib.aws_detective": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Detective" }, "java": { "package": "software.amazon.awscdk.services.detective" }, "python": { "module": "aws_cdk.aws_detective" } } }, "aws-cdk-lib.aws_devicefarm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DeviceFarm" }, "java": { "package": "software.amazon.awscdk.services.devicefarm" }, "python": { "module": "aws_cdk.aws_devicefarm" } } }, "aws-cdk-lib.aws_devopsguru": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DevOpsGuru" }, "java": { "package": "software.amazon.awscdk.services.devopsguru" }, "python": { "module": "aws_cdk.aws_devopsguru" } } }, "aws-cdk-lib.aws_directoryservice": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DirectoryService" }, "java": { "package": "software.amazon.awscdk.services.directoryservice" }, "python": { "module": "aws_cdk.aws_directoryservice" } } }, "aws-cdk-lib.aws_dlm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DLM" }, "java": { "package": "software.amazon.awscdk.services.dlm" }, "python": { "module": "aws_cdk.aws_dlm" } } }, "aws-cdk-lib.aws_dms": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DMS" }, "java": { "package": "software.amazon.awscdk.services.dms" }, "python": { "module": "aws_cdk.aws_dms" } } }, "aws-cdk-lib.aws_docdb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DocDB" }, "java": { "package": "software.amazon.awscdk.services.docdb" }, "python": { "module": "aws_cdk.aws_docdb" } } }, "aws-cdk-lib.aws_docdbelastic": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DocDBElastic" }, "java": { "package": "software.amazon.awscdk.services.docdbelastic" }, "python": { "module": "aws_cdk.aws_docdbelastic" } } }, "aws-cdk-lib.aws_dynamodb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.DynamoDB" }, "java": { "package": "software.amazon.awscdk.services.dynamodb" }, "python": { "module": "aws_cdk.aws_dynamodb" } } }, "aws-cdk-lib.aws_ec2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EC2" }, "java": { "package": "software.amazon.awscdk.services.ec2" }, "python": { "module": "aws_cdk.aws_ec2" } } }, "aws-cdk-lib.aws_ecr": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ECR" }, "java": { "package": "software.amazon.awscdk.services.ecr" }, "python": { "module": "aws_cdk.aws_ecr" } } }, "aws-cdk-lib.aws_ecr_assets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Ecr.Assets" }, "java": { "package": "software.amazon.awscdk.services.ecr.assets" }, "python": { "module": "aws_cdk.aws_ecr_assets" } } }, "aws-cdk-lib.aws_ecs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ECS" }, "java": { "package": "software.amazon.awscdk.services.ecs" }, "python": { "module": "aws_cdk.aws_ecs" } } }, "aws-cdk-lib.aws_ecs_patterns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ECS.Patterns" }, "java": { "package": "software.amazon.awscdk.services.ecs.patterns" }, "python": { "module": "aws_cdk.aws_ecs_patterns" } } }, "aws-cdk-lib.aws_efs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EFS" }, "java": { "package": "software.amazon.awscdk.services.efs" }, "python": { "module": "aws_cdk.aws_efs" } } }, "aws-cdk-lib.aws_eks": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EKS" }, "java": { "package": "software.amazon.awscdk.services.eks" }, "python": { "module": "aws_cdk.aws_eks" } } }, "aws-cdk-lib.aws_elasticache": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElastiCache" }, "java": { "package": "software.amazon.awscdk.services.elasticache" }, "python": { "module": "aws_cdk.aws_elasticache" } } }, "aws-cdk-lib.aws_elasticbeanstalk": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticBeanstalk" }, "java": { "package": "software.amazon.awscdk.services.elasticbeanstalk" }, "python": { "module": "aws_cdk.aws_elasticbeanstalk" } } }, "aws-cdk-lib.aws_elasticloadbalancing": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancing" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancing" }, "python": { "module": "aws_cdk.aws_elasticloadbalancing" } } }, "aws-cdk-lib.aws_elasticloadbalancingv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancingv2" }, "python": { "module": "aws_cdk.aws_elasticloadbalancingv2" } } }, "aws-cdk-lib.aws_elasticloadbalancingv2_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2.Actions" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancingv2.actions" }, "python": { "module": "aws_cdk.aws_elasticloadbalancingv2_actions" } } }, "aws-cdk-lib.aws_elasticloadbalancingv2_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ElasticLoadBalancingV2.Targets" }, "java": { "package": "software.amazon.awscdk.services.elasticloadbalancingv2.targets" }, "python": { "module": "aws_cdk.aws_elasticloadbalancingv2_targets" } } }, "aws-cdk-lib.aws_elasticsearch": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Elasticsearch" }, "java": { "package": "software.amazon.awscdk.services.elasticsearch" }, "python": { "module": "aws_cdk.aws_elasticsearch" } } }, "aws-cdk-lib.aws_emr": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EMR" }, "java": { "package": "software.amazon.awscdk.services.emr" }, "python": { "module": "aws_cdk.aws_emr" } } }, "aws-cdk-lib.aws_emrcontainers": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EMRContainers" }, "java": { "package": "software.amazon.awscdk.services.emrcontainers" }, "python": { "module": "aws_cdk.aws_emrcontainers" } } }, "aws-cdk-lib.aws_emrserverless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EMRServerless" }, "java": { "package": "software.amazon.awscdk.services.emrserverless" }, "python": { "module": "aws_cdk.aws_emrserverless" } } }, "aws-cdk-lib.aws_entityresolution": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.EntityResolution" }, "java": { "package": "software.amazon.awscdk.services.entityresolution" }, "python": { "module": "aws_cdk.aws_entityresolution" } } }, "aws-cdk-lib.aws_events": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Events" }, "java": { "package": "software.amazon.awscdk.services.events" }, "python": { "module": "aws_cdk.aws_events" } } }, "aws-cdk-lib.aws_events_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Events.Targets" }, "java": { "package": "software.amazon.awscdk.services.events.targets" }, "python": { "module": "aws_cdk.aws_events_targets" } } }, "aws-cdk-lib.aws_eventschemas": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.EventSchemas" }, "java": { "package": "software.amazon.awscdk.services.eventschemas" }, "python": { "module": "aws_cdk.aws_eventschemas" } } }, "aws-cdk-lib.aws_evidently": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Evidently" }, "java": { "package": "software.amazon.awscdk.services.evidently" }, "python": { "module": "aws_cdk.aws_evidently" } } }, "aws-cdk-lib.aws_finspace": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FinSpace" }, "java": { "package": "software.amazon.awscdk.services.finspace" }, "python": { "module": "aws_cdk.aws_finspace" } } }, "aws-cdk-lib.aws_fis": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FIS" }, "java": { "package": "software.amazon.awscdk.services.fis" }, "python": { "module": "aws_cdk.aws_fis" } } }, "aws-cdk-lib.aws_fms": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FMS" }, "java": { "package": "software.amazon.awscdk.services.fms" }, "python": { "module": "aws_cdk.aws_fms" } } }, "aws-cdk-lib.aws_forecast": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Forecast" }, "java": { "package": "software.amazon.awscdk.services.forecast" }, "python": { "module": "aws_cdk.aws_forecast" } } }, "aws-cdk-lib.aws_frauddetector": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FraudDetector" }, "java": { "package": "software.amazon.awscdk.services.frauddetector" }, "python": { "module": "aws_cdk.aws_frauddetector" } } }, "aws-cdk-lib.aws_fsx": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.FSx" }, "java": { "package": "software.amazon.awscdk.services.fsx" }, "python": { "module": "aws_cdk.aws_fsx" } } }, "aws-cdk-lib.aws_gamelift": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GameLift" }, "java": { "package": "software.amazon.awscdk.services.gamelift" }, "python": { "module": "aws_cdk.aws_gamelift" } } }, "aws-cdk-lib.aws_globalaccelerator": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GlobalAccelerator" }, "java": { "package": "software.amazon.awscdk.services.globalaccelerator" }, "python": { "module": "aws_cdk.aws_globalaccelerator" } } }, "aws-cdk-lib.aws_globalaccelerator_endpoints": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GlobalAccelerator.Endpoints" }, "java": { "package": "software.amazon.awscdk.services.globalaccelerator.endpoints" }, "python": { "module": "aws_cdk.aws_globalaccelerator_endpoints" } } }, "aws-cdk-lib.aws_glue": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Glue" }, "java": { "package": "software.amazon.awscdk.services.glue" }, "python": { "module": "aws_cdk.aws_glue" } } }, "aws-cdk-lib.aws_grafana": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Grafana" }, "java": { "package": "software.amazon.awscdk.services.grafana" }, "python": { "module": "aws_cdk.aws_grafana" } } }, "aws-cdk-lib.aws_greengrass": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Greengrass" }, "java": { "package": "software.amazon.awscdk.services.greengrass" }, "python": { "module": "aws_cdk.aws_greengrass" } } }, "aws-cdk-lib.aws_greengrassv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GreengrassV2" }, "java": { "package": "software.amazon.awscdk.services.greengrassv2" }, "python": { "module": "aws_cdk.aws_greengrassv2" } } }, "aws-cdk-lib.aws_groundstation": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GroundStation" }, "java": { "package": "software.amazon.awscdk.services.groundstation" }, "python": { "module": "aws_cdk.aws_groundstation" } } }, "aws-cdk-lib.aws_guardduty": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.GuardDuty" }, "java": { "package": "software.amazon.awscdk.services.guardduty" }, "python": { "module": "aws_cdk.aws_guardduty" } } }, "aws-cdk-lib.aws_healthimaging": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.HealthImaging" }, "java": { "package": "software.amazon.awscdk.services.healthimaging" }, "python": { "module": "aws_cdk.aws_healthimaging" } } }, "aws-cdk-lib.aws_healthlake": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.HealthLake" }, "java": { "package": "software.amazon.awscdk.services.healthlake" }, "python": { "module": "aws_cdk.aws_healthlake" } } }, "aws-cdk-lib.aws_iam": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IAM" }, "java": { "package": "software.amazon.awscdk.services.iam" }, "python": { "module": "aws_cdk.aws_iam" } } }, "aws-cdk-lib.aws_identitystore": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IdentityStore" }, "java": { "package": "software.amazon.awscdk.services.identitystore" }, "python": { "module": "aws_cdk.aws_identitystore" } } }, "aws-cdk-lib.aws_imagebuilder": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ImageBuilder" }, "java": { "package": "software.amazon.awscdk.services.imagebuilder" }, "python": { "module": "aws_cdk.aws_imagebuilder" } } }, "aws-cdk-lib.aws_inspector": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Inspector" }, "java": { "package": "software.amazon.awscdk.services.inspector" }, "python": { "module": "aws_cdk.aws_inspector" } } }, "aws-cdk-lib.aws_inspectorv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.InspectorV2" }, "java": { "package": "software.amazon.awscdk.services.inspectorv2" }, "python": { "module": "aws_cdk.aws_inspectorv2" } } }, "aws-cdk-lib.aws_internetmonitor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.InternetMonitor" }, "java": { "package": "software.amazon.awscdk.services.internetmonitor" }, "python": { "module": "aws_cdk.aws_internetmonitor" } } }, "aws-cdk-lib.aws_iot": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoT" }, "java": { "package": "software.amazon.awscdk.services.iot" }, "python": { "module": "aws_cdk.aws_iot" } } }, "aws-cdk-lib.aws_iot1click": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoT1Click" }, "java": { "package": "software.amazon.awscdk.services.iot1click" }, "python": { "module": "aws_cdk.aws_iot1click" } } }, "aws-cdk-lib.aws_iotanalytics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTAnalytics" }, "java": { "package": "software.amazon.awscdk.services.iotanalytics" }, "python": { "module": "aws_cdk.aws_iotanalytics" } } }, "aws-cdk-lib.aws_iotcoredeviceadvisor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTCoreDeviceAdvisor" }, "java": { "package": "software.amazon.awscdk.services.iotcoredeviceadvisor" }, "python": { "module": "aws_cdk.aws_iotcoredeviceadvisor" } } }, "aws-cdk-lib.aws_iotevents": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTEvents" }, "java": { "package": "software.amazon.awscdk.services.iotevents" }, "python": { "module": "aws_cdk.aws_iotevents" } } }, "aws-cdk-lib.aws_iotfleethub": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTFleetHub" }, "java": { "package": "software.amazon.awscdk.services.iotfleethub" }, "python": { "module": "aws_cdk.aws_iotfleethub" } } }, "aws-cdk-lib.aws_iotfleetwise": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTFleetWise" }, "java": { "package": "software.amazon.awscdk.services.iotfleetwise" }, "python": { "module": "aws_cdk.aws_iotfleetwise" } } }, "aws-cdk-lib.aws_iotsitewise": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTSiteWise" }, "java": { "package": "software.amazon.awscdk.services.iotsitewise" }, "python": { "module": "aws_cdk.aws_iotsitewise" } } }, "aws-cdk-lib.aws_iotthingsgraph": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTThingsGraph" }, "java": { "package": "software.amazon.awscdk.services.iotthingsgraph" }, "python": { "module": "aws_cdk.aws_iotthingsgraph" } } }, "aws-cdk-lib.aws_iottwinmaker": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTTwinMaker" }, "java": { "package": "software.amazon.awscdk.services.iottwinmaker" }, "python": { "module": "aws_cdk.aws_iottwinmaker" } } }, "aws-cdk-lib.aws_iotwireless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IoTWireless" }, "java": { "package": "software.amazon.awscdk.services.iotwireless" }, "python": { "module": "aws_cdk.aws_iotwireless" } } }, "aws-cdk-lib.aws_ivs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Ivs" }, "java": { "package": "software.amazon.awscdk.services.ivs" }, "python": { "module": "aws_cdk.aws_ivs" } } }, "aws-cdk-lib.aws_ivschat": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.IVSChat" }, "java": { "package": "software.amazon.awscdk.services.ivschat" }, "python": { "module": "aws_cdk.aws_ivschat" } } }, "aws-cdk-lib.aws_kafkaconnect": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KafkaConnect" }, "java": { "package": "software.amazon.awscdk.services.kafkaconnect" }, "python": { "module": "aws_cdk.aws_kafkaconnect" } } }, "aws-cdk-lib.aws_kendra": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Kendra" }, "java": { "package": "software.amazon.awscdk.services.kendra" }, "python": { "module": "aws_cdk.aws_kendra" } } }, "aws-cdk-lib.aws_kendraranking": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KendraRanking" }, "java": { "package": "software.amazon.awscdk.services.kendraranking" }, "python": { "module": "aws_cdk.aws_kendraranking" } } }, "aws-cdk-lib.aws_kinesis": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Kinesis" }, "java": { "package": "software.amazon.awscdk.services.kinesis" }, "python": { "module": "aws_cdk.aws_kinesis" } } }, "aws-cdk-lib.aws_kinesisanalytics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisAnalytics" }, "java": { "package": "software.amazon.awscdk.services.kinesisanalytics" }, "python": { "module": "aws_cdk.aws_kinesisanalytics" } } }, "aws-cdk-lib.aws_kinesisanalyticsv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisAnalyticsV2" }, "java": { "package": "software.amazon.awscdk.services.kinesisanalyticsv2" }, "python": { "module": "aws_cdk.aws_kinesisanalyticsv2" } } }, "aws-cdk-lib.aws_kinesisfirehose": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisFirehose" }, "java": { "package": "software.amazon.awscdk.services.kinesisfirehose" }, "python": { "module": "aws_cdk.aws_kinesisfirehose" } } }, "aws-cdk-lib.aws_kinesisvideo": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KinesisVideo" }, "java": { "package": "software.amazon.awscdk.services.kinesisvideo" }, "python": { "module": "aws_cdk.aws_kinesisvideo" } } }, "aws-cdk-lib.aws_kms": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.KMS" }, "java": { "package": "software.amazon.awscdk.services.kms" }, "python": { "module": "aws_cdk.aws_kms" } } }, "aws-cdk-lib.aws_lakeformation": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LakeFormation" }, "java": { "package": "software.amazon.awscdk.services.lakeformation" }, "python": { "module": "aws_cdk.aws_lakeformation" } } }, "aws-cdk-lib.aws_lambda": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda" }, "java": { "package": "software.amazon.awscdk.services.lambda" }, "python": { "module": "aws_cdk.aws_lambda" } } }, "aws-cdk-lib.aws_lambda_destinations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda.Destinations" }, "java": { "package": "software.amazon.awscdk.services.lambda.destinations" }, "python": { "module": "aws_cdk.aws_lambda_destinations" } } }, "aws-cdk-lib.aws_lambda_event_sources": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda.EventSources" }, "java": { "package": "software.amazon.awscdk.services.lambda.eventsources" }, "python": { "module": "aws_cdk.aws_lambda_event_sources" } } }, "aws-cdk-lib.aws_lambda_nodejs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lambda.Nodejs" }, "java": { "package": "software.amazon.awscdk.services.lambda.nodejs" }, "python": { "module": "aws_cdk.aws_lambda_nodejs" } } }, "aws-cdk-lib.aws_launchwizard": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.LaunchWizard" }, "java": { "package": "software.amazon.awscdk.services.launchwizard" }, "python": { "module": "aws_cdk.aws_launchwizard" } } }, "aws-cdk-lib.aws_lex": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lex" }, "java": { "package": "software.amazon.awscdk.services.lex" }, "python": { "module": "aws_cdk.aws_lex" } } }, "aws-cdk-lib.aws_licensemanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LicenseManager" }, "java": { "package": "software.amazon.awscdk.services.licensemanager" }, "python": { "module": "aws_cdk.aws_licensemanager" } } }, "aws-cdk-lib.aws_lightsail": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Lightsail" }, "java": { "package": "software.amazon.awscdk.services.lightsail" }, "python": { "module": "aws_cdk.aws_lightsail" } } }, "aws-cdk-lib.aws_location": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Location" }, "java": { "package": "software.amazon.awscdk.services.location" }, "python": { "module": "aws_cdk.aws_location" } } }, "aws-cdk-lib.aws_logs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Logs" }, "java": { "package": "software.amazon.awscdk.services.logs" }, "python": { "module": "aws_cdk.aws_logs" } } }, "aws-cdk-lib.aws_logs_destinations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Logs.Destinations" }, "java": { "package": "software.amazon.awscdk.services.logs.destinations" }, "python": { "module": "aws_cdk.aws_logs_destinations" } } }, "aws-cdk-lib.aws_lookoutequipment": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LookoutEquipment" }, "java": { "package": "software.amazon.awscdk.services.lookoutequipment" }, "python": { "module": "aws_cdk.aws_lookoutequipment" } } }, "aws-cdk-lib.aws_lookoutmetrics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LookoutMetrics" }, "java": { "package": "software.amazon.awscdk.services.lookoutmetrics" }, "python": { "module": "aws_cdk.aws_lookoutmetrics" } } }, "aws-cdk-lib.aws_lookoutvision": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.LookoutVision" }, "java": { "package": "software.amazon.awscdk.services.lookoutvision" }, "python": { "module": "aws_cdk.aws_lookoutvision" } } }, "aws-cdk-lib.aws_m2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.M2" }, "java": { "package": "software.amazon.awscdk.services.m2" }, "python": { "module": "aws_cdk.aws_m2" } } }, "aws-cdk-lib.aws_macie": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Macie" }, "java": { "package": "software.amazon.awscdk.services.macie" }, "python": { "module": "aws_cdk.aws_macie" } } }, "aws-cdk-lib.aws_managedblockchain": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ManagedBlockchain" }, "java": { "package": "software.amazon.awscdk.services.managedblockchain" }, "python": { "module": "aws_cdk.aws_managedblockchain" } } }, "aws-cdk-lib.aws_mediaconnect": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaConnect" }, "java": { "package": "software.amazon.awscdk.services.mediaconnect" }, "python": { "module": "aws_cdk.aws_mediaconnect" } } }, "aws-cdk-lib.aws_mediaconvert": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaConvert" }, "java": { "package": "software.amazon.awscdk.services.mediaconvert" }, "python": { "module": "aws_cdk.aws_mediaconvert" } } }, "aws-cdk-lib.aws_medialive": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaLive" }, "java": { "package": "software.amazon.awscdk.services.medialive" }, "python": { "module": "aws_cdk.aws_medialive" } } }, "aws-cdk-lib.aws_mediapackage": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaPackage" }, "java": { "package": "software.amazon.awscdk.services.mediapackage" }, "python": { "module": "aws_cdk.aws_mediapackage" } } }, "aws-cdk-lib.aws_mediapackagev2": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.MediaPackageV2" }, "java": { "package": "software.amazon.awscdk.services.mediapackagev2" }, "python": { "module": "aws_cdk.aws_mediapackagev2" } } }, "aws-cdk-lib.aws_mediastore": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaStore" }, "java": { "package": "software.amazon.awscdk.services.mediastore" }, "python": { "module": "aws_cdk.aws_mediastore" } } }, "aws-cdk-lib.aws_mediatailor": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MediaTailor" }, "java": { "package": "software.amazon.awscdk.services.mediatailor" }, "python": { "module": "aws_cdk.aws_mediatailor" } } }, "aws-cdk-lib.aws_memorydb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MemoryDB" }, "java": { "package": "software.amazon.awscdk.services.memorydb" }, "python": { "module": "aws_cdk.aws_memorydb" } } }, "aws-cdk-lib.aws_msk": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MSK" }, "java": { "package": "software.amazon.awscdk.services.msk" }, "python": { "module": "aws_cdk.aws_msk" } } }, "aws-cdk-lib.aws_mwaa": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.MWAA" }, "java": { "package": "software.amazon.awscdk.services.mwaa" }, "python": { "module": "aws_cdk.aws_mwaa" } } }, "aws-cdk-lib.aws_neptune": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Neptune" }, "java": { "package": "software.amazon.awscdk.services.neptune" }, "python": { "module": "aws_cdk.aws_neptune" } } }, "aws-cdk-lib.aws_neptunegraph": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.NeptuneGraph" }, "java": { "package": "software.amazon.awscdk.services.neptunegraph" }, "python": { "module": "aws_cdk.aws_neptunegraph" } } }, "aws-cdk-lib.aws_networkfirewall": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.NetworkFirewall" }, "java": { "package": "software.amazon.awscdk.services.networkfirewall" }, "python": { "module": "aws_cdk.aws_networkfirewall" } } }, "aws-cdk-lib.aws_networkmanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.NetworkManager" }, "java": { "package": "software.amazon.awscdk.services.networkmanager" }, "python": { "module": "aws_cdk.aws_networkmanager" } } }, "aws-cdk-lib.aws_nimblestudio": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.NimbleStudio" }, "java": { "package": "software.amazon.awscdk.services.nimblestudio" }, "python": { "module": "aws_cdk.aws_nimblestudio" } } }, "aws-cdk-lib.aws_oam": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Oam" }, "java": { "package": "software.amazon.awscdk.services.oam" }, "python": { "module": "aws_cdk.aws_oam" } } }, "aws-cdk-lib.aws_omics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Omics" }, "java": { "package": "software.amazon.awscdk.services.omics" }, "python": { "module": "aws_cdk.aws_omics" } } }, "aws-cdk-lib.aws_opensearchserverless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpenSearchServerless" }, "java": { "package": "software.amazon.awscdk.services.opensearchserverless" }, "python": { "module": "aws_cdk.aws_opensearchserverless" } } }, "aws-cdk-lib.aws_opensearchservice": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpenSearchService" }, "java": { "package": "software.amazon.awscdk.services.opensearchservice" }, "python": { "module": "aws_cdk.aws_opensearchservice" } } }, "aws-cdk-lib.aws_opsworks": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpsWorks" }, "java": { "package": "software.amazon.awscdk.services.opsworks" }, "python": { "module": "aws_cdk.aws_opsworks" } } }, "aws-cdk-lib.aws_opsworkscm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.OpsWorksCM" }, "java": { "package": "software.amazon.awscdk.services.opsworkscm" }, "python": { "module": "aws_cdk.aws_opsworkscm" } } }, "aws-cdk-lib.aws_organizations": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Organizations" }, "java": { "package": "software.amazon.awscdk.services.organizations" }, "python": { "module": "aws_cdk.aws_organizations" } } }, "aws-cdk-lib.aws_osis": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.OSIS" }, "java": { "package": "software.amazon.awscdk.services.osis" }, "python": { "module": "aws_cdk.aws_osis" } } }, "aws-cdk-lib.aws_panorama": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Panorama" }, "java": { "package": "software.amazon.awscdk.services.panorama" }, "python": { "module": "aws_cdk.aws_panorama" } } }, "aws-cdk-lib.aws_paymentcryptography": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.PaymentCryptography" }, "java": { "package": "software.amazon.awscdk.services.paymentcryptography" }, "python": { "module": "aws_cdk.aws_paymentcryptography" } } }, "aws-cdk-lib.aws_pcaconnectorad": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.PCAConnectorAD" }, "java": { "package": "software.amazon.awscdk.services.pcaconnectorad" }, "python": { "module": "aws_cdk.aws_pcaconnectorad" } } }, "aws-cdk-lib.aws_pcaconnectorscep": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.PCAConnectorSCEP" }, "java": { "package": "software.amazon.awscdk.services.pcaconnectorscep" }, "python": { "module": "aws_cdk.aws_pcaconnectorscep" } } }, "aws-cdk-lib.aws_personalize": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Personalize" }, "java": { "package": "software.amazon.awscdk.services.personalize" }, "python": { "module": "aws_cdk.aws_personalize" } } }, "aws-cdk-lib.aws_pinpoint": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Pinpoint" }, "java": { "package": "software.amazon.awscdk.services.pinpoint" }, "python": { "module": "aws_cdk.aws_pinpoint" } } }, "aws-cdk-lib.aws_pinpointemail": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.PinpointEmail" }, "java": { "package": "software.amazon.awscdk.services.pinpointemail" }, "python": { "module": "aws_cdk.aws_pinpointemail" } } }, "aws-cdk-lib.aws_pipes": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Pipes" }, "java": { "package": "software.amazon.awscdk.services.pipes" }, "python": { "module": "aws_cdk.aws_pipes" } } }, "aws-cdk-lib.aws_proton": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Proton" }, "java": { "package": "software.amazon.awscdk.services.proton" }, "python": { "module": "aws_cdk.aws_proton" } } }, "aws-cdk-lib.aws_qbusiness": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.QBusiness" }, "java": { "package": "software.amazon.awscdk.services.qbusiness" }, "python": { "module": "aws_cdk.aws_qbusiness" } } }, "aws-cdk-lib.aws_qldb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.QLDB" }, "java": { "package": "software.amazon.awscdk.services.qldb" }, "python": { "module": "aws_cdk.aws_qldb" } } }, "aws-cdk-lib.aws_quicksight": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.QuickSight" }, "java": { "package": "software.amazon.awscdk.services.quicksight" }, "python": { "module": "aws_cdk.aws_quicksight" } } }, "aws-cdk-lib.aws_ram": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RAM" }, "java": { "package": "software.amazon.awscdk.services.ram" }, "python": { "module": "aws_cdk.aws_ram" } } }, "aws-cdk-lib.aws_rds": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RDS" }, "java": { "package": "software.amazon.awscdk.services.rds" }, "python": { "module": "aws_cdk.aws_rds" } } }, "aws-cdk-lib.aws_redshift": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Redshift" }, "java": { "package": "software.amazon.awscdk.services.redshift" }, "python": { "module": "aws_cdk.aws_redshift" } } }, "aws-cdk-lib.aws_redshiftserverless": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RedshiftServerless" }, "java": { "package": "software.amazon.awscdk.services.redshiftserverless" }, "python": { "module": "aws_cdk.aws_redshiftserverless" } } }, "aws-cdk-lib.aws_refactorspaces": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RefactorSpaces" }, "java": { "package": "software.amazon.awscdk.services.refactorspaces" }, "python": { "module": "aws_cdk.aws_refactorspaces" } } }, "aws-cdk-lib.aws_rekognition": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Rekognition" }, "java": { "package": "software.amazon.awscdk.services.rekognition" }, "python": { "module": "aws_cdk.aws_rekognition" } } }, "aws-cdk-lib.aws_resiliencehub": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ResilienceHub" }, "java": { "package": "software.amazon.awscdk.services.resiliencehub" }, "python": { "module": "aws_cdk.aws_resiliencehub" } } }, "aws-cdk-lib.aws_resourceexplorer2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ResourceExplorer2" }, "java": { "package": "software.amazon.awscdk.services.resourceexplorer2" }, "python": { "module": "aws_cdk.aws_resourceexplorer2" } } }, "aws-cdk-lib.aws_resourcegroups": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ResourceGroups" }, "java": { "package": "software.amazon.awscdk.services.resourcegroups" }, "python": { "module": "aws_cdk.aws_resourcegroups" } } }, "aws-cdk-lib.aws_robomaker": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RoboMaker" }, "java": { "package": "software.amazon.awscdk.services.robomaker" }, "python": { "module": "aws_cdk.aws_robomaker" } } }, "aws-cdk-lib.aws_rolesanywhere": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RolesAnywhere" }, "java": { "package": "software.amazon.awscdk.services.rolesanywhere" }, "python": { "module": "aws_cdk.aws_rolesanywhere" } } }, "aws-cdk-lib.aws_route53": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53" }, "java": { "package": "software.amazon.awscdk.services.route53" }, "python": { "module": "aws_cdk.aws_route53" } } }, "aws-cdk-lib.aws_route53_patterns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53.Patterns" }, "java": { "package": "software.amazon.awscdk.services.route53.patterns" }, "python": { "module": "aws_cdk.aws_route53_patterns" } } }, "aws-cdk-lib.aws_route53_targets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53.Targets" }, "java": { "package": "software.amazon.awscdk.services.route53.targets" }, "python": { "module": "aws_cdk.aws_route53_targets" } } }, "aws-cdk-lib.aws_route53profiles": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Route53Profiles" }, "java": { "package": "software.amazon.awscdk.services.route53profiles" }, "python": { "module": "aws_cdk.aws_route53profiles" } } }, "aws-cdk-lib.aws_route53recoverycontrol": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53RecoveryControl" }, "java": { "package": "software.amazon.awscdk.services.route53recoverycontrol" }, "python": { "module": "aws_cdk.aws_route53recoverycontrol" } } }, "aws-cdk-lib.aws_route53recoveryreadiness": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53RecoveryReadiness" }, "java": { "package": "software.amazon.awscdk.services.route53recoveryreadiness" }, "python": { "module": "aws_cdk.aws_route53recoveryreadiness" } } }, "aws-cdk-lib.aws_route53resolver": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Route53Resolver" }, "java": { "package": "software.amazon.awscdk.services.route53resolver" }, "python": { "module": "aws_cdk.aws_route53resolver" } } }, "aws-cdk-lib.aws_rum": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.RUM" }, "java": { "package": "software.amazon.awscdk.services.rum" }, "python": { "module": "aws_cdk.aws_rum" } } }, "aws-cdk-lib.aws_s3": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3" }, "java": { "package": "software.amazon.awscdk.services.s3" }, "python": { "module": "aws_cdk.aws_s3" } } }, "aws-cdk-lib.aws_s3_assets": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3.Assets" }, "java": { "package": "software.amazon.awscdk.services.s3.assets" }, "python": { "module": "aws_cdk.aws_s3_assets" } } }, "aws-cdk-lib.aws_s3_deployment": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3.Deployment" }, "java": { "package": "software.amazon.awscdk.services.s3.deployment" }, "python": { "module": "aws_cdk.aws_s3_deployment" } } }, "aws-cdk-lib.aws_s3_notifications": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3.Notifications" }, "java": { "package": "software.amazon.awscdk.services.s3.notifications" }, "python": { "module": "aws_cdk.aws_s3_notifications" } } }, "aws-cdk-lib.aws_s3express": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.S3Express" }, "java": { "package": "software.amazon.awscdk.services.s3express" }, "python": { "module": "aws_cdk.aws_s3express" } } }, "aws-cdk-lib.aws_s3objectlambda": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3ObjectLambda" }, "java": { "package": "software.amazon.awscdk.services.s3objectlambda" }, "python": { "module": "aws_cdk.aws_s3objectlambda" } } }, "aws-cdk-lib.aws_s3outposts": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.S3Outposts" }, "java": { "package": "software.amazon.awscdk.services.s3outposts" }, "python": { "module": "aws_cdk.aws_s3outposts" } } }, "aws-cdk-lib.aws_sagemaker": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Sagemaker" }, "java": { "package": "software.amazon.awscdk.services.sagemaker" }, "python": { "module": "aws_cdk.aws_sagemaker" } } }, "aws-cdk-lib.aws_sam": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SAM" }, "java": { "package": "software.amazon.awscdk.services.sam" }, "python": { "module": "aws_cdk.aws_sam" } } }, "aws-cdk-lib.aws_scheduler": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Scheduler" }, "java": { "package": "software.amazon.awscdk.services.scheduler" }, "python": { "module": "aws_cdk.aws_scheduler" } } }, "aws-cdk-lib.aws_sdb": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SDB" }, "java": { "package": "software.amazon.awscdk.services.sdb" }, "python": { "module": "aws_cdk.aws_sdb" } } }, "aws-cdk-lib.aws_secretsmanager": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SecretsManager" }, "java": { "package": "software.amazon.awscdk.services.secretsmanager" }, "python": { "module": "aws_cdk.aws_secretsmanager" } } }, "aws-cdk-lib.aws_securityhub": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SecurityHub" }, "java": { "package": "software.amazon.awscdk.services.securityhub" }, "python": { "module": "aws_cdk.aws_securityhub" } } }, "aws-cdk-lib.aws_securitylake": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.SecurityLake" }, "java": { "package": "software.amazon.awscdk.services.securitylake" }, "python": { "module": "aws_cdk.aws_securitylake" } } }, "aws-cdk-lib.aws_servicecatalog": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Servicecatalog" }, "java": { "package": "software.amazon.awscdk.services.servicecatalog" }, "python": { "module": "aws_cdk.aws_servicecatalog" } } }, "aws-cdk-lib.aws_servicecatalogappregistry": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Servicecatalogappregistry" }, "java": { "package": "software.amazon.awscdk.services.servicecatalogappregistry" }, "python": { "module": "aws_cdk.aws_servicecatalogappregistry" } } }, "aws-cdk-lib.aws_servicediscovery": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.ServiceDiscovery" }, "java": { "package": "software.amazon.awscdk.services.servicediscovery" }, "python": { "module": "aws_cdk.aws_servicediscovery" } } }, "aws-cdk-lib.aws_ses": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SES" }, "java": { "package": "software.amazon.awscdk.services.ses" }, "python": { "module": "aws_cdk.aws_ses" } } }, "aws-cdk-lib.aws_ses_actions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SES.Actions" }, "java": { "package": "software.amazon.awscdk.services.ses.actions" }, "python": { "module": "aws_cdk.aws_ses_actions" } } }, "aws-cdk-lib.aws_shield": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.Shield" }, "java": { "package": "software.amazon.awscdk.services.shield" }, "python": { "module": "aws_cdk.aws_shield" } } }, "aws-cdk-lib.aws_signer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Signer" }, "java": { "package": "software.amazon.awscdk.services.signer" }, "python": { "module": "aws_cdk.aws_signer" } } }, "aws-cdk-lib.aws_simspaceweaver": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SimSpaceWeaver" }, "java": { "package": "software.amazon.awscdk.services.simspaceweaver" }, "python": { "module": "aws_cdk.aws_simspaceweaver" } } }, "aws-cdk-lib.aws_sns": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SNS" }, "java": { "package": "software.amazon.awscdk.services.sns" }, "python": { "module": "aws_cdk.aws_sns" } } }, "aws-cdk-lib.aws_sns_subscriptions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SNS.Subscriptions" }, "java": { "package": "software.amazon.awscdk.services.sns.subscriptions" }, "python": { "module": "aws_cdk.aws_sns_subscriptions" } } }, "aws-cdk-lib.aws_sqs": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SQS" }, "java": { "package": "software.amazon.awscdk.services.sqs" }, "python": { "module": "aws_cdk.aws_sqs" } } }, "aws-cdk-lib.aws_ssm": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSM" }, "java": { "package": "software.amazon.awscdk.services.ssm" }, "python": { "module": "aws_cdk.aws_ssm" } } }, "aws-cdk-lib.aws_ssmcontacts": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSMContacts" }, "java": { "package": "software.amazon.awscdk.services.ssmcontacts" }, "python": { "module": "aws_cdk.aws_ssmcontacts" } } }, "aws-cdk-lib.aws_ssmincidents": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSMIncidents" }, "java": { "package": "software.amazon.awscdk.services.ssmincidents" }, "python": { "module": "aws_cdk.aws_ssmincidents" } } }, "aws-cdk-lib.aws_ssmquicksetup": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.SSMQuickSetup" }, "java": { "package": "software.amazon.awscdk.services.ssmquicksetup" }, "python": { "module": "aws_cdk.aws_ssmquicksetup" } } }, "aws-cdk-lib.aws_sso": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SSO" }, "java": { "package": "software.amazon.awscdk.services.sso" }, "python": { "module": "aws_cdk.aws_sso" } } }, "aws-cdk-lib.aws_stepfunctions": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.StepFunctions" }, "java": { "package": "software.amazon.awscdk.services.stepfunctions" }, "python": { "module": "aws_cdk.aws_stepfunctions" } } }, "aws-cdk-lib.aws_stepfunctions_tasks": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.StepFunctions.Tasks" }, "java": { "package": "software.amazon.awscdk.services.stepfunctions.tasks" }, "python": { "module": "aws_cdk.aws_stepfunctions_tasks" } } }, "aws-cdk-lib.aws_supportapp": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SupportApp" }, "java": { "package": "software.amazon.awscdk.services.supportapp" }, "python": { "module": "aws_cdk.aws_supportapp" } } }, "aws-cdk-lib.aws_synthetics": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Synthetics" }, "java": { "package": "software.amazon.awscdk.services.synthetics" }, "python": { "module": "aws_cdk.aws_synthetics" } } }, "aws-cdk-lib.aws_systemsmanagersap": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.SystemsManagerSAP" }, "java": { "package": "software.amazon.awscdk.services.systemsmanagersap" }, "python": { "module": "aws_cdk.aws_systemsmanagersap" } } }, "aws-cdk-lib.aws_timestream": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Timestream" }, "java": { "package": "software.amazon.awscdk.services.timestream" }, "python": { "module": "aws_cdk.aws_timestream" } } }, "aws-cdk-lib.aws_transfer": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Transfer" }, "java": { "package": "software.amazon.awscdk.services.transfer" }, "python": { "module": "aws_cdk.aws_transfer" } } }, "aws-cdk-lib.aws_verifiedpermissions": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.VerifiedPermissions" }, "java": { "package": "software.amazon.awscdk.services.verifiedpermissions" }, "python": { "module": "aws_cdk.aws_verifiedpermissions" } } }, "aws-cdk-lib.aws_voiceid": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.VoiceID" }, "java": { "package": "software.amazon.awscdk.services.voiceid" }, "python": { "module": "aws_cdk.aws_voiceid" } } }, "aws-cdk-lib.aws_vpclattice": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.VpcLattice" }, "java": { "package": "software.amazon.awscdk.services.vpclattice" }, "python": { "module": "aws_cdk.aws_vpclattice" } } }, "aws-cdk-lib.aws_waf": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WAF" }, "java": { "package": "software.amazon.awscdk.services.waf" }, "python": { "module": "aws_cdk.aws_waf" } } }, "aws-cdk-lib.aws_wafregional": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WAFRegional" }, "java": { "package": "software.amazon.awscdk.services.waf.regional" }, "python": { "module": "aws_cdk.aws_wafregional" } } }, "aws-cdk-lib.aws_wafv2": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WAFv2" }, "java": { "package": "software.amazon.awscdk.services.wafv2" }, "python": { "module": "aws_cdk.aws_wafv2" } } }, "aws-cdk-lib.aws_wisdom": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.Wisdom" }, "java": { "package": "software.amazon.awscdk.services.wisdom" }, "python": { "module": "aws_cdk.aws_wisdom" } } }, "aws-cdk-lib.aws_workspaces": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.WorkSpaces" }, "java": { "package": "software.amazon.awscdk.services.workspaces" }, "python": { "module": "aws_cdk.aws_workspaces" } } }, "aws-cdk-lib.aws_workspacesthinclient": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.WorkSpacesThinClient" }, "java": { "package": "software.amazon.awscdk.services.workspacesthinclient" }, "python": { "module": "aws_cdk.aws_workspacesthinclient" } } }, "aws-cdk-lib.aws_workspacesweb": { "targets": { "dotnet": { "package": "Amazon.CDK.AWS.WorkSpacesWeb" }, "java": { "package": "software.amazon.awscdk.services.workspacesweb" }, "python": { "module": "aws_cdk.aws_workspacesweb" } } }, "aws-cdk-lib.aws_xray": { "targets": { "dotnet": { "namespace": "Amazon.CDK.AWS.XRay" }, "java": { "package": "software.amazon.awscdk.services.xray" }, "python": { "module": "aws_cdk.aws_xray" } } }, "aws-cdk-lib.cloud_assembly_schema": {}, "aws-cdk-lib.cloudformation_include": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CloudFormation.Include" }, "java": { "package": "software.amazon.awscdk.cloudformation.include" }, "python": { "module": "aws_cdk.cloudformation_include" } } }, "aws-cdk-lib.custom_resources": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CustomResources" }, "java": { "package": "software.amazon.awscdk.customresources" }, "python": { "module": "aws_cdk.custom_resources" } } }, "aws-cdk-lib.cx_api": { "targets": { "dotnet": { "namespace": "Amazon.CDK.CXAPI" }, "java": { "package": "software.amazon.awscdk.cxapi" }, "python": { "module": "aws_cdk.cx_api" } } }, "aws-cdk-lib.lambda_layer_awscli": { "targets": { "dotnet": { "namespace": "Amazon.CDK.LambdaLayer.AwsCli" }, "java": { "package": "software.amazon.awscdk.lambdalayer.awscli" }, "python": { "module": "aws_cdk.lambda_layer_awscli" } } }, "aws-cdk-lib.lambda_layer_kubectl": { "targets": { "dotnet": { "namespace": "Amazon.CDK.LambdaLayer.Kubectl" }, "java": { "package": "software.amazon.awscdk.lambdalayer.kubectl" }, "python": { "module": "aws_cdk.lambda_layer_kubectl" } } }, "aws-cdk-lib.lambda_layer_node_proxy_agent": { "targets": { "dotnet": { "namespace": "Amazon.CDK.LambdaLayer.NodeProxyAgent" }, "java": { "package": "software.amazon.awscdk.lambda.layer.node.proxy.agent" }, "python": { "module": "aws_cdk.lambda_layer_node_proxy_agent" } } }, "aws-cdk-lib.pipelines": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Pipelines" }, "java": { "package": "software.amazon.awscdk.pipelines" }, "python": { "module": "aws_cdk.pipelines" } } }, "aws-cdk-lib.region_info": { "targets": { "dotnet": { "namespace": "Amazon.CDK.RegionInfo" }, "java": { "package": "software.amazon.awscdk.regioninfo" }, "python": { "module": "aws_cdk.region_info" } } }, "aws-cdk-lib.triggers": { "targets": { "dotnet": { "namespace": "Amazon.CDK.Triggers" }, "java": { "package": "software.amazon.awscdk.triggers" }, "python": { "module": "aws_cdk.triggers" } } } }, "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/main/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK.Lib" }, "go": { "moduleName": "github.com/aws/aws-cdk-go", "packageName": "awscdk" }, "java": { "maven": { "artifactId": "aws-cdk-lib", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk" }, "js": { "npm": "aws-cdk-lib" }, "python": { "distName": "aws-cdk-lib", "module": "aws_cdk" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "@open-constructs/aws-cdk", "docs": { "stability": "stable" }, "homepage": "https://github.com/open-constructs/aws-cdk-library.git", "jsiiVersion": "5.7.5 (build eb860fb)", "keywords": [ "cdk" ], "license": "Apache-2.0", "metadata": { "jsii": { "pacmak": { "hasDefaultInterfaces": true } }, "tscRootDir": "src" }, "name": "@open-constructs/aws-cdk", "readme": { "markdown": "# Open Constructs Library\n\nWelcome to the Open Constructs Library, an innovative solution designed to enhance cloud infrastructure deployment and management.\nOur library aims to provide a comprehensive set of tools and constructs that streamline the process of using AWS Cloud Development Kit (AWS CDK) for automation and deployment tasks.\n\n## About The Project\n\nThe Open Constructs Library is an open-source initiative aimed at supporting and simplifying the development and management of cloud-native applications.\nBy leveraging the power of AWS CDK, our library offers developers a wide range of pre-built constructs that encapsulate best practices, reduce boilerplate code, and accelerate the development process.\n\n### Features\n\n- **Pre-built Constructs**: A wide variety of constructs for common cloud infrastructure patterns.\n- **Best Practices Encapsulation**: Implements AWS best practices out of the box.\n- **Customizability**: Easily extend and customize constructs to fit your specific requirements.\n- **Community-driven**: Contributed to and used by a growing community of cloud professionals.\n\n## Getting Started\n\nTo get started with the Open Constructs Library, you'll need to have Node.js and the AWS CDK installed on your machine (Other languages will follow very soon). Follow these steps to set up your project.\n\n### Prerequisites\n\n- Node.js (version 18.x or later)\n- AWS CDK (version 2.120.0 or later)\n\n### Installation\n\n1. Install the library via npm:\n\n```bash\nnpm install @open-constructs/aws-cdk\n```\n\n2. Import the constructs you need in your CDK stack:\n\n```typescript\nimport { SomeConstruct } from '@open-constructs/aws-cdk';\n```\n\n3. Follow the library documentation to see how to use the constructs in your application.\n\n## Documentation\n\nFor more detailed documentation, including API references and examples, please visit our [documentation site](./API.md).\n\n## Contributing\n\nWe welcome contributions from the community! If you're interested in contributing to the Open Constructs Library, please read our [Contributing Guide](./CONTRIBUTING.md) for more information on how to get started.\n\n## Support and Community\n\nIf you need help or want to discuss the Open Constructs Library, join our community on cdk.dev Slack.\n\n## License\n\nThe Open Constructs Library is open-source software licensed under the [Apache License](./LICENSE).\n\n## Acknowledgements\n\n- AWS CDK\n- [Contributors](https://github.com/open-constructs/aws-cdk-library/graphs/contributors)\n\nWe are grateful to all the contributors who have helped to build and maintain this library.\n\n---\n\nFor more information, please visit our [official website](https://www.open-constructs.org).\n" }, "repository": { "type": "git", "url": "https://github.com/open-constructs/aws-cdk-library.git" }, "schema": "jsii/0.10.0", "submodules": { "@open-constructs/aws-cdk.aws_codeartifact": { "locationInModule": { "filename": "src/index.ts", "line": 2 }, "readme": { "markdown": "Constructs for the AWS CodeArtifact service\n\n# CDK Constructs for CodeArtifact Service\n\n## Overview\n\nThe `Domain` and `Repository` constructs simplify the creation and management of AWS CodeArtifact domains and repositories within AWS CDK\napplications. These constructs allow users to manage private repositories for software packages and define domains to group repositories,\nfacilitating secure sharing and version control across teams.\n\n## Usage\n\nImport the `Domain` and `Repository` constructs and create a new CodeArtifact domain & repository within your AWS CDK stack.\n\n```ts\nimport { App, Stack } from 'aws-cdk-lib';\nimport { Domain, Repository } from '@open-constructs/aws-cdk/aws-codeartifact';\n\nconst app = new App();\nconst stack = new Stack(app, 'CodeArtifactDomainStack');\n\nconst domain = new Domain(stack, 'MyDomain', {\n domainName: 'my-domain',\n});\n\nconst repository = new Repository(this, 'MyRepo', {\n domain: domain,\n repositoryName: 'my-repo',\n});\n```\n\n### Importing existing resources\n\nIf you need to manage an existing CodeArtifact repository, you can import it into your CDK stack. Since the domain is implicit in the ARN of the repository it will be automatically imported as well.\n\n```ts\nimport { Repository } from '@open-constructs/aws-cdk/aws-codeartifact';\n\nconst existingRepo = Repository.fromRepositoryArn(stack, 'ImportedRepo', 'arn:aws:codeartifact:us-east-1:123456789012:repository/my-domain/my-repo');\n```" }, "symbolId": "src/aws-codeartifact/index:" }, "@open-constructs/aws-cdk.aws_cur": { "locationInModule": { "filename": "src/index.ts", "line": 3 }, "readme": { "markdown": "Constructs for the AWS Cost and Usage reports\n\n# CostReport CDK Construct\n\n## Overview\n\nThe `CostReport` construct facilitates the creation and management of AWS Cost and Usage Reports (CUR)\nwithin AWS CDK applications. This construct automates the setup of the necessary S3 bucket for storing\nthe reports and configures permissions for AWS billing to write to this bucket. You can specify\nvarious properties of the report like name, format, and granularity.\n\n## Usage\n\nImport the necessary classes and enums from AWS CDK and this construct:\n\n```typescript\nimport { App, Stack } from 'aws-cdk-lib';\nimport { CostReport, ReportGranularity, CurFormat } from '@open-constructs/aws-cdk/aws-cur';\n```\n\n### Basic Example\n\nHere's how you can create a monthly cost and usage report in Parquet format:\n\n```typescript\nconst app = new App();\n// Cannot specify regions other than us-east-1\nconst stack = new Stack(app, 'CostReportStack', { env: { region: 'us-east-1' } });\n\nnew CostReport(stack, 'MyCostReport', {\n costReportName: 'monthly-business-report',\n reportGranularity: ReportGranularity.MONTHLY,\n format: CurFormat.PARQUET,\n});\n```\n\n### Advanced Example\n\nCreating a report with a custom S3 bucket and hourly granularity:\n\n```typescript\nimport { Bucket } from 'aws-cdk-lib/aws-s3';\n\nconst customBucket = new Bucket(stack, 'MyCustomBucket');\n\nnew CostReport(stack, 'MyDetailedCostReport', {\n costReportName: 'detailed-hourly-report',\n bucket: customBucket,\n reportGranularity: ReportGranularity.HOURLY,\n format: CurFormat.TEXT_OR_CSV,\n});\n```\n\n### Generating Unique Report Name By Default\n\nIf you set the `enableDefaultUniqueReportName` property to `true`, the construct will automatically\ngenerate a unique report name by default.\n\nThe cost report name must be unique within your AWS account. So this property is useful when you want\nto create multiple reports without specifying a report name for each one.\n\nIf you specify a report name directly via the `costReportName`, the construct will use that name instead\nof generating a unique one.\n\n```typescript\nnew CostReport(stack, 'MyCostReport', {\n enableDefaultUniqueReportName: true,\n});\n```\n\n### Additional Notes\n\nThe construct automatically handles the permissions required for AWS billing services to access the S3 bucket.\n" }, "symbolId": "src/aws-cur/index:" }, "@open-constructs/aws-cdk.aws_ec2": { "locationInModule": { "filename": "src/index.ts", "line": 4 }, "readme": { "markdown": "Constructs for the AWS EC2 service\n\n# EC2 Instance Connect Endpoint CDK Construct\n\n## Overview\n\nThe `InstanceConnectEndpoint` construct facilitates the creation and management of [EC2 Instance Connect endpoints](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/connect-with-ec2-instance-connect-endpoint.html)\nwithin AWS CDK applications.\n\n## Usage\n\nImport the necessary classes from AWS CDK and this construct and create a VPC for the endpoint:\n\n```ts\nimport { App, Stack } from 'aws-cdk-lib';\nimport * as ec2 from 'aws-cdk-lib/aws-ec2';\nimport { InstanceConnectEndpoint } from '@open-constructs/aws-cdk/aws-ec2';\n\nconst app = new App();\nconst stack = new Stack(app, 'InstanceConnectEndpointStack');\nconst vpc = new ec2.Vpc(stack, 'MyVpc');\n```\n\n### Basic Example\n\nHere's how you can create an EC2 Instance Connect endpoint and allow connections to an EC2 instance:\n\n```ts\nconst instance = new ec2.Instance(this, 'Instance', {\n vpc,\n instanceType: ec2.InstanceType.of(\n ec2.InstanceClass.C5,\n ec2.InstanceSize.LARGE,\n ),\n machineImage: new ec2.AmazonLinuxImage({\n generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX_2023,\n }),\n});\n\nconst endpoint = new InstanceConnectEndpoint(stack, 'MyEndpoint', {\n vpc,\n});\n\n// Allow SSH connections to the instance\n// You can also use the port 3389 for RDP connections\nendpoint.connections.allowTo(instance, ec2.Port.tcp(22));\n```\n\n### Advanced Example\n\nCreating an endpoint with a custom settings:\n\n```ts\ndeclare const endpointSecurityGroup: ec2.ISecurityGroup;\n\nconst endpoint = new InstanceConnectEndpoint(stack, 'MyCustomEndpoint', {\n vpc,\n securityGroups: [endpointSecurityGroup], // Specify user-defined security groups\n preserveClientIp: true, // Whether your client's IP address is preserved as the source\n clientToken: 'my-client-token', // Specify client token to ensure the idempotency of the request.\n});\n```\n\nImport an existing endpoint:\n\n```ts\ndeclare const existingEndpoint: ec2.IInstanceConnectEndpoint;\ndeclare const securityGroups: ec2.ISecurityGroup[];\n\nconst existingEndpoint = InstanceConnectEndpoint.fromInstanceConnectEndpointAttributes(\n stack,\n 'MyExistingEndpoint',\n {\n instanceConnectEndpointId: existingEndpoint.instanceConnectEndpointId,\n securityGroups,\n },\n);\n```\n" }, "symbolId": "src/aws-ec2/index:" }, "@open-constructs/aws-cdk.aws_elasticache": { "locationInModule": { "filename": "src/index.ts", "line": 5 }, "readme": { "markdown": "Constructs for the Amazon ElastiCache\n\n# ElastiCache CDK Construct\n\nThis module has constructs for [Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/WhatIs.html).\n\n* The `User` and `UserGroup` constructs facilitate the creation and management of users for the cache.\n* The `ServerlessCache` construct facilitates the creation and management of serverless cache.\n\n## Basic Usage for user and user group\n\nSetup required properties and create:\n\n```ts\nconst newDefaultUser = new NoPasswordRequiredUser(this, 'DefaultUser', {\n userName: 'default',\n});\n\nconst userGroup = new UserGroup(this, 'UserGroup', {\n users: [defaultUser],\n});\n```\n\n### RBAC\n\nIn Valkey 7.2 and onward and Redis OSS 6.0 onward you can use a feature called Role-Based Access Control (RBAC). RBAC is also the only way to control access to serverless caches.\n\nRBAC enables you to control cache access through user groups. These user groups are designed as a way to organize access to caches.\n\nFor more information, see [Role-Based Access Control (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html).\n\nTo enable RBAC for ElastiCache with Valkey or Redis OSS, you take the following steps:\n\n- Create users.\n- Create a user group and add users to the user group.\n- Assign the user group to a cache.\n\n### Create users\n\nFirst, you need to create users by using `IamUser`, `PasswordUser` or `NoPasswordRequiredUser` construct.\n\nWith RBAC, you create users and assign them specific permissions by using `accessString` property.\n\nFor more information, see [Specifying Permissions Using an Access String](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html#Access-string).\n\nYou can create an IAM-enabled user by using `IamUser` construct:\n\n```ts\nconst user = new IamUser(this, 'User', {\n // set user id\n userId: 'my-user',\n\n // set access string\n accessString: 'on ~* +@all',\n});\n```\n\n> NOTE: You can't set username in `IamUser` construct because IAM-enabled users must have matching user id and username. For more information, see [Limitations](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html). The construct automatically sets the username to be the same as the user id.\n\nIf you want to create a password authenticated user, use `PasswordUser` construct:\n\n```ts\nconst user = new PasswordUser(this, 'User', {\n // set user id\n userId: 'my-user-id',\n\n // set access string\n accessString: 'on ~* +@all',\n\n // set username\n userName: 'my-user-name',\n\n // set up to two passwords\n passwords: [\n cdk.SecretValue.unsafePlainText('adminUserPassword123'),\n cdk.SecretValue.unsafePlainText('anotherAdminUserPassword123'),\n ],\n});\n```\n\nIf the `passwords` property is not specified, a single password will be automatically generated and stored in AWS Secrets Manager.\n\n```ts\nconst user = new PasswordUser(this, 'User', {\n userId: 'my-user-id',\n accessString: 'on ~* +@all',\n userName: 'my-user-name',\n // `passwords` property is not specified and a single password will be generated\n});\n\n// you can access the ISecret object\nuser.generatedSecret\n```\n\nYou can also create a no password required user by using `NoPasswordRequiredUser` construct:\n\n```ts\nconst user = new NoPasswordRequiredUser(this, 'User', {\n // set user id\n userId: 'my-user-id',\n\n // set access string\n accessString: 'on ~* +@all',\n\n // set username\n userName: 'my-user-name',\n});\n```\n\n### Default user\n\nElastiCache automatically creates a default user with both a user ID and username set to `default`. This default user cannot be modified or deleted. The user is created as a no password authentication user.\n\nThis user is intended for compatibility with the default behavior of previous Redis OSS versions and has an access string that permits it to call all commands and access all keys.\n\nTo use this automatically created default user in CDK, you can import it using `NoPasswordRequiredUser.fromUserAttributes` method. For more information on import methods, see the [Import an existing user and user group](#import-an-existing-user-and-user-group) section.\n\nTo add proper access control to a cache, replace the default user with a new one that is either disabled by setting the `accessString` to `off -@all` or secured with a strong password.\n\nTo change the default user, create a new default user with the username set to `default`. You can then swap it with the original default user.\n\nFor more information, see [Applying RBAC to a Cache for ElastiCache with Valkey or Redis OSS](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html#rbac-using).\n\nIf you want to create a new default user, `userName` must be `default` and `userId` must not be `default` by using `NoPasswordRequiredUser` or `PasswordUser`:\n\n```ts\n// use the original `default` user by using import method\nconst defaultUser = NoPasswordRequiredUser.fromUserAttributes(this, 'DefaultUser', {\n // userId and userName must be 'default'\n userId: 'default',\n userName: 'default',\n});\n\n// create a new default user\nconst newDefaultUser = new NoPasswordRequiredUser(this, 'NewDefaultUser', {\n // new default user id must not be 'default'\n userId: 'new-default',\n // default username must be 'default'\n userName: 'default',\n});\n```\n\n> NOTE: You can't create a new default user using `IamUser` because an IAM-enabled user's username and user ID cannot be different.\n\n### Add users to the user group\n\nNext, use the `UserGroup` construct to create a user group and add users to it.\nEnsure that you include either the original default user or a new default user:\n\n```ts\ndeclare const newDefaultUser: User;\ndeclare const user: User;\ndeclare const anotherUser: User;\n\nconst userGroup = new UserGroup(this, 'UserGroup', {\n // add users including default user\n users: [newDefaultUser, user],\n});\n\n// you can also add a user by using addUser method\nuserGroup.addUser(anotherUser);\n```\n\n### Assign user group\n\nFinally, assign a user group to cache:\n\n```ts\ndeclare const vpc: ec2.Vpc;\ndeclare const userGroup: UserGroup;\n\nconst serverlessCache = new ServerlessCache(this, 'ServerlessCache', {\n engine: Engine.VALKEY,\n majorEngineVersion: MajorVersion.VER_8,\n serverlessCacheName: 'my-serverless-cache',\n vpc,\n // assign User Group\n userGroup,\n});\n\n```\n\n### Grant permissions to IAM-enabled users\n\nIf you create IAM-enabled users, `\"elasticache:Connect\"` action must be allowed for the users and cache.\n\n> NOTE: You don't need grant permissions to no password required users or password authentication users.\n\nFor more information, see [Authenticating with IAM](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html).\n\nTo grant permissions, you can use the `grantConnect` method in `IamUser` and `ServerlessCache` constructs:\n\n```ts\ndeclare const user: IamUser;\ndeclare const serverlessCache: ServerlessCache;\ndeclare const role: iam.Role;\n\n// grant \"elasticache:Connect\" action permissions to role\nuser.grantConnect(role);\nserverlessCache.grantConnect(role);\n```\n\n### Import an existing user and user group\n\nYou can import an existing user and user group by using import methods:\n\n```ts\nconst importedIamUser = IamUser.fromUserId(this, 'ImportedIamUser', 'my-iam-user-id');\n\nconst importedPasswordUser = PasswordUser.fromUserAttributes(stack, 'ImportedPasswordUser', {\n userId: 'my-password-user-id',\n userName: 'my-password-user-name',\n});\n\nconst importedNoPasswordRequiredUser = NoPasswordRequiredUser.fromUserAttributes(stack, 'ImportedNoPasswordUser', {\n userId: 'my-no-password-user-id',\n userName: 'my-no-password-user-name',\n});\n\nconst importedUserGroup = UserGroup.fromUserGroupId(this, 'ImportedUserGroup', 'my-user-group-id');\n```\n\n## Basic Usage for serverless cache\n\nSetup required properties and create:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst serverlessCache = new ServerlessCache(this, 'ServerlessCache', {\n engine: Engine.VALKEY,\n vpc,\n majorEngineVersion: MajorVersion.VER_8,\n});\n```\n\n### Connecting to serverless cache\n\nTo control who can access the serverless cache by the security groups, use the `.connections` attribute.\n\nThe serverless cache has a default port `6379`.\n\nThis example allows an EC2 instance to connect to the serverless cache:\n\n```ts\ndeclare const serverlessCache: ServerlessCache;\ndeclare const instance: ec2.Instance;\n\n// allow the EC2 instance to connect to serverless cache on default port 6379\nserverlessCache.connections.allowDefaultPortFrom(instance);\n```\n\nThe endpoint and the port to access your serverless cache will be available as the `.endpointAddress` and `.endpointPort` attributes:\n\n```ts\ndeclare const serverlessCache: ServerlessCache;\n\nconst endpointAddress = serverlessCache.endpointAddress;\nconst endpointPort = serverlessCache.endpointPort;\n```\n\n### Cache usage limits\n\nYou can choose to configure a maximum usage on both cache data storage and ECPU/second for your cache to control cache costs.\nDoing so will ensure that your cache usage never exceeds the configured maximum.\n\nFor more infomation, see [Setting scaling limits to manage costs](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Scaling.html#Pre-Scaling).\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst serverlessCache = new ServerlessCache(this, 'ServerlessCache', {\n engine: Engine.VALKEY,\n vpc,\n cacheUsageLimits: {\n // cache data storage limits (GB)\n dataStorage: DataStorage.gb({ minimum: 1, maximum: 5000 }), // minimum: 1GB, maximum: 5000GB\n // ECPU limits (ECPU/second)\n ecpuPerSecond: ECPUPerSecond.of({ minimum: 1000, maximum: 15000000 }), // minimum: 1000, maximum: 15000000\n },\n});\n```\n\n### Snapshots and restore\n\nYou can enable automatic backups for serverless cache.\nWhen automatic backups are enabled, ElastiCache creates a backup of the cache on a daily basis.\n\nAlso you can set the backup window for any time when it's most convenient.\nIf you don't specify a backup window, ElastiCache assigns one automatically.\n\nFor more information, see [Scheduling automatic backups](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-automatic.html).\n\nTo enable automatic backups, set the `snapshotRetentionLimit` property. You can also specify the snapshot creation time by setting `dailySnapshotTime` property:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst serverlessCache = new ServerlessCache(this, 'ServerlessCache', {\n engine: Engine.VALKEY,\n // enable automatic backups and set the retention period to 6 days\n snapshotRetentionLimit: 6,\n // set the backup window to 12:00 AM UTC\n dailySnapshotTime: new DailySnapshotTime({ hour: 12, minute: 0 }),\n vpc,\n majorEngineVersion: MajorVersion.VER_8,\n});\n```\n\nYou can create a final backup by setting `finalSnapshotName` property.\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst serverlessCache = new ServerlessCache(this, 'ServerlessCache', {\n engine: Engine.VALKEY,\n // set the final snapshot name\n finalSnapshotName: 'my-finalsnapshot',\n vpc,\n majorEngineVersion: MajorVersion.VER_8,\n});\n```\n\nYou can restore from snapshots by setting snapshot ARNs to `snapshotArnsToRestore` property:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst serverlessCache = new ServerlessCache(this, 'ServerlessCache', {\n engine: Engine.VALKEY,\n // set the snapshot to restore\n snapshotArnsToRestore: ['arn:aws:elasticache:us-east-1:123456789012:serverlesscachesnapshot:my-final-snapshot'],\n vpc,\n majorEngineVersion: MajorVersion.VER_8,\n});\n```\n\n### Customer Managed Key for encryption at rest\n\nElastiCache supports symmetric Customer Managed key (CMK) for encryption at rest.\n\nFor more information, see [Using customer managed keys from AWS KMS](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/at-rest-encryption.html#using-customer-managed-keys-for-elasticache-security).\n\nTo use CMK, set your CMK to the `kmsKey` property:\n\n```ts\ndeclare const kmsKey: kms.Key;\n\nconst serverlessCache = new ServerlessCache(this, 'ServerlessCache', {\n engine: Engine.VALKEY,\n serverlessCacheName: 'my-serverless-cache',\n vpc,\n // set Customer Managed Key\n kmsKey,\n majorEngineVersion: MajorVersion.VER_8,\n});\n```\n\n### Metrics\n\nYou can monitor your serverless cache using CloudWatch Metrics via the `metric` method.\n\nFor more information about serverless cache metrics, see [Serverless metrics and events for Valkey and Redis OSS](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/serverless-metrics-events-redis.html) and [Serverless metrics and events for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/serverless-metrics-events.memcached.html).\n\n```ts\ndeclare const serverlessCache: ServerlessCache;\n\n// The 5 minutes average of the total number of successful read-only key lookups in the cache over 5 minutes.\nconst cacheHits = serverlessCache.metric('CacheHits', { statistic: 'sum' });\n\n// The 5 minutes average of the total number of bytes used by the data stored in your cache over 5 minutes.\nconst bytesUsedForCache = serverlessCache.metricBytesUsedForCache();\n\n// The 5 minutes average of the total number of ElastiCacheProcessingUnits (ECPUs) consumed by the requests executed on your cache.\nconst elastiCacheProcessingUnits = serverlessCache.metricElastiCacheProcessingUnits();\n\n// Create an alarm for ECPUs.\nelastiCacheProcessingUnits.createAlarm(this, 'ElastiCacheProcessingUnitsAlarm', {\n threshold: 50,\n evaluationPeriods: 1,\n});\n```\n\n### Import an existing serverless cache\n\nTo import an existing ServerlessCache, use the `ServerlessCache.fromServerlessCacheAttributes` method:\n\n```ts\ndeclare const vpc: ec2.Vpc;\ndeclare const securityGroup: ec2.SecurityGroup;\n\nconst importedServerlessCache = ServerlessCache.fromServerlessCacheAttributes(this, 'ImportedServerlessCache', {\n serverlessCacheName: 'my-serverless-cache',\n securityGroups: [securityGroup],\n endpointAddress: 'my-serverless-cache.endpoint.com',\n endpointPort: 6379,\n});\n```\n" }, "symbolId": "src/aws-elasticache/index:" }, "@open-constructs/aws-cdk.aws_fsx": { "locationInModule": { "filename": "src/index.ts", "line": 6 }, "readme": { "markdown": "Constructs for the AWS FSx service\n\n# Fsx for NetApp ONTAP File System CDK Construct\n\nThe `OntapFileSystem` construct facilitates the creation and management of [Amazon FSx for NetApp ONTAP](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/what-is-fsx-ontap.html) file systems within AWS CDK applications.\n\n## Basic Usage for FSx for NetApp ONTAP\n\nSetup required properties and create:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst fileSystem = new OntapFileSystem(this, 'FsxOntapFileSystem', {\n ontapConfiguration: {\n deploymentType: OntapDeploymentType.SINGLE_AZ_2,\n },\n storageCapacityGiB: 1200,\n vpc,\n vpcSubnet: vpc.privateSubnets,\n});\n```\n\n### Connecting to FSx for NetApp ONTAP\n\nTo control who can access the file system, use the `.connections` attribute.\n\nThis example allows an EC2 instance to connect to a file system on port 2049:\n\n```ts\ndeclare const fileSystem: OntapFileSystem;\ndeclare const instance: ec2.Instance;\n\nfileSystem.connections.allowFrom(instance, ec2.Port.tcp(2049));\n```\n\n### Deployment Type\n\nThe `OntapFileSystem` construct supports the following deployment types:\n\n- `SINGLE_AZ_1`: A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.\n- `SINGLE_AZ_2`: A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.\n- `MULTI_AZ_1`: A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.\n- `MULTI_AZ_2`: A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.\n\nOnly `SINGLE_AZ_2` allows setting HA pairs to a value other than 1.\n\n### Backup\n\nWith FSx for ONTAP, you can protect your data by taking automatic daily backups and user-initiated backups of the volumes on your file system.\nCreating regular backups for your volumes is a best practice that helps support your data retention and compliance needs.\n\nYou can restore volume backups to any existing FSx for ONTAP file system you have access to that is in the same AWS Region where the backup is stored.\nWorking with Amazon FSx backups makes it is easy to create, view, restore, and delete backups of your volumes.\n\nTo enable automatic backups, set the `automaticBackupRetention` property to a non-zero value in the `ontapConfiguration`:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst fileSystem = new OntapFileSystem(this, 'FsxOntapFileSystem', {\n ontapConfiguration: {\n deploymentType: OntapDeploymentType.SINGLE_AZ_2,\n // Enable automatic backups and set the retention period to 3 days\n automaticBackupRetention: cdk.Duration.days(3),\n // Set the backup window to 1:00 AM UTC\n dailyAutomaticBackupStartTime: new fsx.DailyAutomaticBackupStartTime({\n hour: 1,\n minute: 0,\n }),\n },\n storageCapacityGiB: 1200,\n vpc,\n vpcSubnet: vpc.privateSubnets,\n});\n```\n\n### File system storage capacity and IOPS\n\nWhen you create an FSx for ONTAP file system, you specify the storage capacity of the SSD tier.\n\nFor second-generation Single-AZ file systems,\nthe storage capacity that you specify is spread evenly among the storage pools of each high-availability (HA) pair;\nthese storage pools are called aggregates.\n\nFor each GiB of SSD storage that you provision,\nAmazon FSx automatically provisions 3 SSD input/output operations per second (IOPS) for the file system,\nup to a maximum of 160,000 SSD IOPS per file system.\n\nFor second-generation Single-AZ file systems, your SSD IOPS are spread evenly across each of your file system's aggregates.\nYou have the option to specify a level of provisioned SSD IOPS above the automatic 3 SSD IOPS per GiB.\n\nFor more information, see [File system storage capacity and IOPS](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/storage-capacity-and-IOPS.html).\n\nTo specify the storage capacity and level of provisioned SSD IOPS, set the `storageCapacityGiB` in the `OntapFileSystemProps` and `diskIops` property in the `ontapConfiguration`:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst fileSystem = new OntapFileSystem(this, 'FsxOntapFileSystem', {\n ontapConfiguration: {\n deploymentType: OntapDeploymentType.SINGLE_AZ_2,\n // Set the level of provisioned SSD IOPS to 12,288\n diskIops: 12288,\n haPairs: 2,\n },\n // Set the storage capacity to 2 TiB\n storageCapacityGiB: 2048,\n vpc,\n vpcSubnet: vpc.privateSubnets,\n});\n```\n\n**Note**:\n\n- The storage capacity has a minimum and maximum value based on the HA pairs. The minimum value is `1,024 * haPairs` GiB and the maximum value is smaller one between `524,288 * haPairs` and `1,048,576` GiB.\n- The level of provisioned SSD IOPS has a minimum and maximum value based on the storage capacity. The minimum value is `3 * storageCapacityGiB * haPairs` IOPS and the maximum value is `200,000 * haPairs` IOPS.\n\n### Multi-AZ file systems\n\nMulti-AZ file systems support all the availability and durability features of Single-AZ file systems.\nIn addition, they are designed to provide continuous availability to data even when an Availability Zone is unavailable.\n\nMulti-AZ deployments have a single HA pair of file servers,\nthe standby file server is deployed in a different Availability Zone from the active file server in the same AWS Region.\nAny changes written to your file system are synchronously replicated across Availability Zones to the standby.\n\nTo create a Multi-AZ file system, set the `deploymentType` to `MULTI_AZ_X` and specify `endpointIpAddressRange`, `routeTables` and `preferredSubnet` in the `ontapConfiguration`:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst fileSystem = new OntapFileSystem(this, 'FsxOntapFileSystem', {\n ontapConfiguration: {\n deploymentType: OntapDeploymentType.MULTI_AZ_2,\n // The IP address range in which the endpoints to access your file system will be created.\n endpointIpAddressRange: '192.168.39.0/24',\n // The route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.\n // You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located.\n routeTables: [vpc.privateSubnets.routeTable],\n // The subnet in which you want the preferred file server to be located.\n preferredSubnet: vpc.privateSubnets[0],\n },\n storageCapacityGiB: 1200,\n vpc,\n vpcSubnet: vpc.privateSubnets,\n});\n```\n\n**Note**:\n\n- `preferredSubnet` must be the part of the `vpcSubnet`.\n- Amazon FSx manages VPC route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with Key: `AmazonFSx`; Value: `ManagedByAmazonFSx`.\n\n### Throughput Capacity\n\nFSx for ONTAP configures throughput capacity when you create the file system.\nYou can modify your file system's throughput capacity at any time.\n\nKeep in mind that your file system requires a specific configuration to achieve the maximum amount of throughput capacity.\n\nFor more information, see [Managing throughput capacity](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html).\n\nTo specify the throughput capacity, set the `throughputCapacityPreHaPair` property in the `ontapConfiguration`.\n\nThis example sets the throughput capacity to 1536 MiB/s per HA pair:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst fileSystem = new OntapFileSystem(this, 'FsxOntapFileSystem', {\n ontapConfiguration: {\n deploymentType: OntapDeploymentType.SINGLE_AZ_2,\n haPairs: 4,\n // Set the total throughput capacity to 6144 MiB/s\n throughputCapacity: SingleAz2ThroughputCapacityPerHaPair.MB_PER_SEC_1536,\n },\n storageCapacityGiB: 4096,\n vpc,\n vpcSubnet: vpc.privateSubnets,\n});\n```\n\n### Maintenance Window\n\nAs a fully-managed service, FSx for ONTAP regularly performs maintenance on and updates to your file system.\nThis maintenance has no impact for most workloads.\n\nFor workloads that are performance-sensitive,\non rare occasions you may notice a brief (<60 seconds) impact on performance when maintenance is occurring;\nAmazon FSx enables you to use the maintenance window to control when any such potential maintenance activity occurs.\n\nTo set the maintenance window, specify the `maintenanceWindow` property in the `ontapConfiguration`:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst fileSystem = new OntapFileSystem(this, 'FsxOntapFileSystem', {\n ontapConfiguration: {\n deploymentType: OntapDeploymentType.SINGLE_AZ_2,\n // Set the weekly maintenance window to SUNDAY 1:00 AM UTC\n weeklyMaintenanceStartTime: new MaintenanceTime({\n day: fsx.Weekday.SUNDAY,\n hour: 1,\n minute: 0,\n }),\n },\n storageCapacityGiB: 1200,\n vpc,\n vpcSubnet: vpc.privateSubnets,\n});\n```\n\n### Import an existing file system\n\nTo import an existing FSx for ONTAP file system, use the `OntapFileSystem.fromOntapFileSystemAttributes` method:\n\n```ts\ndeclare const existingFileSystem: fsx.IFileSystemBase;\ndeclare const vpc: ec2.Vpc;\n\nconst fileSystem = OntapFileSystem.fromOntapFileSystemAttributes(this, 'FsxOntapFileSystem', {\n dnsName: existingFileSystem.dnsName,\n fileSystemId: existingFileSystem.fileSystemId,\n securityGroup: existingFileSystem.securityGroup,\n});\n```\n" }, "symbolId": "src/aws-fsx/index:" }, "@open-constructs/aws-cdk.aws_redshiftserverless": { "locationInModule": { "filename": "src/index.ts", "line": 7 }, "readme": { "markdown": "Constructs for the Amazon Redshift Serverless\n\n# Redshift Serverless CDK Construct\n\n## Overview\n\nThe `Namespace` construct and the `Workgroup` construct facilitate the creation and management of [Redshift Serverless Workgroups and namespaces](https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-workgroup-namespace.html) within AWS CDK applications.\n\n## Usage\n\nImport the necessary classes from AWS CDK and this construct and create a VPC for the workgroup:\n\n```ts\nimport { App, Stack } from 'aws-cdk-lib';\nimport * as ec2 from 'aws-cdk-lib/aws-ec2';\nimport { Namespace, Workgroup } from '@open-constructs/aws-cdk/aws-redshiftserverless';\n\nconst app = new App();\nconst stack = new Stack(app, 'RedshiftServerlessStack',{\n account: '012345678901'\n region: 'us-east-1',\n});\nconst vpc = new ec2.Vpc(stack, 'MyVpc');\n```\n\n**Note** If you want to use `Vpc` Construct to create a VPC for `Workgroup`, you must specify `account` and `region` in `Stack`.\n`Workgroup` needs at least three subnets, and they must span across three Availability Zones.\n\nThe environment-agnostic stacks will be created with access to only 2 AZs (Ref: [`maxAzs` property docs](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Vpc.html#maxazs))\n\nFor more information about Redshift Serverless's limitations, see [Considerations when using Amazon Redshift Serverless](https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-usage-considerations.html).\n\n### Basic Example\n\nHere's how you can create a namespace and a workgroup:\n\n```ts\nimport { SecretValue } from 'aws-cdk-lib';\nimport * as iam from 'aws-cdk-lib/aws-iam';\ndeclare const defaultIamRole: iam.IRole;\ndeclare const anotherIamRole: iam.IRole;\n\nconst namespace = new redshiftserverless.Namespace(stack, 'Namespace', {\n namespaceName: 'my-namespace',\n defaultIamRole: myIamRole, // Specify a default IAM role\n iamRoles: [defaultIamRole, anotherIamRole], // Assign IAM roles list which must include default IAM Role\n});\n\nconst workgroup = new redshiftserverless.Workgroup(stack, 'MyWorkgroup', {\n workgroupName: 'my-workgroup',\n namespace,\n vpc,\n});\n```\n\n### Advanced Example\n\nCreating a namespace and a workgroup with custom settings:\n\n```ts\ndeclare const workgroupSecurityGroup: ec2.ISecurityGroup;\n\nconst namespace = new redshiftserverless.Namespace(stack, 'MyCustomNamespace', {\n namespaceName: 'my-custom-namespace',\n dbName: 'mydb', // Specify user-defined database name\n adminUsername: 'admin', // Specify user-defined admin username\n adminUserPassword: SecretValue.unsafePlainText('My-password-123!'), // Specify user-defined admin password\n logExports: [redshiftserverless.LogExport.USER_LOG], // Log export settings\n});\n\nconst workgroup = new redshiftserverless.Workgroup(stack, 'MyCustomWorkgroup', {\n workgroupName: 'my-custom-workgroup',\n namespace,\n vpc,\n baseCapacity: 32, // Specify Base Capacity uses to serve queries\n securityGroups: [workgroupSecurityGroup], // Specify user-defined security groups\n});\n```\n\n### Import an existing endpoint:\nYou can import existing namespaces and workgroups:\n\n```ts\ndeclare const securityGroup: ec2.ISecurityGroup;\n\nconst importedNamespace = redshiftserverless.Namespace.fromNamespaceAttributes(stack, 'ImportedNamespace', {\n namespaceId: 'my-namespace-id',\n namespaceName: 'my-namespace-name',\n});\n\nconst importedWorkgroup = redshiftserverless.Workgroup.fromWorkgroupAttributes(stack, 'ImportedWorkgroup', {\n workgroupName: 'my-workgroup',\n workgroupId: 'my-workgroup-id',\n endpointAddress: 'my-workgroup.endpoint.com',\n port: 5439,\n securityGroups: [securityGroup],\n});\n```\n" }, "symbolId": "src/aws-redshiftserverless/index:" } }, "targets": { "js": { "npm": "@open-constructs/aws-cdk" }, "python": { "distName": "open-constructs-aws-cdk", "module": "open_constructs_aws_cdk" } }, "types": { "@open-constructs/aws-cdk.aws_codeartifact.Domain": { "assembly": "@open-constructs/aws-cdk", "base": "aws-cdk-lib.Resource", "docs": { "stability": "stable", "summary": "Deploys a CodeArtifact domain." }, "fqn": "@open-constructs/aws-cdk.aws_codeartifact.Domain", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 310 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.DomainProps" } } ] }, "interfaces": [ "@open-constructs/aws-cdk.aws_codeartifact.IDomain" ], "kind": "class", "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 233 }, "methods": [ { "docs": { "stability": "stable", "summary": "Creates an IDomain object from an existing CodeArtifact domain ARN." }, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 261 }, "name": "fromDomainArn", "parameters": [ { "docs": { "summary": "The parent construct." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "The construct id." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- The ARN (Amazon Resource Name) of the existing CodeArtifact domain." }, "name": "domainArn", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.IDomain" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates a Domain object from existing domain attributes." }, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 241 }, "name": "fromDomainAttributes", "parameters": [ { "docs": { "summary": "The parent construct." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "The construct id." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "The attributes of the domain to import." }, "name": "attrs", "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.DomainAttributes" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.IDomain" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Adds a statement to the Codeartifact domain resource policy." }, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 113 }, "name": "addToResourcePolicy", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IDomain", "parameters": [ { "docs": { "summary": "The policy statement to add." }, "name": "statement", "type": { "fqn": "aws-cdk-lib.aws_iam.PolicyStatement" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.AddToResourcePolicyResult" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 329 }, "name": "createResource", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_codeartifact.CfnDomain" } } }, { "docs": { "remarks": "It handles both same-environment and cross-environment scenarios:\n- For same-environment grants, it adds the permissions to the principal or resource.\n- For cross-environment grants, it adds the permissions to both the principal and the resource.", "stability": "stable", "summary": "Grants permissions to the specified grantee on this CodeArtifact domain." }, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 151 }, "name": "grant", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IDomain", "parameters": [ { "docs": { "summary": "- The principal to grant permissions to." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } }, { "docs": { "remarks": "These should be valid CodeArtifact actions.", "summary": "- The actions to grant." }, "name": "actions", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } }, "variadic": true }, { "docs": { "stability": "stable", "summary": "Grants contribute permissions to the specified grantee on this CodeArtifact domain." }, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 176 }, "name": "grantContribute", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IDomain", "parameters": [ { "docs": { "summary": "- The principal to grant contribute permissions to." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } } } ], "name": "Domain", "namespace": "aws_codeartifact", "properties": [ { "docs": { "stability": "stable", "summary": "The ARN (Amazon Resource Name) of this CodeArtifact domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 289 }, "name": "domainArn", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IDomain", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The name of this CodeArtifact domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 293 }, "name": "domainName", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IDomain", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The AWS account ID that owns this domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 301 }, "name": "domainOwner", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IDomain", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The ARN of the key used to encrypt the Domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 306 }, "name": "domainEncryptionKey", "optional": true, "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IDomain", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The AWS KMS encryption key associated with this domain, if any." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 297 }, "name": "encryptionKey", "optional": true, "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IDomain", "type": { "fqn": "aws-cdk-lib.aws_kms.IKey" } }, { "docs": { "stability": "stable", "summary": "(internal) The CloudFormation resource representing this CodeArtifact domain." }, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 280 }, "name": "cfnResource", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_codeartifact.CfnDomain" } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 308 }, "name": "policy", "optional": true, "protected": true, "type": { "fqn": "aws-cdk-lib.aws_iam.PolicyDocument" } } ], "symbolId": "src/aws-codeartifact/domain:Domain" }, "@open-constructs/aws-cdk.aws_codeartifact.DomainAttributes": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Interface representing the attributes of a CodeArtifact domain." }, "fqn": "@open-constructs/aws-cdk.aws_codeartifact.DomainAttributes", "kind": "interface", "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 192 }, "name": "DomainAttributes", "namespace": "aws_codeartifact", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ARN (Amazon Resource Name) of the CodeArtifact domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 196 }, "name": "domainArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the CodeArtifact domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 201 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The AWS account ID that owns the domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 211 }, "name": "domainOwner", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The AWS KMS encryption key associated with the domain, if any." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 206 }, "name": "encryptionKey", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_kms.IKey" } } ], "symbolId": "src/aws-codeartifact/domain:DomainAttributes" }, "@open-constructs/aws-cdk.aws_codeartifact.DomainProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for `Domain`." }, "fqn": "@open-constructs/aws-cdk.aws_codeartifact.DomainProps", "kind": "interface", "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 217 }, "name": "DomainProps", "namespace": "aws_codeartifact", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the Domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 221 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- An AWS managed KMS key is used", "stability": "stable", "summary": "The key used to encrypt the Domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 227 }, "name": "encryptionKey", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_kms.IKey" } } ], "symbolId": "src/aws-codeartifact/domain:DomainProps" }, "@open-constructs/aws-cdk.aws_codeartifact.IDomain": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Represents a CodeArtifact Domain." }, "fqn": "@open-constructs/aws-cdk.aws_codeartifact.IDomain", "interfaces": [ "aws-cdk-lib.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 18 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Adds a statement to the Codeartifact domain resource policy." }, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 56 }, "name": "addToResourcePolicy", "parameters": [ { "docs": { "summary": "The policy statement to add." }, "name": "statement", "type": { "fqn": "aws-cdk-lib.aws_iam.PolicyStatement" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.AddToResourcePolicyResult" } } }, { "abstract": true, "docs": { "remarks": "It handles both same-environment and cross-environment scenarios:\n- For same-environment grants, it adds the permissions to the principal or resource.\n- For cross-environment grants, it adds the permissions to both the principal and the resource.", "stability": "stable", "summary": "Grants permissions to the specified grantee on this CodeArtifact domain." }, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 68 }, "name": "grant", "parameters": [ { "docs": { "summary": "- The principal to grant permissions to." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } }, { "docs": { "remarks": "These should be valid CodeArtifact actions.", "summary": "- The actions to grant." }, "name": "actions", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } }, "variadic": true }, { "abstract": true, "docs": { "stability": "stable", "summary": "Grants contribute permissions to the specified grantee on this CodeArtifact domain." }, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 75 }, "name": "grantContribute", "parameters": [ { "docs": { "summary": "- The principal to grant contribute permissions to." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } } } ], "name": "IDomain", "namespace": "aws_codeartifact", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the Domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 24 }, "name": "domainArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The name of the Domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 31 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "12-digit account number of the AWS account that owns the domain that contains the Domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 45 }, "name": "domainOwner", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the key used to encrypt the Domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 38 }, "name": "domainEncryptionKey", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The KMS key used to encrypt the Domain." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/domain.ts", "line": 50 }, "name": "encryptionKey", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_kms.IKey" } } ], "symbolId": "src/aws-codeartifact/domain:IDomain" }, "@open-constructs/aws-cdk.aws_codeartifact.IRepository": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Represents an CodeArtifact Repository." }, "fqn": "@open-constructs/aws-cdk.aws_codeartifact.IRepository", "interfaces": [ "aws-cdk-lib.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 66 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Adds a statement to the CodeArtifact repository resource policy." }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 106 }, "name": "addToResourcePolicy", "parameters": [ { "docs": { "summary": "The policy statement to add." }, "name": "statement", "type": { "fqn": "aws-cdk-lib.aws_iam.PolicyStatement" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.AddToResourcePolicyResult" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Grants the given principal identity permissions to perform the actions on the repository." }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 114 }, "name": "grant", "parameters": [ { "docs": { "summary": "The principal to grant permissions to." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } }, { "docs": { "summary": "The actions to grant." }, "name": "actions", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } }, "variadic": true }, { "abstract": true, "docs": { "stability": "stable", "summary": "Grants the given principal identity permissions to perform the actions on the repository." }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 128 }, "name": "grantRead", "parameters": [ { "docs": { "summary": "The principal to grant permissions to." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Grants the given principal identity permissions to perform the actions on the repository." }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 121 }, "name": "grantReadAndPublish", "parameters": [ { "docs": { "summary": "The principal to grant permissions to." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } } } ], "name": "IRepository", "namespace": "aws_codeartifact", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The domain that contains the repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 99 }, "name": "domain", "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.IDomain" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 72 }, "name": "repositoryArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The domain that contains the repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 86 }, "name": "repositoryDomainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The domain owner of the repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 93 }, "name": "repositoryDomainOwner", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The name of the repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 79 }, "name": "repositoryName", "type": { "primitive": "string" } } ], "symbolId": "src/aws-codeartifact/repository:IRepository" }, "@open-constructs/aws-cdk.aws_codeartifact.Repository": { "assembly": "@open-constructs/aws-cdk", "base": "aws-cdk-lib.Resource", "docs": { "stability": "stable", "summary": "Deploys a CodeArtifact repository." }, "fqn": "@open-constructs/aws-cdk.aws_codeartifact.Repository", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 392 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.RepositoryProps" } } ] }, "interfaces": [ "@open-constructs/aws-cdk.aws_codeartifact.IRepository" ], "kind": "class", "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 297 }, "methods": [ { "docs": { "stability": "stable", "summary": "Creates an IRepository object from an existing repository ARN." }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 325 }, "name": "fromRepositoryArn", "parameters": [ { "docs": { "summary": "- The parent construct in which to create this repository reference." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- The identifier of the construct." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- The ARN of the repository to import." }, "name": "repositoryArn", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.IRepository" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates an IRepository object from existing repository attributes." }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 305 }, "name": "fromRepositoryAttributes", "parameters": [ { "docs": { "summary": "- The parent construct in which to create this repository reference." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "summary": "- The identifier of the construct." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- The attributes of the repository to import." }, "name": "attrs", "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.RepositoryAttributes" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.IRepository" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Adds a statement to the CodeArtifact repository resource policy." }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 215 }, "name": "addToResourcePolicy", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IRepository", "parameters": [ { "docs": { "summary": "The policy statement to add." }, "name": "statement", "type": { "fqn": "aws-cdk-lib.aws_iam.PolicyStatement" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.AddToResourcePolicyResult" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 430 }, "name": "createResource", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_codeartifact.CfnRepository" } } }, { "docs": { "stability": "stable", "summary": "Grants permissions to the specified grantee on this CodeArtifact repository." }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 237 }, "name": "grant", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IRepository", "parameters": [ { "docs": { "summary": "The principal to grant permissions to." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } }, { "docs": { "summary": "The actions to grant." }, "name": "actions", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } }, "variadic": true }, { "docs": { "stability": "stable", "summary": "Grants read permissions to the specified grantee on this CodeArtifact repository." }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 262 }, "name": "grantRead", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IRepository", "parameters": [ { "docs": { "summary": "The principal to grant read permissions to." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } } }, { "docs": { "stability": "stable", "summary": "Grants read and publish permissions to the specified grantee on this CodeArtifact repository." }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 271 }, "name": "grantReadAndPublish", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IRepository", "parameters": [ { "docs": { "summary": "The principal to grant read and publish permissions to." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 434 }, "name": "renderUpstreams", "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } } ], "name": "Repository", "namespace": "aws_codeartifact", "properties": [ { "docs": { "stability": "stable", "summary": "The domain that contains this repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 388 }, "name": "domain", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IRepository", "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.IDomain" } }, { "docs": { "stability": "stable", "summary": "The ARN (Amazon Resource Name) of this CodeArtifact repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 372 }, "name": "repositoryArn", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IRepository", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The domain that contains this repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 380 }, "name": "repositoryDomainName", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IRepository", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The domain owner of this repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 384 }, "name": "repositoryDomainOwner", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IRepository", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The name of this CodeArtifact repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 376 }, "name": "repositoryName", "overrides": "@open-constructs/aws-cdk.aws_codeartifact.IRepository", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 390 }, "name": "upstreams", "protected": true, "type": { "collection": { "elementtype": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.IRepository" }, "kind": "array" } } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 389 }, "name": "policy", "optional": true, "protected": true, "type": { "fqn": "aws-cdk-lib.aws_iam.PolicyDocument" } }, { "docs": { "stability": "stable", "summary": "(internal) The CloudFormation resource representing this CodeArtifact repository." }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 363 }, "name": "cfnResource", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_codeartifact.CfnRepository" } }, { "docs": { "stability": "stable", "summary": "The properties used to create the CloudFormation resource for this repository." }, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 367 }, "name": "cfnResourceProps", "protected": true, "type": { "fqn": "aws-cdk-lib.aws_codeartifact.CfnRepositoryProps" } } ], "symbolId": "src/aws-codeartifact/repository:Repository" }, "@open-constructs/aws-cdk.aws_codeartifact.RepositoryAttributes": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Represents the attributes of an existing CodeArtifact repository." }, "fqn": "@open-constructs/aws-cdk.aws_codeartifact.RepositoryAttributes", "kind": "interface", "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 279 }, "name": "RepositoryAttributes", "namespace": "aws_codeartifact", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The CodeArtifact domain associated with this repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 291 }, "name": "domain", "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.IDomain" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The ARN (Amazon Resource Name) of the CodeArtifact repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 283 }, "name": "repositoryArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the CodeArtifact repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 287 }, "name": "repositoryName", "type": { "primitive": "string" } } ], "symbolId": "src/aws-codeartifact/repository:RepositoryAttributes" }, "@open-constructs/aws-cdk.aws_codeartifact.RepositoryConnection": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Represents the supported external connections for CodeArtifact repositories." }, "fqn": "@open-constructs/aws-cdk.aws_codeartifact.RepositoryConnection", "kind": "enum", "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 32 }, "members": [ { "docs": { "stability": "stable", "summary": "Python Package Index (PyPI)." }, "name": "PYTHON" }, { "docs": { "stability": "stable", "summary": "Node Package Manager (npm)." }, "name": "NPM" }, { "docs": { "stability": "stable", "summary": "NuGet Gallery." }, "name": "NUGET" }, { "docs": { "stability": "stable", "summary": "RubyGems." }, "name": "RUBY" }, { "docs": { "stability": "stable", "summary": "Crates.io (Rust)." }, "name": "RUST" }, { "docs": { "stability": "stable", "summary": "Maven Central Repository." }, "name": "MAVEN_CENTRAL" }, { "docs": { "stability": "stable", "summary": "Gradle Plugins." }, "name": "GRADLE_PLUGINS" }, { "docs": { "stability": "stable", "summary": "Maven Google." }, "name": "MAVEN_GOOGLE" }, { "docs": { "stability": "stable", "summary": "Maven Apache." }, "name": "MAVEN_APACHE" }, { "docs": { "stability": "stable", "summary": "Maven Atlassian." }, "name": "MAVEN_ATLASSIAN" }, { "docs": { "stability": "stable", "summary": "Maven Eclipse." }, "name": "MAVEN_ECLIPSE" }, { "docs": { "stability": "stable", "summary": "Maven JBoss." }, "name": "MAVEN_JBOSS" }, { "docs": { "stability": "stable", "summary": "Maven Spring." }, "name": "MAVEN_SPRING" }, { "docs": { "stability": "stable", "summary": "Maven Spring Plugins." }, "name": "MAVEN_SPRING_PLUGINS" } ], "name": "RepositoryConnection", "namespace": "aws_codeartifact", "symbolId": "src/aws-codeartifact/repository:RepositoryConnection" }, "@open-constructs/aws-cdk.aws_codeartifact.RepositoryProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for creating a new CodeArtifact repository." }, "fqn": "@open-constructs/aws-cdk.aws_codeartifact.RepositoryProps", "kind": "interface", "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 135 }, "name": "RepositoryProps", "namespace": "aws_codeartifact", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The domain that contains the repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 145 }, "name": "domain", "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.IDomain" } }, { "abstract": true, "docs": { "default": "- No description", "stability": "stable", "summary": "The description of the repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 151 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No external connections", "remarks": "You can use the AWS CLI to connect your CodeArtifact repository to an external repository by adding an external connection directly to the repository.\nThis will allow users connected to the CodeArtifact repository, or any of its downstream repositories, to fetch packages from the configured external repository.\nEach CodeArtifact repository can only have one external connection.", "stability": "stable", "summary": "The connections to external repositories (like npmjs, pypi, etc.)." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 161 }, "name": "externalConnection", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.RepositoryConnection" } }, { "abstract": true, "docs": { "default": "- A name is automatically generated", "stability": "stable", "summary": "The name of the repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 141 }, "name": "repositoryName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No upstream repositories", "remarks": "The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version.\nsee https://docs.aws.amazon.com/codeartifact/latest/ug/repo-upstream-behavior.html#package-retention-intermediate-repositories", "stability": "stable", "summary": "A list of upstream Codeartifact repositories to associate with the repository." }, "immutable": true, "locationInModule": { "filename": "src/aws-codeartifact/repository.ts", "line": 169 }, "name": "upstreams", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@open-constructs/aws-cdk.aws_codeartifact.IRepository" }, "kind": "array" } } } ], "symbolId": "src/aws-codeartifact/repository:RepositoryProps" }, "@open-constructs/aws-cdk.aws_cur.CostReport": { "assembly": "@open-constructs/aws-cdk", "base": "aws-cdk-lib.Resource", "docs": { "example": "const report = new CostReport(stack, 'MyReport', {\n costReportName: 'business-report',\n reportGranularity: ReportGranularity.MONTHLY,\n format: CurFormat.PARQUET\n});", "remarks": "This class creates an AWS Cost and Usage Report, stored in an S3 bucket, and configures the necessary permissions.", "stability": "stable", "summary": "Represents a Cost Report construct in AWS CDK." }, "fqn": "@open-constructs/aws-cdk.aws_cur.CostReport", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 123 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_cur.CostReportProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 117 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 199 }, "name": "createReportBucket", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_s3.BucketProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_s3.IBucket" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 203 }, "name": "createReportDefinition", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_cur.CfnReportDefinitionProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_cur.CfnReportDefinition" } } } ], "name": "CostReport", "namespace": "aws_cur", "properties": [ { "docs": { "stability": "stable", "summary": "The name of the cost report." }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 121 }, "name": "costReportName", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The S3 bucket that stores the cost report." }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 119 }, "name": "reportBucket", "type": { "fqn": "aws-cdk-lib.aws_s3.IBucket" } } ], "symbolId": "src/aws-cur/cost-report:CostReport" }, "@open-constructs/aws-cdk.aws_cur.CostReportProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for defining a Cost and Usage Report." }, "fqn": "@open-constructs/aws-cdk.aws_cur.CostReportProps", "kind": "interface", "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 57 }, "name": "CostReportProps", "namespace": "aws_cur", "properties": [ { "abstract": true, "docs": { "default": "- a new bucket will be created.", "remarks": "If non is provided, a new bucket will be created.", "stability": "stable", "summary": "The bucket to place the cost report into." }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 89 }, "name": "bucket", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_s3.IBucket" } }, { "abstract": true, "docs": { "default": "- a unique name automatically generated if `enableDefaultUniqueReportName` is\ntrue, otherwise 'default-cur'.", "remarks": "The name must be unique, is case sensitive, and can't include spaces.\n\nThe length of this name must be between 1 and 256.", "stability": "stable", "summary": "The name of the cost report." }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 81 }, "name": "costReportName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "The default value of the `costReportName` is normally ‘default-cur’, but setting this flag\nto true will generate a unique default value.\n\nThis flag is ignored if the `costReportName` property is specified.", "stability": "stable", "summary": "Whether to generate a unique report name automatically if the `costReportName` property is not specified." }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 69 }, "name": "enableDefaultUniqueReportName", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- TEXT_OR_CSV", "stability": "stable", "summary": "The format to use for the cost and usage report." }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 96 }, "name": "format", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_cur.CurFormat" } }, { "abstract": true, "docs": { "default": "- HOURLY", "stability": "stable", "summary": "The granularity of the line items in the report." }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 103 }, "name": "reportGranularity", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_cur.ReportGranularity" } } ], "symbolId": "src/aws-cur/cost-report:CostReportProps" }, "@open-constructs/aws-cdk.aws_cur.CurFormat": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Enum for the possible formats of a cost report." }, "fqn": "@open-constructs/aws-cdk.aws_cur.CurFormat", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 48 }, "parameters": [ { "name": "compression", "type": { "primitive": "string" } }, { "name": "format", "type": { "primitive": "string" } } ], "protected": true }, "kind": "class", "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 31 }, "methods": [ { "docs": { "returns": "A CurFormat instance.", "stability": "stable", "summary": "Returns a CurFormat instance for the given compression and format string values." }, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 44 }, "name": "for", "parameters": [ { "docs": { "summary": "- The compression string value." }, "name": "compression", "type": { "primitive": "string" } }, { "docs": { "summary": "- The format string value." }, "name": "format", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_cur.CurFormat" } }, "static": true } ], "name": "CurFormat", "namespace": "aws_cur", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "Parquet format." }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 35 }, "name": "PARQUET", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_cur.CurFormat" } }, { "const": true, "docs": { "stability": "stable", "summary": "GZIP compressed text or CSV format." }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 33 }, "name": "TEXT_OR_CSV", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_cur.CurFormat" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 49 }, "name": "compression", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 50 }, "name": "format", "type": { "primitive": "string" } } ], "symbolId": "src/aws-cur/cost-report:CurFormat" }, "@open-constructs/aws-cdk.aws_cur.ReportGranularity": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Enum for the possible granularities of a cost report." }, "fqn": "@open-constructs/aws-cdk.aws_cur.ReportGranularity", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 25 }, "parameters": [ { "name": "value", "type": { "primitive": "string" } } ], "protected": true }, "kind": "class", "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 7 }, "methods": [ { "docs": { "returns": "A ReportGranularity instance.", "stability": "stable", "summary": "Returns a ReportGranularity instance for the given granularity string value." }, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 21 }, "name": "for", "parameters": [ { "docs": { "summary": "- The granularity string value to create an instance for." }, "name": "granularity", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_cur.ReportGranularity" } }, "static": true } ], "name": "ReportGranularity", "namespace": "aws_cur", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "Daily granularity." }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 11 }, "name": "DAILY", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_cur.ReportGranularity" } }, { "const": true, "docs": { "stability": "stable", "summary": "Hourly granularity." }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 9 }, "name": "HOURLY", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_cur.ReportGranularity" } }, { "const": true, "docs": { "stability": "stable", "summary": "Weekly granularity." }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 13 }, "name": "MONTHLY", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_cur.ReportGranularity" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/aws-cur/cost-report.ts", "line": 25 }, "name": "value", "type": { "primitive": "string" } } ], "symbolId": "src/aws-cur/cost-report:ReportGranularity" }, "@open-constructs/aws-cdk.aws_ec2.IInstanceConnectEndpoint": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "An EC2 Instance Connect Endpoint." }, "fqn": "@open-constructs/aws-cdk.aws_ec2.IInstanceConnectEndpoint", "interfaces": [ "aws-cdk-lib.aws_ec2.IConnectable", "aws-cdk-lib.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 7 }, "name": "IInstanceConnectEndpoint", "namespace": "aws_ec2", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ID of the EC2 Instance Connect Endpoint." }, "immutable": true, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 13 }, "name": "instanceConnectEndpointId", "type": { "primitive": "string" } } ], "symbolId": "src/aws-ec2/instance-connect-endpoint:IInstanceConnectEndpoint" }, "@open-constructs/aws-cdk.aws_ec2.InstanceConnectEndpoint": { "assembly": "@open-constructs/aws-cdk", "base": "aws-cdk-lib.Resource", "docs": { "example": "declare const securityGroups: aws_ec2.ISecurityGroup[];\ndeclare const vpc: aws_ec2.IVpc;\n\nconst instanceConnectEndpoint = new InstanceConnectEndpoint(\n stack,\n 'InstanceConnectEndpoint',\n {\n clientToken: 'my-client-token',\n preserveClientIp: true,\n securityGroups,\n vpc,\n },\n);", "stability": "stable", "summary": "Represents an EC2 Instance Connect Endpoint construct in AWS CDK." }, "fqn": "@open-constructs/aws-cdk.aws_ec2.InstanceConnectEndpoint", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 113 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_ec2.InstanceConnectEndpointProps" } } ] }, "interfaces": [ "@open-constructs/aws-cdk.aws_ec2.IInstanceConnectEndpoint" ], "kind": "class", "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 81 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing endpoint to the stack from its attributes." }, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 85 }, "name": "fromInstanceConnectEndpointAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@open-constructs/aws-cdk.aws_ec2.InstanceConnectEndpointAttributes" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_ec2.IInstanceConnectEndpoint" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 128 }, "name": "createInstanceConnectEndpoint", "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_ec2.CfnInstanceConnectEndpoint" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 137 }, "name": "createSecurityGroup", "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_ec2.SecurityGroup" } } } ], "name": "InstanceConnectEndpoint", "namespace": "aws_ec2", "properties": [ { "docs": { "stability": "stable", "summary": "The connection object associated with the EC2 Instance Connect Endpoint." }, "immutable": true, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 108 }, "name": "connections", "overrides": "aws-cdk-lib.aws_ec2.IConnectable", "type": { "fqn": "aws-cdk-lib.aws_ec2.Connections" } }, { "docs": { "stability": "stable", "summary": "The ID of the EC2 Instance Connect Endpoint." }, "immutable": true, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 103 }, "name": "instanceConnectEndpointId", "overrides": "@open-constructs/aws-cdk.aws_ec2.IInstanceConnectEndpoint", "type": { "primitive": "string" } } ], "symbolId": "src/aws-ec2/instance-connect-endpoint:InstanceConnectEndpoint" }, "@open-constructs/aws-cdk.aws_ec2.InstanceConnectEndpointAttributes": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Attributes for importing an EC2 Instance Connect Endpoint." }, "fqn": "@open-constructs/aws-cdk.aws_ec2.InstanceConnectEndpointAttributes", "kind": "interface", "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 51 }, "name": "InstanceConnectEndpointAttributes", "namespace": "aws_ec2", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ID of the EC2 Instance Connect Endpoint." }, "immutable": true, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 55 }, "name": "instanceConnectEndpointId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The security groups associated with the EC2 Instance Connect Endpoint." }, "immutable": true, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 60 }, "name": "securityGroups", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup" }, "kind": "array" } } } ], "symbolId": "src/aws-ec2/instance-connect-endpoint:InstanceConnectEndpointAttributes" }, "@open-constructs/aws-cdk.aws_ec2.InstanceConnectEndpointProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for defining an EC2 Instance Connect Endpoint." }, "fqn": "@open-constructs/aws-cdk.aws_ec2.InstanceConnectEndpointProps", "kind": "interface", "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 19 }, "name": "InstanceConnectEndpointProps", "namespace": "aws_ec2", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The VPC in which the EC2 Instance Connect Endpoint is created." }, "immutable": true, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 45 }, "name": "vpc", "type": { "fqn": "aws-cdk-lib.aws_ec2.IVpc" } }, { "abstract": true, "docs": { "see": "https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-clienttoken", "stability": "stable", "summary": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request." }, "immutable": true, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 25 }, "name": "clientToken", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "see": "https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-preserveclientip", "stability": "stable", "summary": "Indicates whether your client's IP address is preserved as the source." }, "immutable": true, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 33 }, "name": "preserveClientIp", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- a new security group is created", "stability": "stable", "summary": "The security groups to associate with the EC2 Instance Connect Endpoint." }, "immutable": true, "locationInModule": { "filename": "src/aws-ec2/instance-connect-endpoint.ts", "line": 40 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup" }, "kind": "array" } } } ], "symbolId": "src/aws-ec2/instance-connect-endpoint:InstanceConnectEndpointProps" }, "@open-constructs/aws-cdk.aws_elasticache.BaseUserProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for all user types." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.BaseUserProps", "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 40 }, "name": "BaseUserProps", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "default": "- 'off -@all'", "see": "https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Clusters.RBAC.html#Access-string", "stability": "stable", "summary": "Access permissions string used for this user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 54 }, "name": "accessString", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- auto generated", "remarks": "Must consist only of alphanumeric characters or hyphens, with the first character as a letter.\nCannot end with a hyphen or contain two consecutive hyphens.", "stability": "stable", "summary": "The ID of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 47 }, "name": "userId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user:BaseUserProps" }, "@open-constructs/aws-cdk.aws_elasticache.CacheUsageLimits": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "The usage limits for storage and ElastiCache Processing Units for the cache." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.CacheUsageLimits", "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 388 }, "name": "CacheUsageLimits", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "default": "- no limits", "stability": "stable", "summary": "The data storage limit." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 394 }, "name": "dataStorage", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.DataStorage" } }, { "abstract": true, "docs": { "default": "- no limits", "stability": "stable", "summary": "The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 401 }, "name": "ecpuPerSecond", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.ECPUPerSecond" } } ], "symbolId": "src/aws-elasticache/serverless-cache:CacheUsageLimits" }, "@open-constructs/aws-cdk.aws_elasticache.DailySnapshotTime": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Class for scheduling a daily snapshot time." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.DailySnapshotTime", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-elasticache/daily-snapshot-time.ts", "line": 33 }, "parameters": [ { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.DailySnapshotTimeProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/aws-elasticache/daily-snapshot-time.ts", "line": 18 }, "methods": [ { "docs": { "stability": "stable", "summary": "Converts an hour, and minute into HH:MM string." }, "locationInModule": { "filename": "src/aws-elasticache/daily-snapshot-time.ts", "line": 42 }, "name": "toTimestamp", "returns": { "type": { "primitive": "string" } } } ], "name": "DailySnapshotTime", "namespace": "aws_elasticache", "symbolId": "src/aws-elasticache/daily-snapshot-time:DailySnapshotTime" }, "@open-constructs/aws-cdk.aws_elasticache.DailySnapshotTimeProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties required for setting up a daily snapshot time." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.DailySnapshotTimeProps", "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/daily-snapshot-time.ts", "line": 4 }, "name": "DailySnapshotTimeProps", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The hour of the day (from 0-23) for snapshot starts." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/daily-snapshot-time.ts", "line": 8 }, "name": "hour", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The minute of the hour (from 0-59) for snapshot starts." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/daily-snapshot-time.ts", "line": 12 }, "name": "minute", "type": { "primitive": "number" } } ], "symbolId": "src/aws-elasticache/daily-snapshot-time:DailySnapshotTimeProps" }, "@open-constructs/aws-cdk.aws_elasticache.DataStorage": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "The data storage limit." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.DataStorage", "kind": "class", "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 52 }, "methods": [ { "docs": { "stability": "stable", "summary": "Creates data storage settings with gigabytes as the unit." }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 57 }, "name": "gb", "parameters": [ { "docs": { "summary": "The configuration options containing min and/or max values." }, "name": "options", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.DataStorageOptions" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.DataStorage" } }, "static": true } ], "name": "DataStorage", "namespace": "aws_elasticache", "properties": [ { "docs": { "stability": "stable", "summary": "The unit of the storage sizes." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 74 }, "name": "unit", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.StorageUnit" } }, { "docs": { "stability": "stable", "summary": "The upper limit for data storage the cache is set to use." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 69 }, "name": "maximum", "optional": true, "type": { "primitive": "number" } }, { "docs": { "stability": "stable", "summary": "The lower limit for data storage the cache is set to use." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 64 }, "name": "minimum", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/aws-elasticache/serverless-cache:DataStorage" }, "@open-constructs/aws-cdk.aws_elasticache.DataStorageOptions": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Interface for configuring data storage limits." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.DataStorageOptions", "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 33 }, "name": "DataStorageOptions", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "default": "- no upper limit", "stability": "stable", "summary": "The upper limit for data storage the cache is set to use." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 46 }, "name": "maximum", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no lower limit", "stability": "stable", "summary": "The lower limit for data storage the cache is set to use." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 39 }, "name": "minimum", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/aws-elasticache/serverless-cache:DataStorageOptions" }, "@open-constructs/aws-cdk.aws_elasticache.ECPUPerSecond": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.ECPUPerSecond", "kind": "class", "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 139 }, "methods": [ { "docs": { "stability": "stable", "summary": "Creates ECPU per second settings." }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 145 }, "name": "of", "parameters": [ { "docs": { "summary": "The configuration options containing min and/or max values." }, "name": "options", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.ECPUPerSecondOptions" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.ECPUPerSecond" } }, "static": true } ], "name": "ECPUPerSecond", "namespace": "aws_elasticache", "properties": [ { "docs": { "stability": "stable", "summary": "The configuration for the maximum number of ECPUs the cache can consume per second." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 157 }, "name": "maximum", "optional": true, "type": { "primitive": "number" } }, { "docs": { "stability": "stable", "summary": "The configuration for the minimum number of ECPUs the cache should be able consume per second." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 152 }, "name": "minimum", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/aws-elasticache/serverless-cache:ECPUPerSecond" }, "@open-constructs/aws-cdk.aws_elasticache.ECPUPerSecondOptions": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Interface for configuring ECPU per second limits." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.ECPUPerSecondOptions", "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 120 }, "name": "ECPUPerSecondOptions", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "default": "- no maximum configuration", "stability": "stable", "summary": "The configuration for the maximum number of ECPUs the cache can consume per second." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 133 }, "name": "maximum", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no minimum configuration", "stability": "stable", "summary": "The configuration for the minimum number of ECPUs the cache should be able consume per second." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 126 }, "name": "minimum", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/aws-elasticache/serverless-cache:ECPUPerSecondOptions" }, "@open-constructs/aws-cdk.aws_elasticache.Engine": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "The engine the cache uses." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.Engine", "kind": "enum", "locationInModule": { "filename": "src/aws-elasticache/util.ts", "line": 4 }, "members": [ { "docs": { "stability": "stable", "summary": "Redis." }, "name": "REDIS" }, { "docs": { "stability": "stable", "summary": "Valkey." }, "name": "VALKEY" }, { "docs": { "stability": "stable", "summary": "Memcached." }, "name": "MEMCACHED" } ], "name": "Engine", "namespace": "aws_elasticache", "symbolId": "src/aws-elasticache/util:Engine" }, "@open-constructs/aws-cdk.aws_elasticache.IIamUser": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Interface for IAM-enabled users." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.IIamUser", "interfaces": [ "@open-constructs/aws-cdk.aws_elasticache.IUser" ], "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 164 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Grant permissions to this user." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 168 }, "name": "grant", "parameters": [ { "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } }, { "name": "actions", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } }, "variadic": true }, { "abstract": true, "docs": { "stability": "stable", "summary": "Grant connect permissions to this user." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 173 }, "name": "grantConnect", "parameters": [ { "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } } } ], "name": "IIamUser", "namespace": "aws_elasticache", "symbolId": "src/aws-elasticache/user:IIamUser" }, "@open-constructs/aws-cdk.aws_elasticache.INoPasswordRequiredUser": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Interface for no password required users." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.INoPasswordRequiredUser", "interfaces": [ "@open-constructs/aws-cdk.aws_elasticache.IUser" ], "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 417 }, "name": "INoPasswordRequiredUser", "namespace": "aws_elasticache", "symbolId": "src/aws-elasticache/user:INoPasswordRequiredUser" }, "@open-constructs/aws-cdk.aws_elasticache.IPasswordUser": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Interface for password-authenticated users." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.IPasswordUser", "interfaces": [ "@open-constructs/aws-cdk.aws_elasticache.IUser" ], "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 281 }, "name": "IPasswordUser", "namespace": "aws_elasticache", "symbolId": "src/aws-elasticache/user:IPasswordUser" }, "@open-constructs/aws-cdk.aws_elasticache.IServerlessCache": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Interface for an ElastiCache Serverless Cache." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.IServerlessCache", "interfaces": [ "aws-cdk-lib.IResource", "aws-cdk-lib.aws_ec2.IConnectable" ], "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 201 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Grant the given identity the specified actions." }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 231 }, "name": "grant", "parameters": [ { "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } }, { "name": "actions", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } }, "variadic": true }, { "abstract": true, "docs": { "stability": "stable", "summary": "Grant the given identity connection access to the cache." }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 236 }, "name": "grantConnect", "parameters": [ { "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Create a CloudWatch metric." }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 241 }, "name": "metric", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } } ], "name": "IServerlessCache", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The DNS hostname of the cache node." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 219 }, "name": "endpointAddress", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The port number that the cache engine is listening on." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 226 }, "name": "endpointPort", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The serverless cache ARN." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 207 }, "name": "serverlessCacheArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The serverless cache name." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 212 }, "name": "serverlessCacheName", "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/serverless-cache:IServerlessCache" }, "@open-constructs/aws-cdk.aws_elasticache.IUser": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Interface for a User." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.IUser", "interfaces": [ "aws-cdk-lib.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 20 }, "name": "IUser", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 26 }, "name": "userArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The ID of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 30 }, "name": "userId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 34 }, "name": "userName", "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user:IUser" }, "@open-constructs/aws-cdk.aws_elasticache.IUserGroup": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Interface for a User Group." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.IUserGroup", "interfaces": [ "aws-cdk-lib.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 9 }, "name": "IUserGroup", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the user group." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 15 }, "name": "userGroupArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The ID of the user group." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 19 }, "name": "userGroupId", "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user-group:IUserGroup" }, "@open-constructs/aws-cdk.aws_elasticache.IamUser": { "assembly": "@open-constructs/aws-cdk", "base": "aws-cdk-lib.Resource", "docs": { "example": "const user = new IamUser(\n stack,\n 'User',\n {\n accessString: 'on ~* +@all',\n },\n);", "stability": "stable", "summary": "Represents an IAM-enabled user construct in AWS CDK." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.IamUser", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 224 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.IamUserProps" } } ] }, "interfaces": [ "@open-constructs/aws-cdk.aws_elasticache.IIamUser", "@open-constructs/aws-cdk.aws_elasticache.IUser" ], "kind": "class", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 194 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports an existing IAM-enabled user from userId." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 198 }, "name": "fromUserId", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "userId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.IIamUser" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 104 }, "name": "createResource", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_elasticache.CfnUserProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_elasticache.CfnUser" } } }, { "docs": { "see": "https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonelasticache.html", "stability": "stable", "summary": "Grant the given identity the specified actions." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 250 }, "name": "grant", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IIamUser", "parameters": [ { "docs": { "summary": "the identity to be granted the actions." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } }, { "docs": { "summary": "the data-access actions." }, "name": "actions", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } }, "variadic": true }, { "docs": { "remarks": "Actions: Connect", "see": "https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html", "stability": "stable", "summary": "Permits an IAM principal to perform connect to the user." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 273 }, "name": "grantConnect", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IIamUser", "parameters": [ { "docs": { "summary": "The principal to grant access to." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } } }, { "docs": { "stability": "stable", "summary": "Render authenticationMode property." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 237 }, "name": "renderAuthenticationMode", "protected": true, "returns": { "type": { "primitive": "any" } } }, { "docs": { "see": "https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html", "stability": "stable", "summary": "For IAM-enabled ElastiCache users the username and user id properties must be identical." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 233 }, "name": "renderUserName", "protected": true, "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "stable", "summary": "Validates user id." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 121 }, "name": "validateUserId", "parameters": [ { "name": "userId", "optional": true, "type": { "primitive": "string" } } ], "protected": true }, { "docs": { "stability": "stable", "summary": "Validates username." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 146 }, "name": "validateUserName", "parameters": [ { "name": "userName", "optional": true, "type": { "primitive": "string" } } ], "protected": true } ], "name": "IamUser", "namespace": "aws_elasticache", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 76 }, "name": "props", "protected": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.BaseUserProps" } }, { "docs": { "stability": "stable", "summary": "The ARN of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 64 }, "name": "userArn", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IUser", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The ID of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 69 }, "name": "userId", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IUser", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The name of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 74 }, "name": "userName", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IUser", "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user:IamUser" }, "@open-constructs/aws-cdk.aws_elasticache.IamUserProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for IAM-enabled users." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.IamUserProps", "interfaces": [ "@open-constructs/aws-cdk.aws_elasticache.BaseUserProps" ], "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 179 }, "name": "IamUserProps", "namespace": "aws_elasticache", "symbolId": "src/aws-elasticache/user:IamUserProps" }, "@open-constructs/aws-cdk.aws_elasticache.MajorVersion": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "The version number of the engine the serverless cache is compatible with." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.MajorVersion", "kind": "enum", "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 247 }, "members": [ { "docs": { "stability": "stable", "summary": "Version 7." }, "name": "VER_7" }, { "docs": { "stability": "stable", "summary": "Version 8." }, "name": "VER_8" } ], "name": "MajorVersion", "namespace": "aws_elasticache", "symbolId": "src/aws-elasticache/serverless-cache:MajorVersion" }, "@open-constructs/aws-cdk.aws_elasticache.NoPasswordRequiredUser": { "assembly": "@open-constructs/aws-cdk", "base": "aws-cdk-lib.Resource", "docs": { "example": "const user = new NoPasswordRequiredUser(\n stack,\n 'User',\n {\n userName: 'my-user',\n accessString: 'on ~* +@all',\n },\n);", "stability": "stable", "summary": "Represents a no password required user construct in AWS CDK." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.NoPasswordRequiredUser", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 480 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.NoPasswordRequiredUserProps" } } ] }, "interfaces": [ "@open-constructs/aws-cdk.aws_elasticache.INoPasswordRequiredUser", "@open-constructs/aws-cdk.aws_elasticache.IUser" ], "kind": "class", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 458 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports an existing no password required user from attributes." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 462 }, "name": "fromUserAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.NoPasswordUserAttributes" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.INoPasswordRequiredUser" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 104 }, "name": "createResource", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_elasticache.CfnUserProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_elasticache.CfnUser" } } }, { "docs": { "stability": "stable", "summary": "Render authenticationMode property." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 490 }, "name": "renderAuthenticationMode", "protected": true, "returns": { "type": { "primitive": "any" } } }, { "docs": { "stability": "stable", "summary": "Render userName property." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 486 }, "name": "renderUserName", "protected": true, "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "stable", "summary": "Validates user id." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 121 }, "name": "validateUserId", "parameters": [ { "name": "userId", "optional": true, "type": { "primitive": "string" } } ], "protected": true }, { "docs": { "stability": "stable", "summary": "Validates username." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 146 }, "name": "validateUserName", "parameters": [ { "name": "userName", "optional": true, "type": { "primitive": "string" } } ], "protected": true } ], "name": "NoPasswordRequiredUser", "namespace": "aws_elasticache", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 76 }, "name": "props", "protected": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.BaseUserProps" } }, { "docs": { "stability": "stable", "summary": "The ARN of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 64 }, "name": "userArn", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IUser", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The ID of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 69 }, "name": "userId", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IUser", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The name of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 74 }, "name": "userName", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IUser", "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user:NoPasswordRequiredUser" }, "@open-constructs/aws-cdk.aws_elasticache.NoPasswordRequiredUserProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for no password required users." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.NoPasswordRequiredUserProps", "interfaces": [ "@open-constructs/aws-cdk.aws_elasticache.BaseUserProps" ], "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 436 }, "name": "NoPasswordRequiredUserProps", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "default": "- same as userId", "stability": "stable", "summary": "The username of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 441 }, "name": "userName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user:NoPasswordRequiredUserProps" }, "@open-constructs/aws-cdk.aws_elasticache.NoPasswordUserAttributes": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Attributes for importing a no password required user." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.NoPasswordUserAttributes", "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 422 }, "name": "NoPasswordUserAttributes", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ID of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 426 }, "name": "userId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 430 }, "name": "userName", "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user:NoPasswordUserAttributes" }, "@open-constructs/aws-cdk.aws_elasticache.PasswordUser": { "assembly": "@open-constructs/aws-cdk", "base": "aws-cdk-lib.Resource", "docs": { "example": "const user = new PasswordUser(\n stack,\n 'User',\n {\n passwords: [\n cdk.SecretValue.unsafePlainText('exampleUserPassword123'),\n cdk.SecretValue.unsafePlainText('anotherUserPassword123'),\n ],\n },\n);", "stability": "stable", "summary": "Represents a password authentication user construct in AWS CDK." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.PasswordUser", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 352 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.PasswordUserProps" } } ] }, "interfaces": [ "@open-constructs/aws-cdk.aws_elasticache.IPasswordUser", "@open-constructs/aws-cdk.aws_elasticache.IUser" ], "kind": "class", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 332 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports an existing password authentication user from attributes." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 336 }, "name": "fromUserAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.PasswordUserAttributes" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.IPasswordUser" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 104 }, "name": "createResource", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_elasticache.CfnUserProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_elasticache.CfnUser" } } }, { "docs": { "stability": "stable", "summary": "Render authenticationMode property." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 366 }, "name": "renderAuthenticationMode", "protected": true, "returns": { "type": { "primitive": "any" } } }, { "docs": { "stability": "stable", "summary": "Render userName property." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 362 }, "name": "renderUserName", "protected": true, "returns": { "type": { "primitive": "string" } } }, { "docs": { "stability": "stable", "summary": "Validates user id." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 121 }, "name": "validateUserId", "parameters": [ { "name": "userId", "optional": true, "type": { "primitive": "string" } } ], "protected": true }, { "docs": { "stability": "stable", "summary": "Validates username." }, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 146 }, "name": "validateUserName", "parameters": [ { "name": "userName", "optional": true, "type": { "primitive": "string" } } ], "protected": true } ], "name": "PasswordUser", "namespace": "aws_elasticache", "properties": [ { "docs": { "remarks": "Throws an exception if `passwords` is provided in the props", "stability": "stable", "summary": "The secret containing the generated password." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 406 }, "name": "generatedSecret", "type": { "fqn": "aws-cdk-lib.aws_secretsmanager.ISecret" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 76 }, "name": "props", "protected": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.BaseUserProps" } }, { "docs": { "stability": "stable", "summary": "The ARN of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 64 }, "name": "userArn", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IUser", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The ID of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 69 }, "name": "userId", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IUser", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The name of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 74 }, "name": "userName", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IUser", "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user:PasswordUser" }, "@open-constructs/aws-cdk.aws_elasticache.PasswordUserAttributes": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Attributes for importing a password-authenticated user." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.PasswordUserAttributes", "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 286 }, "name": "PasswordUserAttributes", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ID of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 290 }, "name": "userId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 294 }, "name": "userName", "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user:PasswordUserAttributes" }, "@open-constructs/aws-cdk.aws_elasticache.PasswordUserProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for password-authenticated users." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.PasswordUserProps", "interfaces": [ "@open-constructs/aws-cdk.aws_elasticache.BaseUserProps" ], "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 300 }, "name": "PasswordUserProps", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "default": "- automatically generate a password for the user", "remarks": "You can create up to two passwords for each user.", "stability": "stable", "summary": "Passwords used for this user account." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 313 }, "name": "passwords", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.SecretValue" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- same as userId", "stability": "stable", "summary": "The username of the user." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user.ts", "line": 305 }, "name": "userName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user:PasswordUserProps" }, "@open-constructs/aws-cdk.aws_elasticache.ServerlessCache": { "assembly": "@open-constructs/aws-cdk", "base": "aws-cdk-lib.Resource", "docs": { "example": "declare const vpc: aws_ec2.IVpc;\n\nconst serverlessCache = new ServerlessCache(\n stack,\n 'ServerlessCache',\n {\n serverlessCacheName: 'my-serverlessCache',\n engine: Engine.VALKEY,\n vpc,\n },\n);", "stability": "stable", "summary": "Represents an ElastiCache Serverless Cache construct in AWS CDK." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.ServerlessCache", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 574 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.ServerlessCacheProps" } } ] }, "interfaces": [ "@open-constructs/aws-cdk.aws_elasticache.IServerlessCache" ], "kind": "class", "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 547 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports an existing ServerlessCache from attributes." }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 411 }, "name": "fromServerlessCacheAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.ServerlessCacheAttributes" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.IServerlessCache" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 629 }, "name": "createResource", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_elasticache.CfnServerlessCacheProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_elasticache.CfnServerlessCache" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 637 }, "name": "createSecurityGroup", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_ec2.SecurityGroupProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_ec2.SecurityGroup" } } }, { "docs": { "see": "https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonelasticache.html", "stability": "stable", "summary": "Grant the given identity the specified actions." }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 465 }, "name": "grant", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IServerlessCache", "parameters": [ { "docs": { "summary": "the identity to be granted the actions." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } }, { "docs": { "summary": "the data-access actions." }, "name": "actions", "type": { "primitive": "string" }, "variadic": true } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } }, "variadic": true }, { "docs": { "remarks": "Actions: Connect", "see": "https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/auth-iam.html", "stability": "stable", "summary": "Permits an IAM principal to perform connect to the serverless cache." }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 488 }, "name": "grantConnect", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IServerlessCache", "parameters": [ { "docs": { "summary": "The principal to grant access to." }, "name": "grantee", "type": { "fqn": "aws-cdk-lib.aws_iam.IGrantable" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_iam.Grant" } } }, { "docs": { "see": "https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/serverless-metrics-events.memcached.html", "stability": "stable", "summary": "Create a CloudWatch metric for serverless cache." }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 501 }, "name": "metric", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IServerlessCache", "parameters": [ { "docs": { "summary": "name of the metric." }, "name": "metricName", "type": { "primitive": "string" } }, { "docs": { "summary": "metric options." }, "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- average over 5 minutes", "stability": "stable", "summary": "Metric for the total number of bytes used by the data stored in your cache." }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 517 }, "name": "metricBytesUsedForCache", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } }, { "docs": { "default": "- average over 5 minutes", "stability": "stable", "summary": "Metric for the total number of ElastiCacheProcessingUnits (ECPUs) consumed by the requests executed on your cache." }, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 526 }, "name": "metricElastiCacheProcessingUnits", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_cloudwatch.Metric" } } } ], "name": "ServerlessCache", "namespace": "aws_elasticache", "properties": [ { "docs": { "stability": "stable", "summary": "The connection object associated with the ElastiCache Serverless Cache." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 568 }, "name": "connections", "overrides": "aws-cdk-lib.aws_ec2.IConnectable", "type": { "fqn": "aws-cdk-lib.aws_ec2.Connections" } }, { "docs": { "stability": "stable", "summary": "The DNS hostname of the cache node." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 559 }, "name": "endpointAddress", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IServerlessCache", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The port number that the cache engine is listening on." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 563 }, "name": "endpointPort", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IServerlessCache", "type": { "primitive": "number" } }, { "docs": { "stability": "stable", "summary": "The serverless cache ARN." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 551 }, "name": "serverlessCacheArn", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IServerlessCache", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The serverless cache name." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 555 }, "name": "serverlessCacheName", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IServerlessCache", "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/serverless-cache:ServerlessCache" }, "@open-constructs/aws-cdk.aws_elasticache.ServerlessCacheAttributes": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Attributes for importing an ElastiCache Serverless Cache." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.ServerlessCacheAttributes", "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 366 }, "name": "ServerlessCacheAttributes", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The DNS hostname of the cache node." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 374 }, "name": "endpointAddress", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The port number that the cache engine is listening on." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 378 }, "name": "endpointPort", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The security groups to associate with the serverless cache." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 382 }, "name": "securityGroups", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The serverless cache name." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 370 }, "name": "serverlessCacheName", "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/serverless-cache:ServerlessCacheAttributes" }, "@open-constructs/aws-cdk.aws_elasticache.ServerlessCacheProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for defining an ElastiCache Serverless Cache." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.ServerlessCacheProps", "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 262 }, "name": "ServerlessCacheProps", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The engine the serverless cache is compatible with." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 266 }, "name": "engine", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.Engine" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The version number of the engine the serverless cache is compatible with." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 317 }, "name": "majorEngineVersion", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.MajorVersion" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The VPC to place the serverless cache in." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 346 }, "name": "vpc", "type": { "fqn": "aws-cdk-lib.aws_ec2.IVpc" } }, { "abstract": true, "docs": { "default": "- no limits.", "stability": "stable", "summary": "The usage limits for storage and ElastiCache Processing Units for the cache." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 281 }, "name": "cacheUsageLimits", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.CacheUsageLimits" } }, { "abstract": true, "docs": { "default": "- ElastiCache automatically assigns the backup window if \\`snapshotRetentionLimit\\` is set. Otherwise, no snapshots are taken.", "remarks": "This property must be set along with `snapshotRetentionLimit`.", "see": "https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-automatic.html", "stability": "stable", "summary": "The daily time when a cache snapshot will be created." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 290 }, "name": "dailySnapshotTime", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.DailySnapshotTime" } }, { "abstract": true, "docs": { "default": "- no description", "remarks": "The description can have up to 255 characters and must not contain < and > characters.", "stability": "stable", "summary": "A description of the serverless cache." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 298 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no final snapshot taken", "stability": "stable", "summary": "The name of the final snapshot taken of a cache before the cache is deleted." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 305 }, "name": "finalSnapshotName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- use AWS managed key", "stability": "stable", "summary": "The Customer Managed Key that is used to encrypt data at rest in the serverless cache." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 312 }, "name": "kmsKey", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_kms.IKey" } }, { "abstract": true, "docs": { "default": "- a new security group is created", "stability": "stable", "summary": "The security groups to associate with the serverless cache." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 324 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- auto generate", "remarks": "The name can have up to 40 characters, and must not contain spaces.", "stability": "stable", "summary": "The unique identifier of the serverless cache." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 274 }, "name": "serverlessCacheName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- not restored", "stability": "stable", "summary": "The ARN of the snapshot from which to restore data into the new cache." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 331 }, "name": "snapshotArnsToRestore", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no automatic backups", "remarks": "\\`snapshotRetentionLimit\\` must be between 1 and 35.", "stability": "stable", "summary": "The number of serverless cache snapshots the system will retain. To enable automatic backups, this property must be set." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 341 }, "name": "snapshotRetentionLimit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no user group associated", "remarks": "Available for Valkey and Redis OSS only.", "stability": "stable", "summary": "The user group associated with the serverless cache." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 360 }, "name": "userGroup", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.IUserGroup" } }, { "abstract": true, "docs": { "default": "- private subnets", "stability": "stable", "summary": "Where to place the serverless cache within the VPC." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 353 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_ec2.SubnetSelection" } } ], "symbolId": "src/aws-elasticache/serverless-cache:ServerlessCacheProps" }, "@open-constructs/aws-cdk.aws_elasticache.StorageUnit": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Storage unit for data storage in ElastiCache Serverless." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.StorageUnit", "kind": "enum", "locationInModule": { "filename": "src/aws-elasticache/serverless-cache.ts", "line": 23 }, "members": [ { "docs": { "stability": "stable", "summary": "Gigabytes." }, "name": "GB" } ], "name": "StorageUnit", "namespace": "aws_elasticache", "symbolId": "src/aws-elasticache/serverless-cache:StorageUnit" }, "@open-constructs/aws-cdk.aws_elasticache.UserGroup": { "assembly": "@open-constructs/aws-cdk", "base": "aws-cdk-lib.Resource", "docs": { "example": "declare const user: User;\n\nconst userGroup = new UserGroup(\n stack,\n 'UserGroup',\n {\n users: [user],\n },\n);", "stability": "stable", "summary": "Represents a user group construct in AWS CDK." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.UserGroup", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 101 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.UserGroupProps" } } ] }, "interfaces": [ "@open-constructs/aws-cdk.aws_elasticache.IUserGroup" ], "kind": "class", "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 70 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports an existing user group from attributes." }, "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 74 }, "name": "fromUserGroupId", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "userGroupId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.IUserGroup" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Adds a user to the user group." }, "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 206 }, "name": "addUser", "parameters": [ { "docs": { "summary": "the user to add." }, "name": "user", "type": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.IUser" } } ] }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 130 }, "name": "createResource", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_elasticache.CfnUserGroupProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_elasticache.CfnUserGroup" } } } ], "name": "UserGroup", "namespace": "aws_elasticache", "properties": [ { "docs": { "stability": "stable", "summary": "The ARN of the user group." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 90 }, "name": "userGroupArn", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IUserGroup", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The ID of the user group." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 95 }, "name": "userGroupId", "overrides": "@open-constructs/aws-cdk.aws_elasticache.IUserGroup", "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user-group:UserGroup" }, "@open-constructs/aws-cdk.aws_elasticache.UserGroupAttributes": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Attributes for importing a User Group." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.UserGroupAttributes", "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 49 }, "name": "UserGroupAttributes", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ID of the user group." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 53 }, "name": "userGroupId", "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user-group:UserGroupAttributes" }, "@open-constructs/aws-cdk.aws_elasticache.UserGroupProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for defining a User Group." }, "fqn": "@open-constructs/aws-cdk.aws_elasticache.UserGroupProps", "kind": "interface", "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 25 }, "name": "UserGroupProps", "namespace": "aws_elasticache", "properties": [ { "abstract": true, "docs": { "remarks": "A user with the username `default` must be included in `users`.", "stability": "stable", "summary": "The list of User that belong to the user group." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 43 }, "name": "users", "type": { "collection": { "elementtype": { "fqn": "@open-constructs/aws-cdk.aws_elasticache.IUser" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- auto generate", "remarks": "\\`userGroupId\\` can have up to 40 characters.\n\n\\`userGroupId\\` must consist only of alphanumeric characters or hyphens,\nwith the first character as a letter, and it can't end with a hyphen or contain two consecutive hyphens.", "stability": "stable", "summary": "The ID of the user group." }, "immutable": true, "locationInModule": { "filename": "src/aws-elasticache/user-group.ts", "line": 36 }, "name": "userGroupId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/aws-elasticache/user-group:UserGroupProps" }, "@open-constructs/aws-cdk.aws_fsx.DailyAutomaticBackupStartTime": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Class for scheduling a daily automatic backup time." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.DailyAutomaticBackupStartTime", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-fsx/daily-automatic-backup-start-time.ts", "line": 33 }, "parameters": [ { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.DailyAutomaticBackupStartTimeProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/aws-fsx/daily-automatic-backup-start-time.ts", "line": 18 }, "methods": [ { "docs": { "stability": "stable", "summary": "Converts an hour, and minute into HH:MM string." }, "locationInModule": { "filename": "src/aws-fsx/daily-automatic-backup-start-time.ts", "line": 42 }, "name": "toTimestamp", "returns": { "type": { "primitive": "string" } } } ], "name": "DailyAutomaticBackupStartTime", "namespace": "aws_fsx", "symbolId": "src/aws-fsx/daily-automatic-backup-start-time:DailyAutomaticBackupStartTime" }, "@open-constructs/aws-cdk.aws_fsx.DailyAutomaticBackupStartTimeProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties required for setting up a daily automatic backup time." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.DailyAutomaticBackupStartTimeProps", "kind": "interface", "locationInModule": { "filename": "src/aws-fsx/daily-automatic-backup-start-time.ts", "line": 4 }, "name": "DailyAutomaticBackupStartTimeProps", "namespace": "aws_fsx", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The hour of the day (from 0-23) for automatic backup starts." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/daily-automatic-backup-start-time.ts", "line": 8 }, "name": "hour", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The minute of the hour (from 0-59) for automatic backup starts." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/daily-automatic-backup-start-time.ts", "line": 12 }, "name": "minute", "type": { "primitive": "number" } } ], "symbolId": "src/aws-fsx/daily-automatic-backup-start-time:DailyAutomaticBackupStartTimeProps" }, "@open-constructs/aws-cdk.aws_fsx.MaintenanceTime": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "Class for scheduling a weekly maintenance time." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.MaintenanceTime", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-fsx/maintenance-time.ts", "line": 38 }, "parameters": [ { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MaintenanceTimeProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/aws-fsx/maintenance-time.ts", "line": 24 }, "methods": [ { "docs": { "stability": "stable", "summary": "Converts a day, hour, and minute into a timestamp as used by FSx for Lustre's weeklyMaintenanceStartTime field." }, "locationInModule": { "filename": "src/aws-fsx/maintenance-time.ts", "line": 48 }, "name": "toTimestamp", "returns": { "type": { "primitive": "string" } } } ], "name": "MaintenanceTime", "namespace": "aws_fsx", "symbolId": "src/aws-fsx/maintenance-time:MaintenanceTime" }, "@open-constructs/aws-cdk.aws_fsx.MaintenanceTimeProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties required for setting up a weekly maintenance time." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.MaintenanceTimeProps", "kind": "interface", "locationInModule": { "filename": "src/aws-fsx/maintenance-time.ts", "line": 6 }, "name": "MaintenanceTimeProps", "namespace": "aws_fsx", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The day of the week for maintenance to be performed." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/maintenance-time.ts", "line": 10 }, "name": "day", "type": { "fqn": "aws-cdk-lib.aws_fsx.Weekday" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The hour of the day (from 0-23) for maintenance to be performed." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/maintenance-time.ts", "line": 14 }, "name": "hour", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The minute of the hour (from 0-59) for maintenance to be performed." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/maintenance-time.ts", "line": 18 }, "name": "minute", "type": { "primitive": "number" } } ], "symbolId": "src/aws-fsx/maintenance-time:MaintenanceTimeProps" }, "@open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair": { "assembly": "@open-constructs/aws-cdk", "base": "@open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair", "docs": { "stability": "stable", "summary": "The throughput capacity for the Multi-AZ 1 deployment type." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 43 }, "parameters": [ { "name": "capacity", "type": { "primitive": "number" } } ], "protected": true }, "kind": "class", "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 89 }, "name": "MultiAz1ThroughputCapacityPerHaPair", "namespace": "aws_fsx", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 1024 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 108 }, "name": "MB_PER_SEC_1024", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 128 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 93 }, "name": "MB_PER_SEC_128", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 2048 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 113 }, "name": "MB_PER_SEC_2048", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 256 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 98 }, "name": "MB_PER_SEC_256", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 4096 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 118 }, "name": "MB_PER_SEC_4096", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 512 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 103 }, "name": "MB_PER_SEC_512", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz1ThroughputCapacityPerHaPair" } }, { "docs": { "stability": "stable", "summary": "The deployment type of the throughput capacity." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 123 }, "name": "deploymentType", "overrides": "@open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair", "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapDeploymentType" } } ], "symbolId": "src/aws-fsx/ontap-file-system:MultiAz1ThroughputCapacityPerHaPair" }, "@open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair": { "assembly": "@open-constructs/aws-cdk", "base": "@open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair", "docs": { "stability": "stable", "summary": "The throughput capacity for the Multi-AZ 2 deployment type." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 43 }, "parameters": [ { "name": "capacity", "type": { "primitive": "number" } } ], "protected": true }, "kind": "class", "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 154 }, "name": "MultiAz2ThroughputCapacityPerHaPair", "namespace": "aws_fsx", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 1536 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 168 }, "name": "MB_PER_SEC_1536", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 3072 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 173 }, "name": "MB_PER_SEC_3072", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 384 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 158 }, "name": "MB_PER_SEC_384", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 6144 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 178 }, "name": "MB_PER_SEC_6144", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 768 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 163 }, "name": "MB_PER_SEC_768", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MultiAz2ThroughputCapacityPerHaPair" } }, { "docs": { "stability": "stable", "summary": "The deployment type of the throughput capacity." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 183 }, "name": "deploymentType", "overrides": "@open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair", "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapDeploymentType" } } ], "symbolId": "src/aws-fsx/ontap-file-system:MultiAz2ThroughputCapacityPerHaPair" }, "@open-constructs/aws-cdk.aws_fsx.OntapConfiguration": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html", "stability": "stable", "summary": "The configuration for the Amazon FSx for NetApp ONTAP file system." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapConfiguration", "kind": "interface", "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 191 }, "name": "OntapConfiguration", "namespace": "aws_fsx", "properties": [ { "abstract": true, "docs": { "default": "- 30 days", "remarks": "Setting this property to 0 disables automatic backups.\nYou can retain automatic backups for a maximum of 90 days.", "stability": "stable", "summary": "The number of days to retain automatic backups." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 200 }, "name": "automaticBackupRetention", "optional": true, "type": { "fqn": "aws-cdk-lib.Duration" } }, { "abstract": true, "docs": { "default": "- no backup window", "stability": "stable", "summary": "Start time for 30-minute daily automatic backup window in Coordinated Universal Time (UTC)." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 207 }, "name": "dailyAutomaticBackupStartTime", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.DailyAutomaticBackupStartTime" } }, { "abstract": true, "docs": { "default": "OntapDeploymentType.MULTI_AZ_2", "stability": "stable", "summary": "The FSx for ONTAP file system deployment type to use in creating the file system." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 214 }, "name": "deploymentType", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapDeploymentType" } }, { "abstract": true, "docs": { "default": "- 3 IOPS * GB of storage capacity * HAPairs", "remarks": "The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity.\nThe minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity).\nThe maximum value is calculated as 200,000 * HAPairs.", "stability": "stable", "summary": "The total number of SSD IOPS provisioned for the file system." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 225 }, "name": "diskIops", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- an unused IP address range from the 198.19.* range", "remarks": "You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.", "stability": "stable", "summary": "The IP address range in which the endpoints to access your file system will be created." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 234 }, "name": "endpointIpAddressRange", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- do not set an admin password", "remarks": "If you don't specify a password, Amazon FSx will not set one. In that case, the user will not be able to log in.\n\nYou can change the admin password at any time through the management console.", "stability": "stable", "summary": "The ONTAP administrative password for the `fsxadmin` user with which you administer your file system using the NetApp ONTAP CLI and REST API." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 245 }, "name": "fsxAdminPassword", "optional": true, "type": { "fqn": "aws-cdk-lib.SecretValue" } }, { "abstract": true, "docs": { "default": "1", "remarks": "First-generation file systems are powered by 1 HA pair.\nSecond-generation multi-AZ file systems are powered by 1 HA pair.\nSecond generation single-AZ file systems are powered by up to 12 HA pairs.\n\nThe value of this property affects the values of `storageCapacity`, `iops`, and `throughputCapacity`.\n\nBlock storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs.", "see": "https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage", "stability": "stable", "summary": "How many high-availability (HA) pairs of file servers will power your file system." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 263 }, "name": "haPairs", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no default value (This value is not used for single-AZ file systems, but it is required for multi-AZ file systems)", "remarks": "This value is required when `deploymentType` is set to `MULTI_AZ_1` or `MULTI_AZ_2`.", "stability": "stable", "summary": "The subnet in which you want the preferred file server to be located." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 272 }, "name": "preferredSubnet", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_ec2.ISubnet" } }, { "abstract": true, "docs": { "default": "- Amazon FSx selects your VPC's default route table.", "remarks": "You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located.\n\nAmazon FSx manages VPC route tables for Multi-AZ file systems using tag-based authentication.\nThese route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx.", "see": "https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/unable-to-access.html#vpc-route-tables-not-tagged", "stability": "stable", "summary": "The route tables in which Amazon FSx creates the rules for routing traffic to the correct file server." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 286 }, "name": "routeTables", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_ec2.IRouteTable" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- Amazon FSx determines the throughput capacity based on the storage capacity", "see": "https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html", "stability": "stable", "summary": "The throughput capacity per HA pair for the file system." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 295 }, "name": "throughputCapacityPerHaPair", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair" } }, { "abstract": true, "docs": { "default": "- automatically set by Amazon FSx", "stability": "stable", "summary": "The preferred day and time to perform weekly maintenance." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 302 }, "name": "weeklyMaintenanceStartTime", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.MaintenanceTime" } } ], "symbolId": "src/aws-fsx/ontap-file-system:OntapConfiguration" }, "@open-constructs/aws-cdk.aws_fsx.OntapDeploymentType": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "The different kinds of file system deployments used by NetApp ONTAP." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapDeploymentType", "kind": "enum", "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 9 }, "members": [ { "docs": { "remarks": "This is a first-generation FSx for ONTAP file system.", "stability": "stable", "summary": "A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability." }, "name": "MULTI_AZ_1" }, { "docs": { "remarks": "This is a second-generation FSx for ONTAP file system.", "stability": "stable", "summary": "A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability." }, "name": "MULTI_AZ_2" }, { "docs": { "remarks": "This is a first-generation FSx for ONTAP file system.", "stability": "stable", "summary": "A file system configured for Single-AZ redundancy." }, "name": "SINGLE_AZ_1" }, { "docs": { "remarks": "This is a second-generation FSx for ONTAP file system.", "stability": "stable", "summary": "A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy." }, "name": "SINGLE_AZ_2" } ], "name": "OntapDeploymentType", "namespace": "aws_fsx", "symbolId": "src/aws-fsx/ontap-file-system:OntapDeploymentType" }, "@open-constructs/aws-cdk.aws_fsx.OntapFileSystem": { "assembly": "@open-constructs/aws-cdk", "base": "aws-cdk-lib.aws_fsx.FileSystemBase", "docs": { "custom": { "resource": "AWS::FSx::FileSystem" }, "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html", "stability": "stable", "summary": "The FSx for NetApp ONTAP File System implementation of IFileSystem." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapFileSystem", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 396 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapFileSystemProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 332 }, "methods": [ { "docs": { "stability": "stable", "summary": "Configures a Connections object." }, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 353 }, "name": "configureConnections", "parameters": [ { "name": "securityGroup", "type": { "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_ec2.Connections" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Import an existing FSx for NetApp ONTAP file system from the given properties." }, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 336 }, "name": "fromOntapFileSystemAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "aws-cdk-lib.aws_fsx.FileSystemAttributes" } } ], "returns": { "type": { "fqn": "aws-cdk-lib.aws_fsx.IFileSystem" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 421 }, "name": "createOntapFileSystem", "parameters": [ { "name": "fileSystemSecurityGroup", "type": { "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup" } }, { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapFileSystemProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_fsx.CfnFileSystem" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 415 }, "name": "createSecurityGroup", "parameters": [ { "name": "vpc", "type": { "fqn": "aws-cdk-lib.aws_ec2.IVpc" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_ec2.SecurityGroup" } } } ], "name": "OntapFileSystem", "namespace": "aws_fsx", "properties": [ { "docs": { "stability": "stable", "summary": "The security groups/rules used to allow network connections to the file system." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 369 }, "name": "connections", "overrides": "aws-cdk-lib.aws_fsx.FileSystemBase", "type": { "fqn": "aws-cdk-lib.aws_ec2.Connections" } }, { "docs": { "stability": "stable", "summary": "The management endpoint DNS name assigned to this file system." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 374 }, "name": "dnsName", "overrides": "aws-cdk-lib.aws_fsx.FileSystemBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The ID that AWS assigns to the file system." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 384 }, "name": "fileSystemId", "overrides": "aws-cdk-lib.aws_fsx.FileSystemBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The inter cluster endpoint DNS name assigned to this file system." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 379 }, "name": "interClusterDnsName", "type": { "primitive": "string" } } ], "symbolId": "src/aws-fsx/ontap-file-system:OntapFileSystem" }, "@open-constructs/aws-cdk.aws_fsx.OntapFileSystemProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties specific to the NetApp ONTAP version of the FSx file system." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapFileSystemProps", "interfaces": [ "aws-cdk-lib.aws_fsx.FileSystemProps" ], "kind": "interface", "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 308 }, "name": "OntapFileSystemProps", "namespace": "aws_fsx", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Additional configuration for FSx specific to NetApp ONTAP." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 312 }, "name": "ontapConfiguration", "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapConfiguration" } }, { "abstract": true, "docs": { "remarks": "For MULTI_AZ_1 deployment types,\nprovide exactly two subnets, one for the preferred file server and one for the standby file server.\n\nSpecify one of these subnets as the preferred subnet using `OntapConfiguration.preferredSubnet` property for multi-AZ file system.", "stability": "stable", "summary": "The subnet that the file system will be accessible from." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 322 }, "name": "vpcSubnets", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_ec2.ISubnet" }, "kind": "array" } } } ], "symbolId": "src/aws-fsx/ontap-file-system:OntapFileSystemProps" }, "@open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair": { "assembly": "@open-constructs/aws-cdk", "base": "@open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair", "docs": { "stability": "stable", "summary": "The throughput capacity for the Single-AZ 1 deployment type." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 43 }, "parameters": [ { "name": "capacity", "type": { "primitive": "number" } } ], "protected": true }, "kind": "class", "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 49 }, "name": "SingleAz1ThroughputCapacityPerHaPair", "namespace": "aws_fsx", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 1024 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 68 }, "name": "MB_PER_SEC_1024", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 128 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 53 }, "name": "MB_PER_SEC_128", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 2048 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 73 }, "name": "MB_PER_SEC_2048", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 256 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 58 }, "name": "MB_PER_SEC_256", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 4096 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 78 }, "name": "MB_PER_SEC_4096", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 512 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 63 }, "name": "MB_PER_SEC_512", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.SingleAz1ThroughputCapacityPerHaPair" } }, { "docs": { "stability": "stable", "summary": "The deployment type of the throughput capacity." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 83 }, "name": "deploymentType", "overrides": "@open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair", "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapDeploymentType" } } ], "symbolId": "src/aws-fsx/ontap-file-system:SingleAz1ThroughputCapacityPerHaPair" }, "@open-constructs/aws-cdk.aws_fsx.SingleAz2ThroughputCapacityPerHaPair": { "assembly": "@open-constructs/aws-cdk", "base": "@open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair", "docs": { "stability": "stable", "summary": "The throughput capacity for the Single-AZ 2 deployment type." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.SingleAz2ThroughputCapacityPerHaPair", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 43 }, "parameters": [ { "name": "capacity", "type": { "primitive": "number" } } ], "protected": true }, "kind": "class", "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 129 }, "name": "SingleAz2ThroughputCapacityPerHaPair", "namespace": "aws_fsx", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 1536 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 133 }, "name": "MB_PER_SEC_1536", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.SingleAz2ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 3072 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 138 }, "name": "MB_PER_SEC_3072", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.SingleAz2ThroughputCapacityPerHaPair" } }, { "const": true, "docs": { "stability": "stable", "summary": "The throughput capacity of 6144 MBps per HA pair." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 143 }, "name": "MB_PER_SEC_6144", "static": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.SingleAz2ThroughputCapacityPerHaPair" } }, { "docs": { "stability": "stable", "summary": "The deployment type of the throughput capacity." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 148 }, "name": "deploymentType", "overrides": "@open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair", "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapDeploymentType" } } ], "symbolId": "src/aws-fsx/ontap-file-system:SingleAz2ThroughputCapacityPerHaPair" }, "@open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair": { "abstract": true, "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "The throughput capacity per HA pair for an Amazon FSx for NetApp ONTAP file system." }, "fqn": "@open-constructs/aws-cdk.aws_fsx.ThroughputCapacityPerHaPair", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 43 }, "parameters": [ { "name": "capacity", "type": { "primitive": "number" } } ], "protected": true }, "kind": "class", "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 38 }, "name": "ThroughputCapacityPerHaPair", "namespace": "aws_fsx", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 43 }, "name": "capacity", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The deployment type of the throughput capacity." }, "immutable": true, "locationInModule": { "filename": "src/aws-fsx/ontap-file-system.ts", "line": 42 }, "name": "deploymentType", "type": { "fqn": "@open-constructs/aws-cdk.aws_fsx.OntapDeploymentType" } } ], "symbolId": "src/aws-fsx/ontap-file-system:ThroughputCapacityPerHaPair" }, "@open-constructs/aws-cdk.aws_redshiftserverless.INamespace": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "A Redshift Serverless Namespace." }, "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.INamespace", "interfaces": [ "aws-cdk-lib.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 9 }, "name": "INamespace", "namespace": "aws_redshiftserverless", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The namespace ARN." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 15 }, "name": "namespaceArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The namespace id." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 29 }, "name": "namespaceId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The namespace name." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 22 }, "name": "namespaceName", "type": { "primitive": "string" } } ], "symbolId": "src/aws-redshiftserverless/namespace:INamespace" }, "@open-constructs/aws-cdk.aws_redshiftserverless.IWorkgroup": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "A Redshift Serverless Workgroup." }, "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.IWorkgroup", "interfaces": [ "aws-cdk-lib.IResource", "aws-cdk-lib.aws_ec2.IConnectable" ], "kind": "interface", "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 8 }, "name": "IWorkgroup", "namespace": "aws_redshiftserverless", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The workgroup endpoint address." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 32 }, "name": "endpointAddress", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The workgroup port." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 38 }, "name": "port", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The workgroup Arn." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 14 }, "name": "workgroupArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The workgroup id." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 26 }, "name": "workgroupId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The workgroup name." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 20 }, "name": "workgroupName", "type": { "primitive": "string" } } ], "symbolId": "src/aws-redshiftserverless/workgroup:IWorkgroup" }, "@open-constructs/aws-cdk.aws_redshiftserverless.LogExport": { "assembly": "@open-constructs/aws-cdk", "docs": { "stability": "stable", "summary": "The types of logs the namespace can export." }, "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.LogExport", "kind": "enum", "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 120 }, "members": [ { "docs": { "stability": "stable", "summary": "User log." }, "name": "USER_LOG" }, { "docs": { "stability": "stable", "summary": "Connection log." }, "name": "CONNECTION_LOG" }, { "docs": { "stability": "stable", "summary": "User activity log." }, "name": "USER_ACTIVITY_LOG" } ], "name": "LogExport", "namespace": "aws_redshiftserverless", "symbolId": "src/aws-redshiftserverless/namespace:LogExport" }, "@open-constructs/aws-cdk.aws_redshiftserverless.Namespace": { "assembly": "@open-constructs/aws-cdk", "base": "aws-cdk-lib.Resource", "docs": { "example": "const nameSpace = new Namespace(\n stack,\n 'Namespace',\n {\n namespaceName: 'my-namespace',\n },\n);", "stability": "stable", "summary": "Represents a Redshift Serverless Namespace construct in AWS CDK." }, "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.Namespace", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 199 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.NamespaceProps" } } ] }, "interfaces": [ "@open-constructs/aws-cdk.aws_redshiftserverless.INamespace" ], "kind": "class", "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 164 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports an existing Namespace from attributes." }, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 168 }, "name": "fromNamespaceAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.NamespaceAttributes" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.INamespace" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Adds a role to the namespace." }, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 369 }, "name": "addIamRole", "parameters": [ { "docs": { "summary": "the role to add." }, "name": "role", "type": { "fqn": "aws-cdk-lib.aws_iam.IRole" } } ] }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 234 }, "name": "createResource", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_redshiftserverless.CfnNamespaceProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_redshiftserverless.CfnNamespace" } } } ], "name": "Namespace", "namespace": "aws_redshiftserverless", "properties": [ { "docs": { "stability": "stable", "summary": "The namespace Arn." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 185 }, "name": "namespaceArn", "overrides": "@open-constructs/aws-cdk.aws_redshiftserverless.INamespace", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The namespace id." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 193 }, "name": "namespaceId", "overrides": "@open-constructs/aws-cdk.aws_redshiftserverless.INamespace", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The namespace name." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 189 }, "name": "namespaceName", "overrides": "@open-constructs/aws-cdk.aws_redshiftserverless.INamespace", "type": { "primitive": "string" } } ], "symbolId": "src/aws-redshiftserverless/namespace:Namespace" }, "@open-constructs/aws-cdk.aws_redshiftserverless.NamespaceAttributes": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Attributes for importing a Redshift Serverless Namespace." }, "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.NamespaceAttributes", "kind": "interface", "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 140 }, "name": "NamespaceAttributes", "namespace": "aws_redshiftserverless", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The namespace id." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 148 }, "name": "namespaceId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The namespace name." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 144 }, "name": "namespaceName", "type": { "primitive": "string" } } ], "symbolId": "src/aws-redshiftserverless/namespace:NamespaceAttributes" }, "@open-constructs/aws-cdk.aws_redshiftserverless.NamespaceProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for defining a Redshift Serverless Namespace." }, "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.NamespaceProps", "kind": "interface", "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 35 }, "name": "NamespaceProps", "namespace": "aws_redshiftserverless", "properties": [ { "abstract": true, "docs": { "default": "- no admin user", "remarks": "You must specify both `adminUsername` and `adminUserPassword`, or neither.", "stability": "stable", "summary": "The username of the administrator for the primary database created in the namespace." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 43 }, "name": "adminUsername", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no admin user", "remarks": "You must specify both `adminUsername` and `adminUserPassword`, or neither.", "stability": "stable", "summary": "The password of the administrator for the primary database created in the namespace." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 52 }, "name": "adminUserPassword", "optional": true, "type": { "fqn": "aws-cdk-lib.SecretValue" } }, { "abstract": true, "docs": { "default": "- 'dev'", "stability": "stable", "summary": "The name of the primary database created in the namespace." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 59 }, "name": "dbName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no default IAM role", "remarks": "`defaultIamRole` must be included in `iamRoles`.", "stability": "stable", "summary": "The IAM role to set as a default in the namespace." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 68 }, "name": "defaultIamRole", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_iam.IRole" } }, { "abstract": true, "docs": { "default": "- no final snapshot", "remarks": "If not specified, the final snapshot will not be taken.", "stability": "stable", "summary": "The name of the snapshot to be created before the namespace is deleted." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 77 }, "name": "finalSnapshotName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Retained indefinitely if `finalSnapshotName` is specified, otherwise no final snapshot", "remarks": "You must set `finalSnapshotName` when you specify `finalSnapshotRetentionPeriod`.", "stability": "stable", "summary": "How long days to retain the final snapshot." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 86 }, "name": "finalSnapshotRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no IAM role associated", "stability": "stable", "summary": "A list of IAM roles to associate with the namespace." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 93 }, "name": "iamRoles", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_iam.IRole" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- use AWS managed key", "stability": "stable", "summary": "A Customer Managed Key used to encrypt your data." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 100 }, "name": "kmsKey", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_kms.IKey" } }, { "abstract": true, "docs": { "default": "- no logs export", "stability": "stable", "summary": "The types of logs the namespace can export." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 107 }, "name": "logExports", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.LogExport" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- auto generate", "stability": "stable", "summary": "The namespace name." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/namespace.ts", "line": 114 }, "name": "namespaceName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/aws-redshiftserverless/namespace:NamespaceProps" }, "@open-constructs/aws-cdk.aws_redshiftserverless.Workgroup": { "assembly": "@open-constructs/aws-cdk", "base": "aws-cdk-lib.Resource", "docs": { "example": "declare const namespace: Namespace;\ndeclare const vpc: aws_ec2.IVpc;\n\nconst nameSpace = new Workgroup(\n stack,\n 'Workgroup',\n {\n workgroupName: 'my-workgroup',\n namespace: namespace,\n vpc,\n },\n);", "stability": "stable", "summary": "Represents a Redshift Serverless Workgroup construct in AWS CDK." }, "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.Workgroup", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 226 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.WorkgroupProps" } } ] }, "interfaces": [ "@open-constructs/aws-cdk.aws_redshiftserverless.IWorkgroup" ], "kind": "class", "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 168 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing workgroup to the stack from its attributes." }, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 172 }, "name": "fromWorkgroupAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.WorkgroupAttributes" } } ], "returns": { "type": { "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.IWorkgroup" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 280 }, "name": "createResource", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_redshiftserverless.CfnWorkgroupProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_redshiftserverless.CfnWorkgroup" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 288 }, "name": "createSecurityGroup", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "aws-cdk-lib.aws_ec2.SecurityGroupProps" } } ], "protected": true, "returns": { "type": { "fqn": "aws-cdk-lib.aws_ec2.SecurityGroup" } } } ], "name": "Workgroup", "namespace": "aws_redshiftserverless", "properties": [ { "docs": { "stability": "stable", "summary": "The connection object associated with the Redshift Serverless Workgroup." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 220 }, "name": "connections", "overrides": "aws-cdk-lib.aws_ec2.IConnectable", "type": { "fqn": "aws-cdk-lib.aws_ec2.Connections" } }, { "docs": { "stability": "stable", "summary": "The workgroup endpoint address." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 210 }, "name": "endpointAddress", "overrides": "@open-constructs/aws-cdk.aws_redshiftserverless.IWorkgroup", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The workgroup port." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 215 }, "name": "port", "overrides": "@open-constructs/aws-cdk.aws_redshiftserverless.IWorkgroup", "type": { "primitive": "number" } }, { "docs": { "stability": "stable", "summary": "The workgroup Arn." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 195 }, "name": "workgroupArn", "overrides": "@open-constructs/aws-cdk.aws_redshiftserverless.IWorkgroup", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The workgroup id." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 205 }, "name": "workgroupId", "overrides": "@open-constructs/aws-cdk.aws_redshiftserverless.IWorkgroup", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The workgroup name." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 200 }, "name": "workgroupName", "overrides": "@open-constructs/aws-cdk.aws_redshiftserverless.IWorkgroup", "type": { "primitive": "string" } } ], "symbolId": "src/aws-redshiftserverless/workgroup:Workgroup" }, "@open-constructs/aws-cdk.aws_redshiftserverless.WorkgroupAttributes": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Attributes for importing a Redshift Serverless Workgroup." }, "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.WorkgroupAttributes", "kind": "interface", "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 128 }, "name": "WorkgroupAttributes", "namespace": "aws_redshiftserverless", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The workgroup endpoint address." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 140 }, "name": "endpointAddress", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The workgroup port." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 144 }, "name": "port", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The security groups associated with the Redshift Serverless Workgroup." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 148 }, "name": "securityGroups", "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The workgroup id." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 136 }, "name": "workgroupId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The workgroup name." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 132 }, "name": "workgroupName", "type": { "primitive": "string" } } ], "symbolId": "src/aws-redshiftserverless/workgroup:WorkgroupAttributes" }, "@open-constructs/aws-cdk.aws_redshiftserverless.WorkgroupProps": { "assembly": "@open-constructs/aws-cdk", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for defining a Redshift Serverless Workgroup." }, "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.WorkgroupProps", "kind": "interface", "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 44 }, "name": "WorkgroupProps", "namespace": "aws_redshiftserverless", "properties": [ { "abstract": true, "docs": { "remarks": "`vpc` must have at least 3 subnets, and they must span across 3 Availability Zones.", "stability": "stable", "summary": "The VPC to place the workgroup in." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 106 }, "name": "vpc", "type": { "fqn": "aws-cdk-lib.aws_ec2.IVpc" } }, { "abstract": true, "docs": { "default": "128", "remarks": "You can adjust the base capacity setting from 8 RPUs to 512 RPUs in units of 8.\nAlso you can increment or decrement RPUs in units of 32 when setting a base capacity between 512-1024.", "see": "https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-capacity.html", "stability": "stable", "summary": "The base compute capacity of the workgroup in Redshift Processing Units (RPUs)." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 55 }, "name": "baseCapacity", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no config parameters", "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-workgroup.html#cfn-redshiftserverless-workgroup-configparameters", "stability": "stable", "summary": "A list of parameters to set for finer control over a database." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 63 }, "name": "configParameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 71 }, "name": "enhancedVpcRouting", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- the workgroup is not associated with any namespace", "stability": "stable", "summary": "The namespace the workgroup is associated with." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 78 }, "name": "namespace", "optional": true, "type": { "fqn": "@open-constructs/aws-cdk.aws_redshiftserverless.INamespace" } }, { "abstract": true, "docs": { "default": "5439", "remarks": "Valid port ranges are 5431-5455 and 8191-8215.", "stability": "stable", "summary": "The custom port to use when connecting to a workgroup." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 85 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "A value that specifies whether the workgroup can be accessible from a public network." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 92 }, "name": "publiclyAccessible", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- a new security group is created", "stability": "stable", "summary": "The security groups to associate with the workgroup." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 99 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- private subnets", "stability": "stable", "summary": "Where to place the workgroup within the VPC." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 113 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "aws-cdk-lib.aws_ec2.SubnetSelection" } }, { "abstract": true, "docs": { "default": "- auto generate", "remarks": "\\`workgroupName\\` must be between 3 and 64 characters long, contain only lowercase letters, numbers, and hyphens.", "stability": "stable", "summary": "The workgroup name." }, "immutable": true, "locationInModule": { "filename": "src/aws-redshiftserverless/workgroup.ts", "line": 122 }, "name": "workgroupName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/aws-redshiftserverless/workgroup:WorkgroupProps" } }, "version": "0.1.2", "fingerprint": "XFBNHZwyuBTQ3x8mO8m4FMQXWDogcaKP7J5xUVxQ1Hc=" }