{"name":"aws-native","displayName":"AWS Cloud Control","version":"1.57.0","description":"A native Pulumi package for creating and managing Amazon Web Services (AWS) resources.","keywords":["pulumi","aws","aws-native","cloud control","ccapi","category/cloud","kind/native"],"homepage":"https://pulumi.com","license":"Apache-2.0","repository":"https://github.com/pulumi/pulumi-aws-native","publisher":"Pulumi","language":{"csharp":{"namespaces":{"accessanalyzer":"AccessAnalyzer","acmpca":"Acmpca","aiops":"AiOps","amazonmq":"AmazonMq","amplify":"Amplify","amplifyuibuilder":"AmplifyUiBuilder","apigateway":"ApiGateway","apigatewayv2":"ApiGatewayV2","appconfig":"AppConfig","appflow":"AppFlow","appintegrations":"AppIntegrations","applicationautoscaling":"ApplicationAutoScaling","applicationinsights":"ApplicationInsights","applicationsignals":"ApplicationSignals","apprunner":"AppRunner","appstream":"AppStream","appsync":"AppSync","aps":"Aps","arcregionswitch":"ArcRegionSwitch","arczonalshift":"ArcZonalShift","athena":"Athena","auditmanager":"AuditManager","autoscaling":"AutoScaling","aws-native":"AwsNative","b2bi":"B2bi","backup":"Backup","backupgateway":"BackupGateway","batch":"Batch","bedrock":"Bedrock","bedrockagentcore":"BedrockAgentCore","bedrockmantle":"BedrockMantle","billing":"Billing","budgets":"Budgets","cases":"Cases","cassandra":"Cassandra","ce":"Ce","certificatemanager":"CertificateManager","chatbot":"Chatbot","cleanrooms":"CleanRooms","cleanroomsml":"CleanRoomsMl","cloudformation":"CloudFormation","cloudfront":"CloudFront","cloudtrail":"CloudTrail","cloudwatch":"CloudWatch","codeartifact":"CodeArtifact","codebuild":"CodeBuild","codeconnections":"CodeConnections","codedeploy":"CodeDeploy","codeguruprofiler":"CodeGuruProfiler","codegurureviewer":"CodeGuruReviewer","codepipeline":"CodePipeline","codestarconnections":"CodeStarConnections","codestarnotifications":"CodeStarNotifications","cognito":"Cognito","comprehend":"Comprehend","computeoptimizer":"ComputeOptimizer","configuration":"Configuration","connect":"Connect","connectcampaigns":"ConnectCampaigns","connectcampaignsv2":"ConnectCampaignsV2","controltower":"ControlTower","customerprofiles":"CustomerProfiles","databrew":"DataBrew","datapipeline":"DataPipeline","datasync":"DataSync","datazone":"DataZone","dax":"Dax","deadline":"Deadline","detective":"Detective","devicefarm":"DeviceFarm","devopsguru":"DevOpsGuru","directconnect":"DirectConnect","directoryservice":"DirectoryService","dms":"Dms","docdb":"DocDb","docdbelastic":"DocDbElastic","dsql":"Dsql","dynamodb":"DynamoDb","ec2":"Ec2","ecr":"Ecr","ecs":"Ecs","efs":"Efs","eks":"Eks","elasticache":"ElastiCache","elasticbeanstalk":"ElasticBeanstalk","elasticloadbalancingv2":"ElasticLoadBalancingV2","emr":"Emr","emrcontainers":"EmrContainers","emrserverless":"EmrServerless","entityresolution":"EntityResolution","events":"Events","eventschemas":"EventSchemas","evidently":"Evidently","evs":"Evs","finspace":"FinSpace","fis":"Fis","fms":"Fms","forecast":"Forecast","frauddetector":"FraudDetector","fsx":"FSx","gamelift":"GameLift","gameliftstreams":"GameLiftStreams","globalaccelerator":"GlobalAccelerator","glue":"Glue","grafana":"Grafana","greengrassv2":"GreengrassV2","groundstation":"GroundStation","guardduty":"GuardDuty","healthimaging":"HealthImaging","healthlake":"HealthLake","iam":"Iam","identitystore":"IdentityStore","imagebuilder":"ImageBuilder","inspector":"Inspector","inspectorv2":"InspectorV2","internetmonitor":"InternetMonitor","invoicing":"Invoicing","iot":"IoT","iotanalytics":"IoTAnalytics","iotcoredeviceadvisor":"IoTCoreDeviceAdvisor","iotevents":"IoTEvents","iotfleethub":"IoTFleetHub","iotsitewise":"IoTSiteWise","iottwinmaker":"IoTTwinMaker","iotwireless":"IoTWireless","ivs":"Ivs","ivschat":"IvsChat","kafkaconnect":"KafkaConnect","kendra":"Kendra","kendraranking":"KendraRanking","kinesis":"Kinesis","kinesisanalyticsv2":"KinesisAnalyticsV2","kinesisfirehose":"KinesisFirehose","kinesisvideo":"KinesisVideo","kms":"Kms","lakeformation":"LakeFormation","lambda":"Lambda","launchwizard":"LaunchWizard","lex":"Lex","licensemanager":"LicenseManager","lightsail":"Lightsail","location":"Location","logs":"Logs","lookoutvision":"LookoutVision","m2":"M2","macie":"Macie","mediaconnect":"MediaConnect","medialive":"MediaLive","mediapackage":"MediaPackage","mediapackagev2":"MediaPackageV2","mediatailor":"MediaTailor","memorydb":"MemoryDb","msk":"Msk","mwaa":"Mwaa","mwaaserverless":"MwaaServerless","neptune":"Neptune","neptunegraph":"NeptuneGraph","networkfirewall":"NetworkFirewall","networkmanager":"NetworkManager","nimblestudio":"NimbleStudio","oam":"Oam","observabilityadmin":"ObservabilityAdmin","odb":"Odb","omics":"Omics","opensearchserverless":"OpenSearchServerless","opensearchservice":"OpenSearchService","opsworkscm":"OpsWorksCm","organizations":"Organizations","osis":"Osis","panorama":"Panorama","paymentcryptography":"PaymentCryptography","pcaconnectorad":"PcaConnectorAd","pcaconnectorscep":"PcaConnectorScep","pcs":"Pcs","personalize":"Personalize","pinpoint":"Pinpoint","pipes":"Pipes","proton":"Proton","qbusiness":"QBusiness","qldb":"Qldb","quicksight":"QuickSight","ram":"Ram","rbin":"Rbin","rds":"Rds","redshift":"Redshift","redshiftserverless":"RedshiftServerless","refactorspaces":"RefactorSpaces","rekognition":"Rekognition","resiliencehub":"ResilienceHub","resourceexplorer2":"ResourceExplorer2","resourcegroups":"ResourceGroups","rolesanywhere":"RolesAnywhere","route53":"Route53","route53profiles":"Route53Profiles","route53recoverycontrol":"Route53RecoveryControl","route53recoveryreadiness":"Route53RecoveryReadiness","route53resolver":"Route53Resolver","rtbfabric":"RtbFabric","rum":"Rum","s3":"S3","s3express":"S3Express","s3objectlambda":"S3ObjectLambda","s3outposts":"S3Outposts","s3tables":"S3Tables","s3vectors":"S3Vectors","sagemaker":"SageMaker","scheduler":"Scheduler","secretsmanager":"SecretsManager","securityhub":"SecurityHub","securitylake":"SecurityLake","servicecatalog":"ServiceCatalog","servicecatalogappregistry":"ServiceCatalogAppRegistry","ses":"Ses","shield":"Shield","signer":"Signer","simspaceweaver":"SimSpaceWeaver","smsvoice":"Smsvoice","sns":"Sns","sqs":"Sqs","ssm":"Ssm","ssmcontacts":"SsmContacts","ssmguiconnect":"SsmGuiConnect","ssmincidents":"SsmIncidents","ssmquicksetup":"SsmQuickSetup","sso":"Sso","stepfunctions":"StepFunctions","supportapp":"SupportApp","synthetics":"Synthetics","systemsmanagersap":"SystemsManagerSap","timestream":"Timestream","transfer":"Transfer","verifiedpermissions":"VerifiedPermissions","voiceid":"VoiceId","vpclattice":"VpcLattice","wafv2":"WaFv2","wisdom":"Wisdom","workspaces":"WorkSpaces","workspacesinstances":"WorkspacesInstances","workspacesthinclient":"WorkSpacesThinClient","workspacesweb":"WorkSpacesWeb","xray":"XRay"},"packageReferences":{"Pulumi":"3.*"},"respectSchemaVersion":true},"go":{"importBasePath":"github.com/pulumi/pulumi-aws-native/sdk/go/aws","packageImportAliases":{"github.com/pulumi/pulumi-aws-native/sdk/go/aws/aws-native":"aws"},"respectSchemaVersion":true},"java":{"packages":{"aws-native":"awsnative"}},"nodejs":{"respectSchemaVersion":true},"python":{"pyproject":{"enabled":true},"respectSchemaVersion":true}},"config":{"variables":{"accessKey":{"type":"string","description":"The access key for API operations. You can retrieve this from the ‘Security \u0026 Credentials’ section of the AWS console.","secret":true},"allowedAccountIds":{"type":"array","items":{"type":"string"},"description":"List of allowed AWS account IDs to prevent you from mistakenly using an incorrect one. Conflicts with `forbiddenAccountIds`."},"assumeRole":{"$ref":"#/types/aws-native:config:AssumeRole","description":"Configuration for retrieving temporary credentials from the STS service."},"autoNaming":{"$ref":"#/types/aws-native:config:AutoNaming","description":"The configuration for automatically naming resources."},"defaultTags":{"$ref":"#/types/aws-native:config:DefaultTags","description":"Configuration block with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys."},"endpoints":{"$ref":"#/types/aws-native:config:Endpoints","description":"Configuration block for customizing service endpoints."},"forbiddenAccountIds":{"type":"array","items":{"type":"string"},"description":"List of forbidden AWS account IDs to prevent you from mistakenly using the wrong one (and potentially end up destroying a live environment). Conflicts with `allowedAccountIds`."},"ignoreTags":{"$ref":"#/types/aws-native:config:IgnoreTags","description":"Configuration block with resource tag settings to ignore across all resources handled by this provider (except any individual service tag resources such as `ec2.Tag`) for situations where external systems are managing certain resource tags."},"insecure":{"type":"boolean","description":"Explicitly allow the provider to perform \"insecure\" SSL requests. If omitted,default value is `false`."},"maxRetries":{"type":"integer","description":"The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown."},"profile":{"type":"string","description":"The profile for API operations. If not set, the default profile created with `aws configure` will be used."},"region":{"type":"string","$ref":"#/types/aws-native:index/region:Region","description":"The region where AWS operations will take place. Examples are `us-east-1`, `us-west-2`, etc."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. Note, this is a unique feature for server side security enforcement, not to be confused with assumeRole, which is used to obtain temporary client credentials. If you do not specify a role, Cloud Control API uses a temporary session created using your AWS user credentials instead."},"s3UsePathStyle":{"type":"boolean","description":"Set this to true to use path-style addressing, i.e., `http://s3.amazonaws.com/BUCKET/KEY`. By default, the S3 client will use virtual hosted bucket addressing when possible (`http://BUCKET.s3.amazonaws.com/KEY`). Specific to the Amazon S3 service."},"secretKey":{"type":"string","description":"The secret key for API operations. You can retrieve this from the 'Security \u0026 Credentials' section of the AWS console.","secret":true},"sharedCredentialsFile":{"type":"string","description":"The path to the shared credentials file. If not set this defaults to `~/.aws/credentials`."},"skipCredentialsValidation":{"type":"boolean","description":"Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.","default":true},"skipGetEc2Platforms":{"type":"boolean","description":"Skip getting the supported EC2 platforms. Used by users that don't have `ec2:DescribeAccountAttributes` permissions.","default":true},"skipMetadataApiCheck":{"type":"boolean","description":"Skip the AWS Metadata API check. Useful for AWS API implementations that do not have a metadata API endpoint. Setting to true prevents Pulumi from authenticating via the Metadata API. You may need to use other authentication methods like static credentials, configuration variables, or environment variables.","default":true},"skipRegionValidation":{"type":"boolean","description":"Skip static validation of region name. Used by users of alternative AWS-like APIs or users with access to regions that are not public.","default":true},"skipRequestingAccountId":{"type":"boolean","description":"Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API."},"token":{"type":"string","description":"Session token for validating temporary credentials. Typically provided after successful identity federation or Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided afterward, not the 6 digit MFA code used to get temporary credentials.","secret":true}},"defaults":["region"]},"types":{"aws-native:accessanalyzer:AnalyzerAnalysisRuleCriteria":{"description":"The criteria for an analysis rule for an analyzer.","properties":{"accountIds":{"type":"array","items":{"type":"string"},"description":"A list of AWS account IDs to apply to the analysis rule criteria. The accounts cannot include the organization analyzer owner account. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers."},"resourceTags":{"type":"array","items":{"type":"array","items":{"$ref":"#/types/aws-native:accessanalyzer:AnalyzerTag"}},"description":"An array of key-value pairs to match for your resources. You can use the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.\n\nFor the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with aws:.\n\nFor the tag value, you can specify a value that is 0 to 256 characters in length. If the specified tag value is 0 characters, the rule is applied to all principals with the specified tag key."}},"type":"object"},"aws-native:accessanalyzer:AnalyzerArchiveRule":{"description":"An Access Analyzer archive rule. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.","properties":{"filter":{"type":"array","items":{"$ref":"#/types/aws-native:accessanalyzer:AnalyzerFilter"},"description":"The criteria for the rule."},"ruleName":{"type":"string","description":"The archive rule name"}},"type":"object","required":["filter","ruleName"]},"aws-native:accessanalyzer:AnalyzerConfigurationProperties":{"description":"The configuration for the analyzer","properties":{"internalAccessConfiguration":{"$ref":"#/types/aws-native:accessanalyzer:AnalyzerInternalAccessConfiguration","description":"Specifies the configuration of an internal access analyzer for an AWS organization or account. This configuration determines how the analyzer evaluates access within your AWS environment."},"unusedAccessConfiguration":{"$ref":"#/types/aws-native:accessanalyzer:AnalyzerUnusedAccessConfiguration","description":"Specifies the configuration of an unused access analyzer for an AWS organization or account."}},"type":"object"},"aws-native:accessanalyzer:AnalyzerFilter":{"properties":{"contains":{"type":"array","items":{"type":"string"},"description":"A \"contains\" condition to match for the rule."},"eq":{"type":"array","items":{"type":"string"},"description":"An \"equals\" condition to match for the rule."},"exists":{"type":"boolean","description":"An \"exists\" condition to match for the rule."},"neq":{"type":"array","items":{"type":"string"},"description":"A \"not equal\" condition to match for the rule."},"property":{"type":"string","description":"The property used to define the criteria in the filter for the rule."}},"type":"object","required":["property"]},"aws-native:accessanalyzer:AnalyzerInternalAccessAnalysisRuleCriteria":{"description":"The criteria for an analysis rule for an internal access analyzer.","properties":{"accountIds":{"type":"array","items":{"type":"string"},"description":"A list of AWS account IDs to apply to the internal access analysis rule criteria. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers and cannot include the organization owner account."},"resourceArns":{"type":"array","items":{"type":"string"},"description":"A list of resource ARNs to apply to the internal access analysis rule criteria. The analyzer will only generate findings for resources that match these ARNs."},"resourceTypes":{"type":"array","items":{"type":"string"},"description":"A list of resource types to apply to the internal access analysis rule criteria. The analyzer will only generate findings for resources of these types."}},"type":"object"},"aws-native:accessanalyzer:AnalyzerInternalAccessConfiguration":{"description":"Specifies the configuration of an internal access analyzer for an AWS organization or account. This configuration determines how the analyzer evaluates internal access within your AWS environment.","properties":{"internalAccessAnalysisRule":{"$ref":"#/types/aws-native:accessanalyzer:AnalyzerInternalAccessConfigurationInternalAccessAnalysisRuleProperties","description":"Contains information about analysis rules for the internal access analyzer. Analysis rules determine which entities will generate findings based on the criteria you define when you create the rule."}},"type":"object"},"aws-native:accessanalyzer:AnalyzerInternalAccessConfigurationInternalAccessAnalysisRuleProperties":{"description":"Contains information about analysis rules for the internal access analyzer. Analysis rules determine which entities will generate findings based on the criteria you define when you create the rule.","properties":{"inclusions":{"type":"array","items":{"$ref":"#/types/aws-native:accessanalyzer:AnalyzerInternalAccessAnalysisRuleCriteria"},"description":"A list of rules for the internal access analyzer containing criteria to include in analysis. Only resources that meet the rule criteria will generate findings."}},"type":"object"},"aws-native:accessanalyzer:AnalyzerTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key"]},"aws-native:accessanalyzer:AnalyzerUnusedAccessConfiguration":{"description":"The Configuration for Unused Access Analyzer","properties":{"analysisRule":{"$ref":"#/types/aws-native:accessanalyzer:AnalyzerUnusedAccessConfigurationAnalysisRuleProperties","description":"Contains information about rules for the analyzer."},"unusedAccessAge":{"type":"integer","description":"The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 365 days."}},"type":"object"},"aws-native:accessanalyzer:AnalyzerUnusedAccessConfigurationAnalysisRuleProperties":{"description":"Contains information about rules for the analyzer.","properties":{"exclusions":{"type":"array","items":{"$ref":"#/types/aws-native:accessanalyzer:AnalyzerAnalysisRuleCriteria"},"description":"A list of rules for the analyzer containing criteria to exclude from analysis. Entities that meet the rule criteria will not generate findings."}},"type":"object"},"aws-native:acmpca:CertificateApiPassthrough":{"description":"Contains X.509 certificate information to be placed in an issued certificate. An ``APIPassthrough`` or ``APICSRPassthrough`` template variant must be selected, or else this parameter is ignored. \n If conflicting or duplicate certificate information is supplied from other sources, AWS Private CA applies [order of operation rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) to determine what information is used.","properties":{"extensions":{"$ref":"#/types/aws-native:acmpca:CertificateExtensions","description":"Specifies X.509 extension information for a certificate."},"subject":{"$ref":"#/types/aws-native:acmpca:CertificateSubject","description":"Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate."}},"type":"object"},"aws-native:acmpca:CertificateAuthorityAccessDescription":{"description":"Structure that contains X.509 AccessDescription information.","properties":{"accessLocation":{"$ref":"#/types/aws-native:acmpca:CertificateAuthorityGeneralName"},"accessMethod":{"$ref":"#/types/aws-native:acmpca:CertificateAuthorityAccessMethod"}},"type":"object","required":["accessLocation","accessMethod"]},"aws-native:acmpca:CertificateAuthorityAccessMethod":{"description":"Structure that contains X.509 AccessMethod information. Assign one and ONLY one field.","properties":{"accessMethodType":{"type":"string"},"customObjectIdentifier":{"type":"string"}},"type":"object"},"aws-native:acmpca:CertificateAuthorityCrlConfiguration":{"description":"Your certificate authority can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates that have been revoked.","properties":{"crlDistributionPointExtensionConfiguration":{"$ref":"#/types/aws-native:acmpca:CertificateAuthorityCrlDistributionPointExtensionConfiguration","description":"Configures the default behavior of the CRL Distribution Point extension for certificates issued by your CA. If this field is not provided, then the CRL Distribution Point extension will be present and contain the default CRL URL."},"crlType":{"type":"string","description":"Specifies the type of CRL. This setting determines the maximum number of certificates that the certificate authority can issue and revoke. For more information, see [AWS Private CA quotas](https://docs.aws.amazon.com/general/latest/gr/pca.html#limits_pca) .\n\n- `COMPLETE` - The default setting. AWS Private CA maintains a single CRL file for all unexpired certificates issued by a CA that have been revoked for any reason. Each certificate that AWS Private CA issues is bound to a specific CRL through the CRL distribution point (CDP) defined in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280) .\n- `PARTITIONED` - Compared to complete CRLs, partitioned CRLs dramatically increase the number of certificates your private CA can issue.\n\n\u003e When using partitioned CRLs, you must validate that the CRL's associated issuing distribution point (IDP) URI matches the certiﬁcate's CDP URI to ensure the right CRL has been fetched. AWS Private CA marks the IDP extension as critical, which your client must be able to process."},"customCname":{"type":"string","description":"Name inserted into the certificate *CRL Distribution Points* extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.\n\n\u003e The content of a Canonical Name (CNAME) record must conform to [RFC2396](https://docs.aws.amazon.com/https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\"."},"customPath":{"type":"string","description":"Designates a custom file path in S3 for CRL(s). For example, `http://\u003cCustomName\u003e/\u003cCustomPath\u003e/\u003cCrlPartition_GUID\u003e.crl` ."},"enabled":{"type":"boolean","description":"Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the `CreateCertificateAuthority` operation or for an existing CA when you call the `UpdateCertificateAuthority` operation."},"expirationInDays":{"type":"integer","description":"Validity period of the CRL in days."},"s3BucketName":{"type":"string","description":"Name of the S3 bucket that contains the CRL. If you do not provide a value for the *CustomCname* argument, the name of your S3 bucket is placed into the *CRL Distribution Points* extension of the issued certificate. You can change the name of your bucket by calling the [UpdateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) operation. You must specify a [bucket policy](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-policies) that allows AWS Private CA to write the CRL to your bucket.\n\n\u003e The `S3BucketName` parameter must conform to the [S3 bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) ."},"s3ObjectAcl":{"type":"string","description":"Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.\n\nIf no value is specified, the default is PUBLIC_READ.\n\n*Note:* This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as `BUCKET_OWNER_FULL_CONTROL` , and not doing so results in an error. If you have disabled BPA in S3, then you can specify either `BUCKET_OWNER_FULL_CONTROL` or `PUBLIC_READ` as the value.\n\nFor more information, see [Blocking public access to the S3 bucket](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-bpa) ."}},"type":"object","required":["enabled"]},"aws-native:acmpca:CertificateAuthorityCrlDistributionPointExtensionConfiguration":{"description":"Configures the default behavior of the CRL Distribution Point extension for certificates issued by your certificate authority","properties":{"omitExtension":{"type":"boolean","description":"Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to `true` , then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough.\n\n\u003e Only set this if you have another way to distribute the CRL Distribution Points for certificates issued by your CA, such as the Matter Distributed Compliance Ledger.\n\u003e \n\u003e This configuration cannot be enabled with a custom CNAME set."}},"type":"object","required":["omitExtension"]},"aws-native:acmpca:CertificateAuthorityCsrExtensions":{"description":"Structure that contains CSR pass though extensions information.","properties":{"keyUsage":{"$ref":"#/types/aws-native:acmpca:CertificateAuthorityKeyUsage","description":"Indicates the purpose of the certificate and of the key contained in the certificate."},"subjectInformationAccess":{"type":"array","items":{"$ref":"#/types/aws-native:acmpca:CertificateAuthorityAccessDescription"},"description":"For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see [Subject Information Access](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2) in RFC 5280."}},"type":"object"},"aws-native:acmpca:CertificateAuthorityCustomAttribute":{"description":"Structure that contains X.500 attribute type and value.","properties":{"objectIdentifier":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["objectIdentifier","value"]},"aws-native:acmpca:CertificateAuthorityEdiPartyName":{"description":"Structure that contains X.509 EdiPartyName information.","properties":{"nameAssigner":{"type":"string"},"partyName":{"type":"string"}},"type":"object","required":["partyName"]},"aws-native:acmpca:CertificateAuthorityGeneralName":{"description":"Structure that contains X.509 GeneralName information. Assign one and ONLY one field.","properties":{"directoryName":{"$ref":"#/types/aws-native:acmpca:CertificateAuthoritySubject"},"dnsName":{"type":"string"},"ediPartyName":{"$ref":"#/types/aws-native:acmpca:CertificateAuthorityEdiPartyName"},"ipAddress":{"type":"string"},"otherName":{"$ref":"#/types/aws-native:acmpca:CertificateAuthorityOtherName"},"registeredId":{"type":"string"},"rfc822Name":{"type":"string"},"uniformResourceIdentifier":{"type":"string"}},"type":"object"},"aws-native:acmpca:CertificateAuthorityKeyUsage":{"description":"Structure that contains X.509 KeyUsage information.","properties":{"crlSign":{"type":"boolean","description":"Key can be used to sign CRLs."},"dataEncipherment":{"type":"boolean","description":"Key can be used to decipher data."},"decipherOnly":{"type":"boolean","description":"Key can be used only to decipher data."},"digitalSignature":{"type":"boolean","description":"Key can be used for digital signing."},"encipherOnly":{"type":"boolean","description":"Key can be used only to encipher data."},"keyAgreement":{"type":"boolean","description":"Key can be used in a key-agreement protocol."},"keyCertSign":{"type":"boolean","description":"Key can be used to sign certificates."},"keyEncipherment":{"type":"boolean","description":"Key can be used to encipher data."},"nonRepudiation":{"type":"boolean","description":"Key can be used for non-repudiation."}},"type":"object"},"aws-native:acmpca:CertificateAuthorityOcspConfiguration":{"description":"Helps to configure online certificate status protocol (OCSP) responder for your certificate authority","properties":{"enabled":{"type":"boolean","description":"Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status."},"ocspCustomCname":{"type":"string","description":"By default, AWS Private CA injects an Amazon domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.\n\n\u003e The content of a Canonical Name (CNAME) record must conform to [RFC2396](https://docs.aws.amazon.com/https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\"."}},"type":"object","required":["enabled"]},"aws-native:acmpca:CertificateAuthorityOtherName":{"description":"Structure that contains X.509 OtherName information.","properties":{"typeId":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["typeId","value"]},"aws-native:acmpca:CertificateAuthorityRevocationConfiguration":{"description":"Certificate Authority revocation information.","properties":{"crlConfiguration":{"$ref":"#/types/aws-native:acmpca:CertificateAuthorityCrlConfiguration","description":"Configuration of the certificate revocation list (CRL), if any, maintained by your private CA."},"ocspConfiguration":{"$ref":"#/types/aws-native:acmpca:CertificateAuthorityOcspConfiguration","description":"Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA."}},"type":"object"},"aws-native:acmpca:CertificateAuthoritySubject":{"description":"Structure that contains X.500 distinguished name information for your CA.","properties":{"commonName":{"type":"string"},"country":{"type":"string"},"customAttributes":{"type":"array","items":{"$ref":"#/types/aws-native:acmpca:CertificateAuthorityCustomAttribute"}},"distinguishedNameQualifier":{"type":"string"},"generationQualifier":{"type":"string"},"givenName":{"type":"string"},"initials":{"type":"string"},"locality":{"type":"string"},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"pseudonym":{"type":"string"},"serialNumber":{"type":"string"},"state":{"type":"string"},"surname":{"type":"string"},"title":{"type":"string"}},"type":"object"},"aws-native:acmpca:CertificateAuthorityTag":{"properties":{"key":{"type":"string","description":"Key (name) of the tag."},"value":{"type":"string","description":"Value of the tag."}},"type":"object","required":["key"]},"aws-native:acmpca:CertificateCustomAttribute":{"description":"Defines the X.500 relative distinguished name (RDN).","properties":{"objectIdentifier":{"type":"string","description":"Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN)."},"value":{"type":"string","description":"Specifies the attribute value of relative distinguished name (RDN)."}},"type":"object","required":["objectIdentifier","value"]},"aws-native:acmpca:CertificateCustomExtension":{"description":"Specifies the X.509 extension information for a certificate.\n Extensions present in ``CustomExtensions`` follow the ``ApiPassthrough``[template rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations).","properties":{"critical":{"type":"boolean","description":"Specifies the critical flag of the X.509 extension."},"objectIdentifier":{"type":"string","description":"Specifies the object identifier (OID) of the X.509 extension. For more information, see the [Global OID reference database.](https://docs.aws.amazon.com/https://oidref.com/2.5.29)"},"value":{"type":"string","description":"Specifies the base64-encoded value of the X.509 extension."}},"type":"object","required":["objectIdentifier","value"]},"aws-native:acmpca:CertificateEdiPartyName":{"description":"Describes an Electronic Data Interchange (EDI) entity as described in as defined in [Subject Alternative Name](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280) in RFC 5280.","properties":{"nameAssigner":{"type":"string","description":"Specifies the name assigner."},"partyName":{"type":"string","description":"Specifies the party name."}},"type":"object","required":["nameAssigner","partyName"]},"aws-native:acmpca:CertificateExtendedKeyUsage":{"description":"Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the ``KeyUsage`` extension.","properties":{"extendedKeyUsageObjectIdentifier":{"type":"string","description":"Specifies a custom ``ExtendedKeyUsage`` with an object identifier (OID)."},"extendedKeyUsageType":{"type":"string","description":"Specifies a standard ``ExtendedKeyUsage`` as defined as in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12)."}},"type":"object"},"aws-native:acmpca:CertificateExtensions":{"description":"Contains X.509 extension information for a certificate.","properties":{"certificatePolicies":{"type":"array","items":{"$ref":"#/types/aws-native:acmpca:CertificatePolicyInformation"},"description":"Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).\n In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate."},"customExtensions":{"type":"array","items":{"$ref":"#/types/aws-native:acmpca:CertificateCustomExtension"},"description":"Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the [Global OID reference database.](https://docs.aws.amazon.com/https://oidref.com/2.5.29)"},"extendedKeyUsage":{"type":"array","items":{"$ref":"#/types/aws-native:acmpca:CertificateExtendedKeyUsage"},"description":"Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the ``KeyUsage`` extension."},"keyUsage":{"$ref":"#/types/aws-native:acmpca:CertificateKeyUsage","description":"Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false."},"subjectAlternativeNames":{"type":"array","items":{"$ref":"#/types/aws-native:acmpca:CertificateGeneralName"},"description":"The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate."}},"type":"object"},"aws-native:acmpca:CertificateGeneralName":{"description":"Describes an ASN.1 X.400 ``GeneralName`` as defined in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280). Only one of the following naming options should be provided. Providing more than one option results in an ``InvalidArgsException`` error.","properties":{"directoryName":{"$ref":"#/types/aws-native:acmpca:CertificateSubject","description":"Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity."},"dnsName":{"type":"string","description":"Represents ``GeneralName`` as a DNS name."},"ediPartyName":{"$ref":"#/types/aws-native:acmpca:CertificateEdiPartyName","description":"Represents ``GeneralName`` as an ``EdiPartyName`` object."},"ipAddress":{"type":"string","description":"Represents ``GeneralName`` as an IPv4 or IPv6 address."},"otherName":{"$ref":"#/types/aws-native:acmpca:CertificateOtherName","description":"Represents ``GeneralName`` using an ``OtherName`` object."},"registeredId":{"type":"string","description":"Represents ``GeneralName`` as an object identifier (OID)."},"rfc822Name":{"type":"string","description":"Represents ``GeneralName`` as an [RFC 822](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc822) email address."},"uniformResourceIdentifier":{"type":"string","description":"Represents ``GeneralName`` as a URI."}},"type":"object"},"aws-native:acmpca:CertificateKeyUsage":{"description":"Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.","properties":{"crlSign":{"type":"boolean","description":"Key can be used to sign CRLs."},"dataEncipherment":{"type":"boolean","description":"Key can be used to decipher data."},"decipherOnly":{"type":"boolean","description":"Key can be used only to decipher data."},"digitalSignature":{"type":"boolean","description":"Key can be used for digital signing."},"encipherOnly":{"type":"boolean","description":"Key can be used only to encipher data."},"keyAgreement":{"type":"boolean","description":"Key can be used in a key-agreement protocol."},"keyCertSign":{"type":"boolean","description":"Key can be used to sign certificates."},"keyEncipherment":{"type":"boolean","description":"Key can be used to encipher data."},"nonRepudiation":{"type":"boolean","description":"Key can be used for non-repudiation."}},"type":"object"},"aws-native:acmpca:CertificateOtherName":{"description":"Defines a custom ASN.1 X.400 ``GeneralName`` using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).","properties":{"typeId":{"type":"string","description":"Specifies an OID."},"value":{"type":"string","description":"Specifies an OID value."}},"type":"object","required":["typeId","value"]},"aws-native:acmpca:CertificatePolicyInformation":{"description":"Defines the X.509 ``CertificatePolicies`` extension.","properties":{"certPolicyId":{"type":"string","description":"Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier)."},"policyQualifiers":{"type":"array","items":{"$ref":"#/types/aws-native:acmpca:CertificatePolicyQualifierInfo"},"description":"Modifies the given ``CertPolicyId`` with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier."}},"type":"object","required":["certPolicyId"]},"aws-native:acmpca:CertificatePolicyQualifierInfo":{"description":"Modifies the ``CertPolicyId`` of a ``PolicyInformation`` object with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier.","properties":{"policyQualifierId":{"type":"string","description":"Identifies the qualifier modifying a ``CertPolicyId``."},"qualifier":{"$ref":"#/types/aws-native:acmpca:CertificateQualifier","description":"Defines the qualifier type. AWS Private CA supports the use of a URI for a CPS qualifier in this field."}},"type":"object","required":["policyQualifierId","qualifier"]},"aws-native:acmpca:CertificateQualifier":{"description":"Defines a ``PolicyInformation`` qualifier. AWS Private CA supports the [certification practice statement (CPS) qualifier](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4) defined in RFC 5280.","properties":{"cpsUri":{"type":"string","description":"Contains a pointer to a certification practice statement (CPS) published by the CA."}},"type":"object","required":["cpsUri"]},"aws-native:acmpca:CertificateSubject":{"description":"Contains information about the certificate subject. The ``Subject`` field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The ``Subject``must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.","properties":{"commonName":{"type":"string","description":"For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.\n Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject."},"country":{"type":"string","description":"Two-digit code that specifies the country in which the certificate subject located."},"customAttributes":{"type":"array","items":{"$ref":"#/types/aws-native:acmpca:CertificateCustomAttribute"},"description":"Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of [Object Identifier (OID)](https://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).\n  Custom attributes cannot be used in combination with standard attributes."},"distinguishedNameQualifier":{"type":"string","description":"Disambiguating information for the certificate subject."},"generationQualifier":{"type":"string","description":"Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third."},"givenName":{"type":"string","description":"First name."},"initials":{"type":"string","description":"Concatenation that typically contains the first letter of the *GivenName*, the first letter of the middle name if one exists, and the first letter of the *Surname*."},"locality":{"type":"string","description":"The locality (such as a city or town) in which the certificate subject is located."},"organization":{"type":"string","description":"Legal name of the organization with which the certificate subject is affiliated."},"organizationalUnit":{"type":"string","description":"A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated."},"pseudonym":{"type":"string","description":"Typically a shortened version of a longer *GivenName*. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza."},"serialNumber":{"type":"string","description":"The certificate serial number."},"state":{"type":"string","description":"State in which the subject of the certificate is located."},"surname":{"type":"string","description":"Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first."},"title":{"type":"string","description":"A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject."}},"type":"object"},"aws-native:acmpca:CertificateValidity":{"description":"Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the ``IssueCertificate`` operation.","properties":{"type":{"type":"string","description":"Specifies whether the ``Value`` parameter represents days, months, or years."},"value":{"type":"number","description":"A long integer interpreted according to the value of ``Type``, below."}},"type":"object","required":["type","value"]},"aws-native:aiops:InvestigationGroupChatbotNotificationChannel":{"properties":{"chatConfigurationArns":{"type":"array","items":{"type":"string"},"description":"Returns the Amazon Resource Name (ARN) of any third-party chat integrations configured for the account."},"snsTopicArn":{"type":"string","description":"Returns the ARN of an Amazon  topic used for third-party chat integrations."}},"type":"object"},"aws-native:aiops:InvestigationGroupCrossAccountConfiguration":{"properties":{"sourceRoleArn":{"type":"string","description":"The ARN of an existing role which will be used to do investigations on your behalf."}},"type":"object"},"aws-native:aiops:InvestigationGroupEncryptionConfigMap":{"properties":{"encryptionConfigurationType":{"type":"string","description":"Displays whether investigation data is encrypted by a customer managed key or an AWS owned key."},"kmsKeyId":{"type":"string","description":"If the investigation group uses a customer managed key for encryption, this field displays the ID of that key."}},"type":"object"},"aws-native:aiops:InvestigationGroupTag":{"properties":{"key":{"type":"string","description":"Assigns one or more tags (key-value pairs) to the specified resource.\n\nTags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.\n\nTags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.\n\nYou can associate as many as 50 tags with a resource."},"value":{"type":"string","description":"A list of key-value pairs to associate with the investigation group. You can associate as many as 50 tags with an investigation group. To be able to associate tags when you create the investigation group, you must have the `cloudwatch:TagResource` permission.\n\nTags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values."}},"type":"object","required":["key","value"]},"aws-native:amazonmq:BrokerConfigurationId":{"properties":{"id":{"type":"string","description":"Required. The unique ID that Amazon MQ generates for the configuration."},"revision":{"type":"integer","description":"The revision number of the configuration."}},"type":"object","required":["id","revision"]},"aws-native:amazonmq:BrokerDataReplicationMode":{"description":"Defines whether this broker is a part of a data replication pair.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Crdr","value":"CRDR"}]},"aws-native:amazonmq:BrokerDataReplicationMode0":{"description":"Defines whether this broker is a part of a data replication pair.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Crdr","value":"CRDR"}]},"aws-native:amazonmq:BrokerDeploymentMode":{"description":"Required. The broker's deployment mode.","type":"string","enum":[{"name":"SingleInstance","value":"SINGLE_INSTANCE"},{"name":"ActiveStandbyMultiAz","value":"ACTIVE_STANDBY_MULTI_AZ"},{"name":"ClusterMultiAz","value":"CLUSTER_MULTI_AZ"}]},"aws-native:amazonmq:BrokerDeploymentMode0":{"description":"Required. The broker's deployment mode.","type":"string","enum":[{"name":"SingleInstance","value":"SINGLE_INSTANCE"},{"name":"ActiveStandbyMultiAz","value":"ACTIVE_STANDBY_MULTI_AZ"},{"name":"ClusterMultiAz","value":"CLUSTER_MULTI_AZ"}]},"aws-native:amazonmq:BrokerEncryptionOptions":{"properties":{"kmsKeyId":{"type":"string","description":"The customer master key (CMK) to use for the A KMS (KMS). \nThis key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.\nThe Key ARN is recommended so that drift can be detected,\nbut a key ID or key alias will also be accepted for API compatibility reasons.\n"},"useAwsOwnedKey":{"type":"boolean","description":"Enables the use of an AWS owned CMK using AWS  (KMS). Set to `true` by default, if no value is provided, for example, for RabbitMQ brokers."}},"type":"object","required":["useAwsOwnedKey"]},"aws-native:amazonmq:BrokerEngineType":{"description":"Required. The type of broker engine. Currently, Amazon MQ supports `ACTIVEMQ` and `RABBITMQ` .","type":"string","enum":[{"name":"Activemq","value":"ACTIVEMQ"},{"name":"Rabbitmq","value":"RABBITMQ"}]},"aws-native:amazonmq:BrokerEngineType0":{"description":"Required. The type of broker engine. Currently, Amazon MQ supports `ACTIVEMQ` and `RABBITMQ` .","type":"string","enum":[{"name":"Activemq","value":"ACTIVEMQ"},{"name":"Rabbitmq","value":"RABBITMQ"}]},"aws-native:amazonmq:BrokerLdapServerMetadata":{"properties":{"hosts":{"type":"array","items":{"type":"string"}},"roleBase":{"type":"string"},"roleName":{"type":"string"},"roleSearchMatching":{"type":"string"},"roleSearchSubtree":{"type":"boolean"},"serviceAccountPassword":{"type":"string"},"serviceAccountUsername":{"type":"string"},"userBase":{"type":"string"},"userRoleName":{"type":"string"},"userSearchMatching":{"type":"string"},"userSearchSubtree":{"type":"boolean"}},"type":"object","required":["hosts","roleBase","roleSearchMatching","serviceAccountUsername","userBase","userSearchMatching"]},"aws-native:amazonmq:BrokerLogList":{"properties":{"audit":{"type":"boolean","description":"Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers."},"general":{"type":"boolean","description":"Enables general logging."}},"type":"object"},"aws-native:amazonmq:BrokerMaintenanceWindow":{"properties":{"dayOfWeek":{"oneOf":[{"$ref":"#/types/aws-native:amazonmq:BrokerMaintenanceWindowDayOfWeek"},{"type":"string"}],"description":"_Allowed Values_: \u003ccode\u003eMONDAY\u003c/code\u003e | \u003ccode\u003eTUESDAY\u003c/code\u003e | \u003ccode\u003eWEDNESDAY\u003c/code\u003e | \u003ccode\u003eTHURSDAY\u003c/code\u003e | \u003ccode\u003eFRIDAY\u003c/code\u003e | \u003ccode\u003eSATURDAY\u003c/code\u003e | \u003ccode\u003eSUNDAY\u003c/code\u003e\n"},"timeOfDay":{"type":"string","description":"The time, in 24-hour format, and use only numbers separated by a colon, HH:MM or HH:MM:SS. Example: 13:05.\nWhen writing YAML this may need to be quoted to prevent a timestamp being read and converted to a number of minutes or seconds.\n"},"timeZone":{"type":"string","description":"The time zone, UTC by default, in either the Country/City format, or the UTC offset format."}},"type":"object","required":["dayOfWeek","timeOfDay","timeZone"]},"aws-native:amazonmq:BrokerMaintenanceWindowDayOfWeek":{"description":"_Allowed Values_: \u003ccode\u003eMONDAY\u003c/code\u003e | \u003ccode\u003eTUESDAY\u003c/code\u003e | \u003ccode\u003eWEDNESDAY\u003c/code\u003e | \u003ccode\u003eTHURSDAY\u003c/code\u003e | \u003ccode\u003eFRIDAY\u003c/code\u003e | \u003ccode\u003eSATURDAY\u003c/code\u003e | \u003ccode\u003eSUNDAY\u003c/code\u003e\n","type":"string","enum":[{"name":"Monday","value":"MONDAY"},{"name":"Tuesday","value":"TUESDAY"},{"name":"Wednesday","value":"WEDNESDAY"},{"name":"Thursday","value":"THURSDAY"},{"name":"Friday","value":"FRIDAY"},{"name":"Saturday","value":"SATURDAY"},{"name":"Sunday","value":"SUNDAY"}]},"aws-native:amazonmq:BrokerMaintenanceWindowDayOfWeek0":{"description":"_Allowed Values_: \u003ccode\u003eMONDAY\u003c/code\u003e | \u003ccode\u003eTUESDAY\u003c/code\u003e | \u003ccode\u003eWEDNESDAY\u003c/code\u003e | \u003ccode\u003eTHURSDAY\u003c/code\u003e | \u003ccode\u003eFRIDAY\u003c/code\u003e | \u003ccode\u003eSATURDAY\u003c/code\u003e | \u003ccode\u003eSUNDAY\u003c/code\u003e\n","type":"string","enum":[{"name":"Monday","value":"MONDAY"},{"name":"Tuesday","value":"TUESDAY"},{"name":"Wednesday","value":"WEDNESDAY"},{"name":"Thursday","value":"THURSDAY"},{"name":"Friday","value":"FRIDAY"},{"name":"Saturday","value":"SATURDAY"},{"name":"Sunday","value":"SUNDAY"}]},"aws-native:amazonmq:BrokerStorageType":{"description":"The broker's storage type.","type":"string","enum":[{"name":"Ebs","value":"EBS"},{"name":"Efs","value":"EFS"}]},"aws-native:amazonmq:BrokerStorageType0":{"description":"The broker's storage type.","type":"string","enum":[{"name":"Ebs","value":"EBS"},{"name":"Efs","value":"EFS"}]},"aws-native:amazonmq:BrokerTagsEntry":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:amazonmq:BrokerUser":{"properties":{"consoleAccess":{"type":"boolean","description":"Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers."},"groups":{"type":"array","items":{"type":"string"},"description":"The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers."},"password":{"type":"string","description":"Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=)."},"replicationUser":{"type":"boolean","description":"Defines if this user is intended for CRDR replication purposes."},"username":{"type":"string","description":"The username of the broker user. The following restrictions apply to broker usernames:\n\n- For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.\n- For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using `guest` as a valid usename. This value must be 2-100 characters long.\n\n\u003e Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data."}},"type":"object","required":["password","username"]},"aws-native:amazonmq:ConfigurationTagsEntry":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:amplify:AppAutoBranchCreationConfig":{"properties":{"autoBranchCreationPatterns":{"type":"array","items":{"type":"string"},"description":"Automated branch creation glob patterns for the Amplify app."},"basicAuthConfig":{"$ref":"#/types/aws-native:amplify:AppBasicAuthConfig","description":"Sets password protection for your auto created branch."},"buildSpec":{"type":"string","description":"The build specification (build spec) for the autocreated branch."},"enableAutoBranchCreation":{"type":"boolean","description":"Enables automated branch creation for the Amplify app."},"enableAutoBuild":{"type":"boolean","description":"Enables auto building for the auto created branch."},"enablePerformanceMode":{"type":"boolean","description":"Enables performance mode for the branch.\n\nPerformance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out."},"enablePullRequestPreview":{"type":"boolean","description":"Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.\n\nTo provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.\n\nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* ."},"environmentVariables":{"type":"array","items":{"$ref":"#/types/aws-native:amplify:AppEnvironmentVariable"},"description":"The environment variables for the autocreated branch."},"framework":{"type":"string","description":"The framework for the autocreated branch."},"pullRequestEnvironmentName":{"type":"string","description":"If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI.\n\nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true` .\n\nIf you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed.\n\nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* ."},"stage":{"$ref":"#/types/aws-native:amplify:AppAutoBranchCreationConfigStage","description":"Stage for the auto created branch."}},"type":"object"},"aws-native:amplify:AppAutoBranchCreationConfigStage":{"description":"Stage for the auto created branch.","type":"string","enum":[{"name":"Experimental","value":"EXPERIMENTAL"},{"name":"Beta","value":"BETA"},{"name":"PullRequest","value":"PULL_REQUEST"},{"name":"Production","value":"PRODUCTION"},{"name":"Development","value":"DEVELOPMENT"}]},"aws-native:amplify:AppBasicAuthConfig":{"properties":{"enableBasicAuth":{"type":"boolean","description":"Enables basic authorization for the Amplify app's branches."},"password":{"type":"string","description":"The password for basic authorization."},"username":{"type":"string","description":"The user name for basic authorization."}},"type":"object"},"aws-native:amplify:AppCacheConfig":{"properties":{"type":{"$ref":"#/types/aws-native:amplify:AppCacheConfigType","description":"The type of cache configuration to use for an Amplify app.\n\nThe `AMPLIFY_MANAGED` cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules.\n\nThe `AMPLIFY_MANAGED_NO_COOKIES` cache configuration type is the same as `AMPLIFY_MANAGED` , except that it excludes all cookies from the cache key. This is the default setting."}},"type":"object"},"aws-native:amplify:AppCacheConfigType":{"description":"The type of cache configuration to use for an Amplify app.\n\nThe `AMPLIFY_MANAGED` cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules.\n\nThe `AMPLIFY_MANAGED_NO_COOKIES` cache configuration type is the same as `AMPLIFY_MANAGED` , except that it excludes all cookies from the cache key. This is the default setting.","type":"string","enum":[{"name":"AmplifyManaged","value":"AMPLIFY_MANAGED"},{"name":"AmplifyManagedNoCookies","value":"AMPLIFY_MANAGED_NO_COOKIES"}]},"aws-native:amplify:AppCustomRule":{"properties":{"condition":{"type":"string","description":"The condition for a URL rewrite or redirect rule, such as a country code."},"source":{"type":"string","description":"The source pattern for a URL rewrite or redirect rule."},"status":{"type":"string","description":"The status code for a URL rewrite or redirect rule.\n\n- **200** - Represents a 200 rewrite rule.\n- **301** - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.\n- **302** - Represents a 302 temporary redirect rule.\n- **404** - Represents a 404 redirect rule.\n- **404-200** - Represents a 404 rewrite rule."},"target":{"type":"string","description":"The target pattern for a URL rewrite or redirect rule."}},"type":"object","required":["source","target"]},"aws-native:amplify:AppEnvironmentVariable":{"properties":{"name":{"type":"string","description":"The environment variable name."},"value":{"type":"string","description":"The environment variable value."}},"type":"object","required":["name","value"]},"aws-native:amplify:AppJobConfig":{"properties":{"buildComputeType":{"$ref":"#/types/aws-native:amplify:AppJobConfigBuildComputeType","description":"Specifies the size of the build instance. Amplify supports three instance sizes: `STANDARD_8GB` , `LARGE_16GB` , and `XLARGE_72GB` . If you don't specify a value, Amplify uses the `STANDARD_8GB` default.\n\nThe following list describes the CPU, memory, and storage capacity for each build instance type:\n\n- **STANDARD_8GB** - - vCPUs: 4\n- Memory: 8 GiB\n- Disk space: 128 GB\n- **LARGE_16GB** - - vCPUs: 8\n- Memory: 16 GiB\n- Disk space: 128 GB\n- **XLARGE_72GB** - - vCPUs: 36\n- Memory: 72 GiB\n- Disk space: 256 GB"}},"type":"object","required":["buildComputeType"]},"aws-native:amplify:AppJobConfigBuildComputeType":{"description":"Specifies the size of the build instance. Amplify supports three instance sizes: `STANDARD_8GB` , `LARGE_16GB` , and `XLARGE_72GB` . If you don't specify a value, Amplify uses the `STANDARD_8GB` default.\n\nThe following list describes the CPU, memory, and storage capacity for each build instance type:\n\n- **STANDARD_8GB** - - vCPUs: 4\n- Memory: 8 GiB\n- Disk space: 128 GB\n- **LARGE_16GB** - - vCPUs: 8\n- Memory: 16 GiB\n- Disk space: 128 GB\n- **XLARGE_72GB** - - vCPUs: 36\n- Memory: 72 GiB\n- Disk space: 256 GB","type":"string","enum":[{"name":"Standard8gb","value":"STANDARD_8GB"},{"name":"Large16gb","value":"LARGE_16GB"},{"name":"Xlarge72gb","value":"XLARGE_72GB"}]},"aws-native:amplify:AppPlatform":{"description":"The platform for the Amplify app. For a static app, set the platform type to `WEB` . For a dynamic server-side rendered (SSR) app, set the platform type to `WEB_COMPUTE` . For an app requiring Amplify Hosting's original SSR support only, set the platform type to `WEB_DYNAMIC` .\n\nIf you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to `WEB_COMPUTE` and set the artifacts `baseDirectory` to `.next` in the application's build settings. For an example of the build specification settings, see [Amplify build settings for a Next.js 14 SSG application](https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14) in the *Amplify Hosting User Guide* .","type":"string","enum":[{"name":"Web","value":"WEB"},{"name":"WebDynamic","value":"WEB_DYNAMIC"},{"name":"WebCompute","value":"WEB_COMPUTE"}]},"aws-native:amplify:AppTag":{"properties":{"key":{"type":"string","description":"Specifies the key for the tag."},"value":{"type":"string","description":"Specifies the value for the tag."}},"type":"object","required":["key","value"]},"aws-native:amplify:BranchBackend":{"properties":{"stackArn":{"type":"string","description":"The Amazon Resource Name (ARN) for the CloudFormation stack."}},"type":"object"},"aws-native:amplify:BranchBasicAuthConfig":{"properties":{"enableBasicAuth":{"type":"boolean","description":"Enables basic authorization for the branch."},"password":{"type":"string","description":"The password for basic authorization."},"username":{"type":"string"}},"type":"object","required":["password","username"]},"aws-native:amplify:BranchEnvironmentVariable":{"properties":{"name":{"type":"string","description":"The environment variable name."},"value":{"type":"string","description":"The environment variable value."}},"type":"object","required":["name","value"]},"aws-native:amplify:BranchStage":{"description":"Describes the current stage for the branch.","type":"string","enum":[{"name":"Experimental","value":"EXPERIMENTAL"},{"name":"Beta","value":"BETA"},{"name":"PullRequest","value":"PULL_REQUEST"},{"name":"Production","value":"PRODUCTION"},{"name":"Development","value":"DEVELOPMENT"}]},"aws-native:amplify:BranchTag":{"properties":{"key":{"type":"string","description":"Specifies the key for the tag."},"value":{"type":"string","description":"Specifies the value for the tag."}},"type":"object","required":["key","value"]},"aws-native:amplify:DomainCertificate":{"properties":{"certificateArn":{"type":"string","description":"The Amazon resource name (ARN) for a custom certificate that you have already added to Certificate Manager in your AWS account .\n\nThis field is required only when the certificate type is `CUSTOM` ."},"certificateType":{"$ref":"#/types/aws-native:amplify:DomainCertificateCertificateType","description":"The type of SSL/TLS certificate that you want to use.\n\nSpecify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.\n\nSpecify `CUSTOM` to use your own certificate that you have already added to Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* ."},"certificateVerificationDnsRecord":{"type":"string","description":"The DNS record for certificate verification."}},"type":"object"},"aws-native:amplify:DomainCertificateCertificateType":{"description":"The type of SSL/TLS certificate that you want to use.\n\nSpecify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.\n\nSpecify `CUSTOM` to use your own certificate that you have already added to Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* .","type":"string","enum":[{"name":"AmplifyManaged","value":"AMPLIFY_MANAGED"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:amplify:DomainCertificateSettings":{"properties":{"certificateType":{"$ref":"#/types/aws-native:amplify:DomainCertificateSettingsCertificateType","description":"The certificate type.\n\nSpecify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.\n\nSpecify `CUSTOM` to use your own certificate that you have already added to Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* ."},"customCertificateArn":{"type":"string","description":"The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate Manager in your AWS account .\n\nThis field is required only when the certificate type is `CUSTOM` ."}},"type":"object"},"aws-native:amplify:DomainCertificateSettingsCertificateType":{"description":"The certificate type.\n\nSpecify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.\n\nSpecify `CUSTOM` to use your own certificate that you have already added to Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* .","type":"string","enum":[{"name":"AmplifyManaged","value":"AMPLIFY_MANAGED"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:amplify:DomainSubDomainSetting":{"properties":{"branchName":{"type":"string","description":"The branch name setting for the subdomain.\n\n*Length Constraints:* Minimum length of 1. Maximum length of 255.\n\n*Pattern:* (?s).+"},"prefix":{"type":"string","description":"The prefix setting for the subdomain."}},"type":"object","required":["branchName","prefix"]},"aws-native:amplifyuibuilder:ComponentActionParameters":{"properties":{"anchor":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentProperty","description":"The HTML anchor link to the location to open. Specify this value for a navigation action."},"fields":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentProperty"},"description":"A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model."},"global":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentProperty","description":"Specifies whether the user should be signed out globally. Specify this value for an auth sign out action."},"id":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentProperty","description":"The unique ID of the component that the `ActionParameters` apply to."},"model":{"type":"string","description":"The name of the data model. Use when the action performs an operation on an Amplify DataStore model."},"state":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentMutationActionSetStateParameter","description":"A key-value pair that specifies the state property name and its initial value."},"target":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentProperty","description":"The element within the same component to modify when the action occurs."},"type":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentProperty","description":"The type of navigation action. Valid values are `url` and `anchor` . This value is required for a navigation action."},"url":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentProperty","description":"The URL to the location to open. Specify this value for a navigation action."}},"type":"object"},"aws-native:amplifyuibuilder:ComponentBindingPropertiesValue":{"properties":{"bindingProperties":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentBindingPropertiesValueProperties","description":"Describes the properties to customize with data at runtime."},"defaultValue":{"type":"string","description":"The default value of the property."},"type":{"type":"string","description":"The property type."}},"type":"object"},"aws-native:amplifyuibuilder:ComponentBindingPropertiesValueProperties":{"properties":{"bucket":{"type":"string","description":"An Amazon S3 bucket."},"defaultValue":{"type":"string","description":"The default value to assign to the property."},"field":{"type":"string","description":"The field to bind the data to."},"key":{"type":"string","description":"The storage key for an Amazon S3 bucket."},"model":{"type":"string","description":"An Amplify DataStore model."},"predicates":{"type":"array","items":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentPredicate"},"description":"A list of predicates for binding a component's properties to data."},"slotName":{"type":"string","description":"The name of a component slot."},"userAttribute":{"type":"string","description":"An authenticated user attribute."}},"type":"object"},"aws-native:amplifyuibuilder:ComponentChild":{"properties":{"children":{"type":"array","items":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentChild"},"description":"The list of `ComponentChild` instances for this component."},"componentType":{"type":"string","description":"The type of the child component."},"events":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentEvent"},"description":"Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components."},"name":{"type":"string","description":"The name of the child component."},"properties":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentProperty"},"description":"Describes the properties of the child component. You can't specify `tags` as a valid property for `properties` ."},"sourceId":{"type":"string","description":"The unique ID of the child component in its original source system, such as Figma."}},"type":"object","required":["componentType","name","properties"]},"aws-native:amplifyuibuilder:ComponentConditionProperty":{"properties":{"else":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentProperty","description":"The value to assign to the property if the condition is not met."},"field":{"type":"string","description":"The name of a field. Specify this when the property is a data model."},"operand":{"type":"string","description":"The value of the property to evaluate."},"operandType":{"type":"string","description":"The type of the property to evaluate."},"operator":{"type":"string","description":"The operator to use to perform the evaluation, such as `eq` to represent equals."},"property":{"type":"string","description":"The name of the conditional property."},"then":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentProperty","description":"The value to assign to the property if the condition is met."}},"type":"object"},"aws-native:amplifyuibuilder:ComponentDataConfiguration":{"properties":{"identifiers":{"type":"array","items":{"type":"string"},"description":"A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query."},"model":{"type":"string","description":"The name of the data model to use to bind data to a component."},"predicate":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentPredicate","description":"Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection."},"sort":{"type":"array","items":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentSortProperty"},"description":"Describes how to sort the component's properties."}},"type":"object","required":["model"]},"aws-native:amplifyuibuilder:ComponentEvent":{"properties":{"action":{"type":"string","description":"The action to perform when a specific event is raised."},"bindingEvent":{"type":"string","description":"Binds an event to an action on a component. When you specify a `bindingEvent` , the event is called when the action is performed."},"parameters":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentActionParameters","description":"Describes information about the action."}},"type":"object"},"aws-native:amplifyuibuilder:ComponentFormBindingElement":{"properties":{"element":{"type":"string","description":"The name of the component to retrieve a value from."},"property":{"type":"string","description":"The property to retrieve a value from."}},"type":"object","required":["element","property"]},"aws-native:amplifyuibuilder:ComponentMutationActionSetStateParameter":{"properties":{"componentName":{"type":"string","description":"The name of the component that is being modified."},"property":{"type":"string","description":"The name of the component property to apply the state configuration to."},"set":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentProperty","description":"The state configuration to assign to the property."}},"type":"object","required":["componentName","property","set"]},"aws-native:amplifyuibuilder:ComponentPredicate":{"properties":{"and":{"type":"array","items":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentPredicate"},"description":"A list of predicates to combine logically."},"field":{"type":"string","description":"The field to query."},"operand":{"type":"string","description":"The value to use when performing the evaluation."},"operandType":{"type":"string","description":"The type of value to use when performing the evaluation."},"operator":{"type":"string","description":"The operator to use to perform the evaluation."},"or":{"type":"array","items":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentPredicate"},"description":"A list of predicates to combine logically."}},"type":"object"},"aws-native:amplifyuibuilder:ComponentProperty":{"properties":{"bindingProperties":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentPropertyBindingProperties","description":"The information to bind the component property to data at runtime."},"bindings":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentFormBindingElement"},"description":"The information to bind the component property to form data."},"collectionBindingProperties":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentPropertyBindingProperties","description":"The information to bind the component property to data at runtime. Use this for collection components."},"componentName":{"type":"string","description":"The name of the component that is affected by an event."},"concat":{"type":"array","items":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentProperty"},"description":"A list of component properties to concatenate to create the value to assign to this component property."},"condition":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentConditionProperty","description":"The conditional expression to use to assign a value to the component property."},"configured":{"type":"boolean","description":"Specifies whether the user configured the property in Amplify Studio after importing it."},"defaultValue":{"type":"string","description":"The default value to assign to the component property."},"event":{"type":"string","description":"An event that occurs in your app. Use this for workflow data binding."},"importedValue":{"type":"string","description":"The default value assigned to the property when the component is imported into an app."},"model":{"type":"string","description":"The data model to use to assign a value to the component property."},"property":{"type":"string","description":"The name of the component's property that is affected by an event."},"type":{"type":"string","description":"The component type."},"userAttribute":{"type":"string","description":"An authenticated user attribute to use to assign a value to the component property."},"value":{"type":"string","description":"The value to assign to the component property."}},"type":"object"},"aws-native:amplifyuibuilder:ComponentPropertyBindingProperties":{"properties":{"field":{"type":"string","description":"The data field to bind the property to."},"property":{"type":"string","description":"The component property to bind to the data field."}},"type":"object","required":["property"]},"aws-native:amplifyuibuilder:ComponentSortDirection":{"type":"string","enum":[{"name":"Asc","value":"ASC"},{"name":"Desc","value":"DESC"}]},"aws-native:amplifyuibuilder:ComponentSortProperty":{"properties":{"direction":{"$ref":"#/types/aws-native:amplifyuibuilder:ComponentSortDirection","description":"The direction of the sort, either ascending or descending."},"field":{"type":"string","description":"The field to perform the sort on."}},"type":"object","required":["direction","field"]},"aws-native:amplifyuibuilder:ComponentVariant":{"properties":{"overrides":{"type":"object","additionalProperties":{"$ref":"pulumi.json#/Any"},"description":"The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify `tags` as a valid property for `overrides` ."},"variantValues":{"type":"object","additionalProperties":{"type":"string"},"description":"The combination of variants that comprise this variant."}},"type":"object"},"aws-native:amplifyuibuilder:FormActionType":{"type":"string","enum":[{"name":"Create","value":"create"},{"name":"Update","value":"update"}]},"aws-native:amplifyuibuilder:FormButton":{"properties":{"children":{"type":"string","description":"Describes the button's properties."},"excluded":{"type":"boolean","description":"Specifies whether the button is visible on the form."},"position":{"oneOf":[{"$ref":"#/types/aws-native:amplifyuibuilder:FormFieldPosition0Properties"},{"$ref":"#/types/aws-native:amplifyuibuilder:FormFieldPosition1Properties"},{"$ref":"#/types/aws-native:amplifyuibuilder:FormFieldPosition2Properties"}],"description":"The position of the button."}},"type":"object"},"aws-native:amplifyuibuilder:FormButtonsPosition":{"type":"string","enum":[{"name":"Top","value":"top"},{"name":"Bottom","value":"bottom"},{"name":"TopAndBottom","value":"top_and_bottom"}]},"aws-native:amplifyuibuilder:FormCta":{"properties":{"cancel":{"$ref":"#/types/aws-native:amplifyuibuilder:FormButton","description":"Displays a cancel button."},"clear":{"$ref":"#/types/aws-native:amplifyuibuilder:FormButton","description":"Displays a clear button."},"position":{"$ref":"#/types/aws-native:amplifyuibuilder:FormButtonsPosition","description":"The position of the button."},"submit":{"$ref":"#/types/aws-native:amplifyuibuilder:FormButton","description":"Displays a submit button."}},"type":"object"},"aws-native:amplifyuibuilder:FormDataSourceType":{"type":"string","enum":[{"name":"DataStore","value":"DataStore"},{"name":"Custom","value":"Custom"}]},"aws-native:amplifyuibuilder:FormDataTypeConfig":{"properties":{"dataSourceType":{"$ref":"#/types/aws-native:amplifyuibuilder:FormDataSourceType","description":"The data source type, either an Amplify DataStore model or a custom data type."},"dataTypeName":{"type":"string","description":"The unique name of the data type you are using as the data source for the form."}},"type":"object","required":["dataSourceType","dataTypeName"]},"aws-native:amplifyuibuilder:FormFieldConfig":{"properties":{"excluded":{"type":"boolean","description":"Specifies whether to hide a field."},"inputType":{"$ref":"#/types/aws-native:amplifyuibuilder:FormFieldInputConfig","description":"Describes the configuration for the default input value to display for a field."},"label":{"type":"string","description":"The label for the field."},"position":{"oneOf":[{"$ref":"#/types/aws-native:amplifyuibuilder:FormFieldPosition0Properties"},{"$ref":"#/types/aws-native:amplifyuibuilder:FormFieldPosition1Properties"},{"$ref":"#/types/aws-native:amplifyuibuilder:FormFieldPosition2Properties"}],"description":"Specifies the field position."},"validations":{"type":"array","items":{"$ref":"#/types/aws-native:amplifyuibuilder:FormFieldValidationConfiguration"},"description":"The validations to perform on the value in the field."}},"type":"object"},"aws-native:amplifyuibuilder:FormFieldInputConfig":{"properties":{"defaultChecked":{"type":"boolean","description":"Specifies whether a field has a default value."},"defaultCountryCode":{"type":"string","description":"The default country code for a phone number."},"defaultValue":{"type":"string","description":"The default value for the field."},"descriptiveText":{"type":"string","description":"The text to display to describe the field."},"fileUploaderConfig":{"$ref":"#/types/aws-native:amplifyuibuilder:FormFileUploaderFieldConfig","description":"The configuration for the file uploader field."},"isArray":{"type":"boolean","description":"Specifies whether to render the field as an array. This property is ignored if the `dataSourceType` for the form is a Data Store."},"maxValue":{"type":"number","description":"The maximum value to display for the field."},"minValue":{"type":"number","description":"The minimum value to display for the field."},"name":{"type":"string","description":"The name of the field."},"placeholder":{"type":"string","description":"The text to display as a placeholder for the field."},"readOnly":{"type":"boolean","description":"Specifies a read only field."},"required":{"type":"boolean","description":"Specifies a field that requires input."},"step":{"type":"number","description":"The stepping increment for a numeric value in a field."},"type":{"type":"string","description":"The input type for the field."},"value":{"type":"string","description":"The value for the field."},"valueMappings":{"$ref":"#/types/aws-native:amplifyuibuilder:FormValueMappings","description":"The information to use to customize the input fields with data at runtime."}},"type":"object","required":["type"]},"aws-native:amplifyuibuilder:FormFieldPosition0Properties":{"properties":{"fixed":{"$ref":"#/types/aws-native:amplifyuibuilder:FormFixedPosition"}},"type":"object","required":["fixed"]},"aws-native:amplifyuibuilder:FormFieldPosition1Properties":{"properties":{"rightOf":{"type":"string"}},"type":"object","required":["rightOf"]},"aws-native:amplifyuibuilder:FormFieldPosition2Properties":{"properties":{"below":{"type":"string"}},"type":"object","required":["below"]},"aws-native:amplifyuibuilder:FormFieldValidationConfiguration":{"properties":{"numValues":{"type":"array","items":{"type":"number"},"description":"The validation to perform on a number value."},"strValues":{"type":"array","items":{"type":"string"},"description":"The validation to perform on a string value."},"type":{"type":"string","description":"The validation to perform on an object type. ``"},"validationMessage":{"type":"string","description":"The validation message to display."}},"type":"object","required":["type"]},"aws-native:amplifyuibuilder:FormFileUploaderFieldConfig":{"properties":{"acceptedFileTypes":{"type":"array","items":{"type":"string"},"description":"The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions."},"accessLevel":{"$ref":"#/types/aws-native:amplifyuibuilder:FormStorageAccessLevel","description":"The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are `private` , `protected` , or `public` . For detailed information about the permissions associated with each access level, see [File access levels](https://docs.aws.amazon.com/https://docs.amplify.aws/lib/storage/configureaccess/q/platform/js/) in the *Amplify documentation* ."},"isResumable":{"type":"boolean","description":"Allows the file upload operation to be paused and resumed. The default value is `false` .\n\nWhen `isResumable` is set to `true` , the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time."},"maxFileCount":{"type":"number","description":"Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files."},"maxSize":{"type":"number","description":"The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size."},"showThumbnails":{"type":"boolean","description":"Specifies whether to display or hide the image preview after selecting a file for upload. The default value is `true` to display the image preview."}},"type":"object","required":["acceptedFileTypes","accessLevel"]},"aws-native:amplifyuibuilder:FormFixedPosition":{"type":"string","enum":[{"name":"First","value":"first"}]},"aws-native:amplifyuibuilder:FormInputBindingPropertiesValue":{"properties":{"bindingProperties":{"$ref":"#/types/aws-native:amplifyuibuilder:FormInputBindingPropertiesValueProperties","description":"Describes the properties to customize with data at runtime."},"type":{"type":"string","description":"The property type."}},"type":"object"},"aws-native:amplifyuibuilder:FormInputBindingPropertiesValueProperties":{"properties":{"model":{"type":"string","description":"An Amplify DataStore model."}},"type":"object"},"aws-native:amplifyuibuilder:FormInputValueProperty":{"properties":{"bindingProperties":{"$ref":"#/types/aws-native:amplifyuibuilder:FormInputValuePropertyBindingProperties","description":"The information to bind fields to data at runtime."},"concat":{"type":"array","items":{"$ref":"#/types/aws-native:amplifyuibuilder:FormInputValueProperty"},"description":"A list of form properties to concatenate to create the value to assign to this field property."},"value":{"type":"string","description":"The value to assign to the input field."}},"type":"object"},"aws-native:amplifyuibuilder:FormInputValuePropertyBindingProperties":{"properties":{"field":{"type":"string","description":"The data field to bind the property to."},"property":{"type":"string","description":"The form property to bind to the data field."}},"type":"object","required":["property"]},"aws-native:amplifyuibuilder:FormLabelDecorator":{"type":"string","enum":[{"name":"Required","value":"required"},{"name":"Optional","value":"optional"},{"name":"None","value":"none"}]},"aws-native:amplifyuibuilder:FormSectionalElement":{"properties":{"excluded":{"type":"boolean","description":"Excludes a sectional element that was generated by default for a specified data model."},"level":{"type":"number","description":"Specifies the size of the font for a `Heading` sectional element. Valid values are `1 | 2 | 3 | 4 | 5 | 6` ."},"orientation":{"type":"string","description":"Specifies the orientation for a `Divider` sectional element. Valid values are `horizontal` or `vertical` ."},"position":{"oneOf":[{"$ref":"#/types/aws-native:amplifyuibuilder:FormFieldPosition0Properties"},{"$ref":"#/types/aws-native:amplifyuibuilder:FormFieldPosition1Properties"},{"$ref":"#/types/aws-native:amplifyuibuilder:FormFieldPosition2Properties"}],"description":"Specifies the position of the text in a field for a `Text` sectional element."},"text":{"type":"string","description":"The text for a `Text` sectional element."},"type":{"type":"string","description":"The type of sectional element. Valid values are `Heading` , `Text` , and `Divider` ."}},"type":"object","required":["type"]},"aws-native:amplifyuibuilder:FormStorageAccessLevel":{"type":"string","enum":[{"name":"Public","value":"public"},{"name":"Protected","value":"protected"},{"name":"Private","value":"private"}]},"aws-native:amplifyuibuilder:FormStyle":{"properties":{"horizontalGap":{"oneOf":[{"$ref":"#/types/aws-native:amplifyuibuilder:FormStyleConfig0Properties"},{"$ref":"#/types/aws-native:amplifyuibuilder:FormStyleConfig1Properties"}],"description":"The spacing for the horizontal gap."},"outerPadding":{"oneOf":[{"$ref":"#/types/aws-native:amplifyuibuilder:FormStyleConfig0Properties"},{"$ref":"#/types/aws-native:amplifyuibuilder:FormStyleConfig1Properties"}],"description":"The size of the outer padding for the form."},"verticalGap":{"oneOf":[{"$ref":"#/types/aws-native:amplifyuibuilder:FormStyleConfig0Properties"},{"$ref":"#/types/aws-native:amplifyuibuilder:FormStyleConfig1Properties"}],"description":"The spacing for the vertical gap."}},"type":"object"},"aws-native:amplifyuibuilder:FormStyleConfig0Properties":{"properties":{"tokenReference":{"type":"string"}},"type":"object","required":["tokenReference"]},"aws-native:amplifyuibuilder:FormStyleConfig1Properties":{"properties":{"value":{"type":"string"}},"type":"object","required":["value"]},"aws-native:amplifyuibuilder:FormValueMapping":{"properties":{"displayValue":{"$ref":"#/types/aws-native:amplifyuibuilder:FormInputValueProperty","description":"The value to display for the complex object."},"value":{"$ref":"#/types/aws-native:amplifyuibuilder:FormInputValueProperty","description":"The complex object."}},"type":"object","required":["value"]},"aws-native:amplifyuibuilder:FormValueMappings":{"properties":{"bindingProperties":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:amplifyuibuilder:FormInputBindingPropertiesValue"},"description":"The information to bind fields to data at runtime."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:amplifyuibuilder:FormValueMapping"},"description":"The value and display value pairs."}},"type":"object","required":["values"]},"aws-native:amplifyuibuilder:ThemeValue":{"properties":{"children":{"type":"array","items":{"$ref":"#/types/aws-native:amplifyuibuilder:ThemeValues"},"description":"A list of key-value pairs that define the theme's properties."},"value":{"type":"string","description":"The value of a theme property."}},"type":"object"},"aws-native:amplifyuibuilder:ThemeValues":{"properties":{"key":{"type":"string","description":"The name of the property."},"value":{"$ref":"#/types/aws-native:amplifyuibuilder:ThemeValue","description":"The value of the property."}},"type":"object"},"aws-native:apigateway:ApiKeyStageKey":{"description":"``StageKey`` is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.","properties":{"restApiId":{"type":"string","description":"The string identifier of the associated RestApi."},"stageName":{"type":"string","description":"The stage name associated with the stage key."}},"type":"object"},"aws-native:apigateway:ApiKeyTag":{"description":"An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:apigateway:ClientCertificateTag":{"description":"An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:apigateway:DeploymentAccessLogSetting":{"description":"The ``AccessLogSetting`` property type specifies settings for logging access in this stage.\n ``AccessLogSetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.","properties":{"destinationArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with `amazon-apigateway-` ."},"format":{"type":"string","description":"A single line format of the access logs of data, as specified by selected $context variables. The format must include at least `$context.requestId` ."}},"type":"object"},"aws-native:apigateway:DeploymentCanarySetting":{"description":"The ``CanarySetting`` property type specifies settings for the canary deployment in this stage.\n ``CanarySetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.","properties":{"percentTraffic":{"type":"number","description":"The percent (0-100) of traffic diverted to a canary deployment."},"stageVariableOverrides":{"type":"object","additionalProperties":{"type":"string"},"description":"Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values."},"useStageCache":{"type":"boolean","description":"A Boolean flag to indicate whether the canary deployment uses the stage cache or not."}},"type":"object"},"aws-native:apigateway:DeploymentCanarySettings":{"description":"The ``DeploymentCanarySettings`` property type specifies settings for the canary deployment.","properties":{"percentTraffic":{"type":"number","description":"The percentage (0.0-100.0) of traffic routed to the canary deployment."},"stageVariableOverrides":{"type":"object","additionalProperties":{"type":"string"},"description":"A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values."},"useStageCache":{"type":"boolean","description":"A Boolean flag to indicate whether the canary release deployment uses the stage cache or not."}},"type":"object"},"aws-native:apigateway:DeploymentMethodSetting":{"description":"The ``MethodSetting`` property type configures settings for all methods in a stage.\n The ``MethodSettings`` property of the [Amazon API Gateway Deployment StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type contains a list of ``MethodSetting`` property types.","properties":{"cacheDataEncrypted":{"type":"boolean","description":"Specifies whether the cached responses are encrypted."},"cacheTtlInSeconds":{"type":"integer","description":"Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached."},"cachingEnabled":{"type":"boolean","description":"Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached."},"dataTraceEnabled":{"type":"boolean","description":"Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs."},"httpMethod":{"type":"string","description":"The HTTP method."},"loggingLevel":{"type":"string","description":"Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are `OFF` , `ERROR` , and `INFO` . Choose `ERROR` to write only error-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events."},"metricsEnabled":{"type":"boolean","description":"Specifies whether Amazon CloudWatch metrics are enabled for this method."},"resourcePath":{"type":"string","description":"The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``)."},"throttlingBurstLimit":{"type":"integer","description":"Specifies the throttling burst limit."},"throttlingRateLimit":{"type":"number","description":"Specifies the throttling rate limit."}},"type":"object"},"aws-native:apigateway:DeploymentStageDescription":{"description":"``StageDescription`` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.","properties":{"accessLogSetting":{"$ref":"#/types/aws-native:apigateway:DeploymentAccessLogSetting","description":"Specifies settings for logging access in this stage."},"cacheClusterEnabled":{"type":"boolean","description":"Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set `CachingEnabled` to `true` for a method."},"cacheClusterSize":{"type":"string","description":"The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*."},"cacheDataEncrypted":{"type":"boolean","description":"Indicates whether the cached responses are encrypted."},"cacheTtlInSeconds":{"type":"integer","description":"The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses."},"cachingEnabled":{"type":"boolean","description":"Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*."},"canarySetting":{"$ref":"#/types/aws-native:apigateway:DeploymentCanarySetting","description":"Specifies settings for the canary deployment in this stage."},"clientCertificateId":{"type":"string","description":"The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage."},"dataTraceEnabled":{"type":"boolean","description":"Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs."},"description":{"type":"string","description":"A description of the purpose of the stage."},"documentationVersion":{"type":"string","description":"The version identifier of the API documentation snapshot."},"loggingLevel":{"type":"string","description":"The logging level for this method. For valid values, see the ``loggingLevel`` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*."},"methodSettings":{"type":"array","items":{"$ref":"#/types/aws-native:apigateway:DeploymentMethodSetting"},"description":"Configures settings for all of the stage's methods."},"metricsEnabled":{"type":"boolean","description":"Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:apigateway:DeploymentTag"},"description":"An array of arbitrary tags (key-value pairs) to associate with the stage."},"throttlingBurstLimit":{"type":"integer","description":"The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*."},"throttlingRateLimit":{"type":"number","description":"The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*."},"tracingEnabled":{"type":"boolean","description":"Specifies whether active tracing with X-ray is enabled for this stage.\n For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*."},"variables":{"type":"object","additionalProperties":{"type":"string"},"description":"A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: ``[A-Za-z0-9-._~:/?#\u0026=,]+``."}},"type":"object"},"aws-native:apigateway:DeploymentTag":{"description":"An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:apigateway:DocumentationPartLocation":{"description":"The ``Location`` property specifies the location of the Amazon API Gateway API entity that the documentation applies to. ``Location`` is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.\n  For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.","properties":{"method":{"type":"string","description":"The HTTP verb of a method. It is a valid field for the API entity types of `METHOD` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` , `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . The default value is `*` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other `location` attributes, the child entity's `method` attribute must match that of the parent entity exactly."},"name":{"type":"string","description":"The name of the targeted API entity. It is a valid and required field for the API entity types of `AUTHORIZER` , `MODEL` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` and `RESPONSE_HEADER` . It is an invalid field for any other entity type."},"path":{"type":"string","description":"The URL path of the target. It is a valid field for the API entity types of `RESOURCE` , `METHOD` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` , `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . The default value is `/` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other `location` attributes, the child entity's `path` attribute must match that of the parent entity as a prefix."},"statusCode":{"type":"string","description":"The HTTP status code of a response. It is a valid field for the API entity types of `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . The default value is `*` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other `location` attributes, the child entity's `statusCode` attribute must match that of the parent entity exactly."},"type":{"$ref":"#/types/aws-native:apigateway:DocumentationPartLocationType","description":"The type of API entity to which the documentation content applies. Valid values are `API` , `AUTHORIZER` , `MODEL` , `RESOURCE` , `METHOD` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` , `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . Content inheritance does not apply to any entity of the `API` , `AUTHORIZER` , `METHOD` , `MODEL` , `REQUEST_BODY` , or `RESOURCE` type."}},"type":"object"},"aws-native:apigateway:DocumentationPartLocationType":{"description":"The type of API entity to which the documentation content applies. Valid values are `API` , `AUTHORIZER` , `MODEL` , `RESOURCE` , `METHOD` , `PATH_PARAMETER` , `QUERY_PARAMETER` , `REQUEST_HEADER` , `REQUEST_BODY` , `RESPONSE` , `RESPONSE_HEADER` , and `RESPONSE_BODY` . Content inheritance does not apply to any entity of the `API` , `AUTHORIZER` , `METHOD` , `MODEL` , `REQUEST_BODY` , or `RESOURCE` type.","type":"string","enum":[{"name":"Api","value":"API"},{"name":"Authorizer","value":"AUTHORIZER"},{"name":"Model","value":"MODEL"},{"name":"Resource","value":"RESOURCE"},{"name":"Method","value":"METHOD"},{"name":"PathParameter","value":"PATH_PARAMETER"},{"name":"QueryParameter","value":"QUERY_PARAMETER"},{"name":"RequestHeader","value":"REQUEST_HEADER"},{"name":"RequestBody","value":"REQUEST_BODY"},{"name":"Response","value":"RESPONSE"},{"name":"ResponseHeader","value":"RESPONSE_HEADER"},{"name":"ResponseBody","value":"RESPONSE_BODY"}]},"aws-native:apigateway:DomainNameAccessAssociationAccessAssociationSourceType":{"description":"The source type of the domain name access association resource.","type":"string","enum":[{"name":"Vpce","value":"VPCE"}]},"aws-native:apigateway:DomainNameAccessAssociationTag":{"properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:apigateway:DomainNameEndpointConfiguration":{"description":"The ``EndpointConfiguration`` property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.\n ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.","properties":{"ipAddressType":{"type":"string","description":"The IP address types that can invoke this DomainName. Use `ipv4` to allow only IPv4 addresses to invoke this DomainName, or use `dualstack` to allow both IPv4 and IPv6 addresses to invoke this DomainName. For the `PRIVATE` endpoint type, only `dualstack` is supported."},"types":{"type":"array","items":{"type":"string"},"description":"A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is `\"EDGE\"` . For a regional API and its custom domain name, the endpoint type is `REGIONAL` . For a private API, the endpoint type is `PRIVATE` ."}},"type":"object"},"aws-native:apigateway:DomainNameMutualTlsAuthentication":{"properties":{"truststoreUri":{"type":"string","description":"An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example `s3://bucket-name/key-name` . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object."},"truststoreVersion":{"type":"string","description":"The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket."}},"type":"object"},"aws-native:apigateway:DomainNameRoutingMode":{"description":"The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your public APIs.","type":"string","enum":[{"name":"BasePathMappingOnly","value":"BASE_PATH_MAPPING_ONLY"},{"name":"RoutingRuleThenBasePathMapping","value":"ROUTING_RULE_THEN_BASE_PATH_MAPPING"},{"name":"RoutingRuleOnly","value":"ROUTING_RULE_ONLY"}]},"aws-native:apigateway:DomainNameTag":{"description":"An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object"},"aws-native:apigateway:DomainNameV2EndpointConfiguration":{"properties":{"ipAddressType":{"type":"string","description":"The IP address types that can invoke an API (RestApi) or a DomainName. Use `ipv4` to allow only IPv4 addresses to invoke an API or DomainName, or use `dualstack` to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the `PRIVATE` endpoint type, only `dualstack` is supported."},"types":{"type":"array","items":{"type":"string"},"description":"A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is `\"EDGE\"` . For a regional API and its custom domain name, the endpoint type is `REGIONAL` . For a private API, the endpoint type is `PRIVATE` ."}},"type":"object"},"aws-native:apigateway:DomainNameV2RoutingMode":{"description":"The valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.","type":"string","enum":[{"name":"BasePathMappingOnly","value":"BASE_PATH_MAPPING_ONLY"},{"name":"RoutingRuleThenBasePathMapping","value":"ROUTING_RULE_THEN_BASE_PATH_MAPPING"},{"name":"RoutingRuleOnly","value":"ROUTING_RULE_ONLY"}]},"aws-native:apigateway:DomainNameV2Tag":{"properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object"},"aws-native:apigateway:MethodIntegration":{"description":"``Integration`` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.","properties":{"cacheKeyParameters":{"type":"array","items":{"type":"string"},"description":"A list of request parameters whose values API Gateway caches. To be valid values for `cacheKeyParameters` , these parameters must also be specified for Method `requestParameters` ."},"cacheNamespace":{"type":"string","description":"Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the `cacheNamespace` . You can specify the same `cacheNamespace` across resources to return the same cached data for requests to different resources."},"connectionId":{"type":"string","description":"The ID of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise."},"connectionType":{"$ref":"#/types/aws-native:apigateway:MethodIntegrationConnectionType","description":"The type of the network connection to the integration endpoint. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC. The default value is `INTERNET` ."},"contentHandling":{"$ref":"#/types/aws-native:apigateway:MethodIntegrationContentHandling","description":"Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT` , with the following behaviors:\n\nIf this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass-through."},"credentials":{"type":"string","description":"Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string `arn:aws:iam::\\*:user/\\*` . To use resource-based permissions on supported AWS services, specify null."},"integrationHttpMethod":{"type":"string","description":"Specifies the integration's HTTP method type. For the Type property, if you specify `MOCK` , this property is optional. For Lambda integrations, you must set the integration method to `POST` . For all other types, you must specify this property."},"integrationResponses":{"type":"array","items":{"$ref":"#/types/aws-native:apigateway:MethodIntegrationResponse"},"description":"Specifies the integration's responses."},"integrationTarget":{"type":"string","description":"The ALB or NLB listener to send the request to. Only supported for private integrations that use VPC links V2."},"passthroughBehavior":{"$ref":"#/types/aws-native:apigateway:MethodIntegrationPassthroughBehavior","description":"Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in `requestTemplates` . The valid value is one of the following: `WHEN_NO_MATCH` : passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. `WHEN_NO_TEMPLATES` : passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. `NEVER` : rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request."},"requestParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of `method.request.{location}.{name}` , where `location` is `querystring` , `path` , or `header` and `name` must be a valid and unique method request parameter name."},"requestTemplates":{"type":"object","additionalProperties":{"type":"string"},"description":"Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value."},"responseTransferMode":{"$ref":"#/types/aws-native:apigateway:MethodIntegrationResponseTransferMode","description":"The response transfer mode of the integration. Use `STREAM` to have API Gateway stream response your back to you or use `BUFFERED` to have API Gateway wait to receive the complete response before beginning transmission."},"timeoutInMillis":{"type":"integer","description":"Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only."},"type":{"$ref":"#/types/aws-native:apigateway:MethodIntegrationType","description":"Specifies an API method integration type. The valid value is one of the following:\n\nFor the HTTP and HTTP proxy integrations, each integration can specify a protocol ( `http/https` ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a `connectionType` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC."},"uri":{"type":"string","description":"Specifies Uniform Resource Identifier (URI) of the integration endpoint.\n\nFor `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name. For `AWS` or `AWS_PROXY` integrations, the URI is of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}` . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}\u0026{p1}={v1}\u0026p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either `arn:aws:apigateway:us-west-2:s3:action/GetObject\u0026Bucket={bucket}\u0026Key={key}` or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`"}},"type":"object","required":["type"]},"aws-native:apigateway:MethodIntegrationConnectionType":{"description":"The type of the network connection to the integration endpoint. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC. The default value is `INTERNET` .","type":"string","enum":[{"name":"Internet","value":"INTERNET"},{"name":"VpcLink","value":"VPC_LINK"}]},"aws-native:apigateway:MethodIntegrationContentHandling":{"description":"Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT` , with the following behaviors:\n\nIf this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass-through.","type":"string","enum":[{"name":"ConvertToBinary","value":"CONVERT_TO_BINARY"},{"name":"ConvertToText","value":"CONVERT_TO_TEXT"}]},"aws-native:apigateway:MethodIntegrationPassthroughBehavior":{"description":"Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in `requestTemplates` . The valid value is one of the following: `WHEN_NO_MATCH` : passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. `WHEN_NO_TEMPLATES` : passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. `NEVER` : rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.","type":"string","enum":[{"name":"WhenNoMatch","value":"WHEN_NO_MATCH"},{"name":"WhenNoTemplates","value":"WHEN_NO_TEMPLATES"},{"name":"Never","value":"NEVER"}]},"aws-native:apigateway:MethodIntegrationResponse":{"description":"``IntegrationResponse`` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.","properties":{"contentHandling":{"$ref":"#/types/aws-native:apigateway:MethodIntegrationResponseContentHandling","description":"Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT` , with the following behaviors:\n\nIf this property is not defined, the response payload will be passed through from the integration response to the method response without modification."},"responseParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of `method.response.header.{name}` , where `name` is a valid and unique header name. The mapped non-static value must match the pattern of `integration.response.header.{name}` or `integration.response.body.{JSON-expression}` , where `name` is a valid and unique response header name and `JSON-expression` is a valid JSON expression without the `$` prefix."},"responseTemplates":{"type":"object","additionalProperties":{"type":"string"},"description":"Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value."},"selectionPattern":{"type":"string","description":"Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the `.+` regex to match error response. However, make sure that the error response does not contain any newline ( `\\n` ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched."},"statusCode":{"type":"string","description":"Specifies the status code that is used to map the integration response to an existing MethodResponse."}},"type":"object","required":["statusCode"]},"aws-native:apigateway:MethodIntegrationResponseContentHandling":{"description":"Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT` , with the following behaviors:\n\nIf this property is not defined, the response payload will be passed through from the integration response to the method response without modification.","type":"string","enum":[{"name":"ConvertToBinary","value":"CONVERT_TO_BINARY"},{"name":"ConvertToText","value":"CONVERT_TO_TEXT"}]},"aws-native:apigateway:MethodIntegrationResponseTransferMode":{"description":"The response transfer mode of the integration. Use `STREAM` to have API Gateway stream response your back to you or use `BUFFERED` to have API Gateway wait to receive the complete response before beginning transmission.","type":"string","enum":[{"name":"Buffered","value":"BUFFERED"},{"name":"Stream","value":"STREAM"}]},"aws-native:apigateway:MethodIntegrationType":{"description":"Specifies an API method integration type. The valid value is one of the following:\n\nFor the HTTP and HTTP proxy integrations, each integration can specify a protocol ( `http/https` ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a `connectionType` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.","type":"string","enum":[{"name":"Aws","value":"AWS"},{"name":"AwsProxy","value":"AWS_PROXY"},{"name":"Http","value":"HTTP"},{"name":"HttpProxy","value":"HTTP_PROXY"},{"name":"Mock","value":"MOCK"}]},"aws-native:apigateway:MethodResponse":{"properties":{"responseModels":{"type":"object","additionalProperties":{"type":"string"},"description":"Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value."},"responseParameters":{"type":"object","additionalProperties":{"oneOf":[{"type":"boolean"},{"type":"string"}]},"description":"A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern `method.response.header.{name}` , where `name` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in `integration.response.header.{name}` , a static value enclosed within a pair of single quotes (e.g., `'application/json'` ), or a JSON expression from the back-end response payload in the form of `integration.response.body.{JSON-expression}` , where `JSON-expression` is a valid JSON expression without the `$` prefix.)"},"statusCode":{"type":"string","description":"The method response's status code."}},"type":"object","required":["statusCode"]},"aws-native:apigateway:RestApiEndpointConfiguration":{"description":"The ``EndpointConfiguration`` property type specifies the endpoint types and IP address types of a REST API.\n ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.","properties":{"ipAddressType":{"type":"string","description":"The IP address types that can invoke an API (RestApi). Use `ipv4` to allow only IPv4 addresses to invoke an API, or use `dualstack` to allow both IPv4 and IPv6 addresses to invoke an API. For the `PRIVATE` endpoint type, only `dualstack` is supported."},"types":{"type":"array","items":{"type":"string"},"description":"A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is `\"EDGE\"` . For a regional API and its custom domain name, the endpoint type is `REGIONAL` . For a private API, the endpoint type is `PRIVATE` ."},"vpcEndpointIds":{"type":"array","items":{"type":"string"},"description":"A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for `PRIVATE` endpoint type."}},"type":"object"},"aws-native:apigateway:RestApiS3Location":{"description":"``S3Location`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.\n  On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.","properties":{"bucket":{"type":"string","description":"The name of the S3 bucket where the OpenAPI file is stored."},"eTag":{"type":"string","description":"The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file."},"key":{"type":"string","description":"The file name of the OpenAPI file (Amazon S3 object name)."},"version":{"type":"string","description":"For versioning-enabled buckets, a specific version of the OpenAPI file."}},"type":"object"},"aws-native:apigateway:RestApiTag":{"description":"An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:apigateway:StageAccessLogSetting":{"description":"The ``AccessLogSetting`` property type specifies settings for logging access in this stage.\n ``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.","properties":{"destinationArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging."},"format":{"type":"string","description":"A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging."}},"type":"object"},"aws-native:apigateway:StageCanarySetting":{"properties":{"deploymentId":{"type":"string","description":"The ID of the canary deployment."},"percentTraffic":{"type":"number","description":"The percent (0-100) of traffic diverted to a canary deployment."},"stageVariableOverrides":{"type":"object","additionalProperties":{"type":"string"},"description":"Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values."},"useStageCache":{"type":"boolean","description":"A Boolean flag to indicate whether the canary deployment uses the stage cache or not."}},"type":"object"},"aws-native:apigateway:StageMethodSetting":{"description":"The ``MethodSetting`` property type configures settings for all methods in a stage.\n The ``MethodSettings`` property of the ``AWS::ApiGateway::Stage`` resource contains a list of ``MethodSetting`` property types.","properties":{"cacheDataEncrypted":{"type":"boolean","description":"Specifies whether the cached responses are encrypted."},"cacheTtlInSeconds":{"type":"integer","description":"Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached."},"cachingEnabled":{"type":"boolean","description":"Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached."},"dataTraceEnabled":{"type":"boolean","description":"Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs."},"httpMethod":{"type":"string","description":"The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``."},"loggingLevel":{"type":"string","description":"Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are `OFF` , `ERROR` , and `INFO` . Choose `ERROR` to write only error-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events."},"metricsEnabled":{"type":"boolean","description":"Specifies whether Amazon CloudWatch metrics are enabled for this method."},"resourcePath":{"type":"string","description":"The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``."},"throttlingBurstLimit":{"type":"integer","description":"Specifies the throttling burst limit."},"throttlingRateLimit":{"type":"number","description":"Specifies the throttling rate limit."}},"type":"object"},"aws-native:apigateway:StageTag":{"description":"An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:apigateway:UsagePlanApiStage":{"properties":{"apiId":{"type":"string","description":"API Id of the associated API stage in a usage plan."},"stage":{"type":"string","description":"API stage name of the associated API stage in a usage plan."},"throttle":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:apigateway:UsagePlanThrottleSettings"},"description":"Map containing method level throttling information for API stage in a usage plan."}},"type":"object"},"aws-native:apigateway:UsagePlanKeyKeyType":{"description":"The type of a UsagePlanKey resource for a plan customer.","type":"string","enum":[{"name":"ApiKey","value":"API_KEY"}]},"aws-native:apigateway:UsagePlanQuotaSettings":{"description":"``QuotaSettings`` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.\n In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.","properties":{"limit":{"type":"integer","description":"The target maximum number of requests that can be made in a given time period."},"offset":{"type":"integer","description":"The number of requests subtracted from the given limit in the initial time period."},"period":{"type":"string","description":"The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\"."}},"type":"object"},"aws-native:apigateway:UsagePlanTag":{"description":"An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:apigateway:UsagePlanThrottleSettings":{"description":"``ThrottleSettings`` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.","properties":{"burstLimit":{"type":"integer"},"rateLimit":{"type":"number"}},"type":"object"},"aws-native:apigateway:VpcLinkTag":{"description":"An array of key-value pairs to apply to this resource.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:apigatewayv2:ApiBodyS3Location":{"description":"The ``BodyS3Location`` property specifies an S3 location from which to import an OpenAPI definition. Supported only for HTTP APIs.","properties":{"bucket":{"type":"string","description":"The S3 bucket that contains the OpenAPI definition to import. Required if you specify a ``BodyS3Location`` for an API."},"etag":{"type":"string","description":"The Etag of the S3 object."},"key":{"type":"string","description":"The key of the S3 object. Required if you specify a ``BodyS3Location`` for an API."},"version":{"type":"string","description":"The version of the S3 object."}},"type":"object"},"aws-native:apigatewayv2:ApiCors":{"description":"The ``Cors`` property specifies a CORS configuration for an API. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.","properties":{"allowCredentials":{"type":"boolean","description":"Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs."},"allowHeaders":{"type":"array","items":{"type":"string"},"description":"Represents a collection of allowed headers. Supported only for HTTP APIs."},"allowMethods":{"type":"array","items":{"type":"string"},"description":"Represents a collection of allowed HTTP methods. Supported only for HTTP APIs."},"allowOrigins":{"type":"array","items":{"type":"string"},"description":"Represents a collection of allowed origins. Supported only for HTTP APIs."},"exposeHeaders":{"type":"array","items":{"type":"string"},"description":"Represents a collection of exposed headers. Supported only for HTTP APIs."},"maxAge":{"type":"integer","description":"The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs."}},"type":"object"},"aws-native:apigatewayv2:AuthorizerJwtConfiguration":{"description":"The ``JWTConfiguration`` property specifies the configuration of a JWT authorizer. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs.","properties":{"audience":{"type":"array","items":{"type":"string"},"description":"A list of the intended recipients of the JWT. A valid JWT must provide an ``aud`` that matches at least one entry in this list. See [RFC 7519](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc7519#section-4.1.3). Required for the ``JWT`` authorizer type. Supported only for HTTP APIs."},"issuer":{"type":"string","description":"The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: ``https://cognito-idp.{region}.amazonaws.com/{userPoolId}``. Required for the ``JWT`` authorizer type. Supported only for HTTP APIs."}},"type":"object"},"aws-native:apigatewayv2:DomainNameConfiguration":{"description":"The ``DomainNameConfiguration`` property type specifies the configuration for an API's domain name.\n  ``DomainNameConfiguration`` is a property of the [AWS::ApiGatewayV2::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html) resource.","properties":{"certificateArn":{"type":"string","description":"An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source."},"certificateName":{"type":"string","description":"The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name."},"endpointType":{"type":"string","description":"The endpoint type."},"ipAddressType":{"type":"string","description":"The IP address types that can invoke the domain name. Use `ipv4` to allow only IPv4 addresses to invoke your domain name, or use `dualstack` to allow both IPv4 and IPv6 addresses to invoke your domain name."},"ownershipVerificationCertificateArn":{"type":"string","description":"The Amazon resource name (ARN) for the public certificate issued by ACMlong. This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn."},"securityPolicy":{"type":"string","description":"The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are ``TLS_1_0`` and ``TLS_1_2``."}},"type":"object"},"aws-native:apigatewayv2:DomainNameMutualTlsAuthentication":{"description":"If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.","properties":{"truststoreUri":{"type":"string","description":"An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, ``s3://bucket-name/key-name``. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object."},"truststoreVersion":{"type":"string","description":"The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket."}},"type":"object"},"aws-native:apigatewayv2:DomainNameRoutingMode":{"description":"The routing mode API Gateway uses to route traffic to your APIs.","type":"string","enum":[{"name":"ApiMappingOnly","value":"API_MAPPING_ONLY"},{"name":"RoutingRuleThenApiMapping","value":"ROUTING_RULE_THEN_API_MAPPING"},{"name":"RoutingRuleOnly","value":"ROUTING_RULE_ONLY"}]},"aws-native:apigatewayv2:IntegrationResponseParameter":{"description":"response parameter","properties":{"destination":{"type":"string"},"source":{"type":"string"}},"type":"object"},"aws-native:apigatewayv2:IntegrationResponseParameterMap":{"description":"map of response parameter lists","properties":{"responseParameters":{"type":"array","items":{"$ref":"#/types/aws-native:apigatewayv2:IntegrationResponseParameter"}}},"type":"object"},"aws-native:apigatewayv2:IntegrationTlsConfig":{"description":"The TlsConfig property specifies the TLS configuration for a private integration. Supported only for HTTP APIs.","properties":{"serverNameToVerify":{"type":"string","description":"If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting."}},"type":"object"},"aws-native:apigatewayv2:RouteParameterConstraints":{"properties":{"required":{"type":"boolean"}},"type":"object","required":["required"]},"aws-native:apigatewayv2:RouteResponseParameterConstraints":{"description":"Specifies whether the parameter is required.","properties":{"required":{"type":"boolean","description":"Specifies whether the parameter is required."}},"type":"object","required":["required"]},"aws-native:apigatewayv2:RoutingRuleAction":{"properties":{"invokeApi":{"$ref":"#/types/aws-native:apigatewayv2:RoutingRuleActionInvokeApi","description":"Represents an InvokeApi action."}},"type":"object","required":["invokeApi"]},"aws-native:apigatewayv2:RoutingRuleActionInvokeApi":{"properties":{"apiId":{"type":"string","description":"The API identifier of the target API."},"stage":{"type":"string","description":"The name of the target stage."},"stripBasePath":{"type":"boolean","description":"The strip base path setting. When true, API Gateway strips the incoming matched base path when forwarding the request to the target API."}},"type":"object","required":["apiId","stage"]},"aws-native:apigatewayv2:RoutingRuleCondition":{"properties":{"matchBasePaths":{"$ref":"#/types/aws-native:apigatewayv2:RoutingRuleMatchBasePaths","description":"The base path to be matched."},"matchHeaders":{"$ref":"#/types/aws-native:apigatewayv2:RoutingRuleMatchHeaders","description":"The headers to be matched."}},"type":"object"},"aws-native:apigatewayv2:RoutingRuleMatchBasePaths":{"properties":{"anyOf":{"type":"array","items":{"type":"string"},"description":"The string of the case sensitive base path to be matched."}},"type":"object","required":["anyOf"]},"aws-native:apigatewayv2:RoutingRuleMatchHeaderValue":{"properties":{"header":{"type":"string","description":"The case insensitive header name to be matched. The header name must be less than 40 characters and the only allowed characters are `a-z` , `A-Z` , `0-9` , and the following special characters: `*?-!#$%\u0026'.^_`|~.` ."},"valueGlob":{"type":"string","description":"The case sensitive header glob value to be matched against entire header value. The header glob value must be less than 128 characters and the only allowed characters are `a-z` , `A-Z` , `0-9` , and the following special characters: `*?-!#$%\u0026'.^_`|~` . Wildcard matching is supported for header glob values but must be for `*prefix-match` , `suffix-match*` , or `*infix*-match` ."}},"type":"object","required":["header","valueGlob"]},"aws-native:apigatewayv2:RoutingRuleMatchHeaders":{"properties":{"anyOf":{"type":"array","items":{"$ref":"#/types/aws-native:apigatewayv2:RoutingRuleMatchHeaderValue"},"description":"The header name and header value glob to be matched. The matchHeaders condition is matched if any of the header name and header value globs are matched."}},"type":"object","required":["anyOf"]},"aws-native:appconfig:ApplicationTags":{"description":"Metadata to assign to the application. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.","properties":{"key":{"type":"string","description":"The key-value string map. The valid character set is [a-zA-Z1-9 +-=._:/-]. The tag key can be up to 128 characters and must not start with aws:."},"value":{"type":"string","description":"The tag value can be up to 256 characters."}},"type":"object","required":["key","value"]},"aws-native:appconfig:ConfigurationProfileDeletionProtectionCheck":{"description":"On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html","type":"string","enum":[{"name":"AccountDefault","value":"ACCOUNT_DEFAULT"},{"name":"Apply","value":"APPLY"},{"name":"Bypass","value":"BYPASS"}]},"aws-native:appconfig:ConfigurationProfileTags":{"description":"Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.","properties":{"key":{"type":"string","description":"The key-value string map. The tag key can be up to 128 characters and must not start with aws:."},"value":{"type":"string","description":"The tag value can be up to 256 characters."}},"type":"object"},"aws-native:appconfig:ConfigurationProfileValidators":{"description":"A list of methods for validating the configuration.","properties":{"content":{"type":"string","description":"Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function."},"type":{"type":"string","description":"AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA."}},"type":"object"},"aws-native:appconfig:DeploymentDynamicExtensionParameters":{"properties":{"extensionReference":{"type":"string","description":"The ARN or ID of the extension for which you are inserting a dynamic parameter."},"parameterName":{"type":"string","description":"The parameter name."},"parameterValue":{"type":"string","description":"The parameter value."}},"type":"object"},"aws-native:appconfig:DeploymentState":{"description":"The state of the deployment.","type":"string","enum":[{"name":"Baking","value":"BAKING"},{"name":"Validating","value":"VALIDATING"},{"name":"Deploying","value":"DEPLOYING"},{"name":"Complete","value":"COMPLETE"},{"name":"RollingBack","value":"ROLLING_BACK"},{"name":"RolledBack","value":"ROLLED_BACK"},{"name":"Reverted","value":"REVERTED"}]},"aws-native:appconfig:DeploymentStrategyGrowthType":{"description":"The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:\n\nLinear: For this type, AWS AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.\n\nExponential: For this type, AWS AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:\n\n2*(2^0)\n\n2*(2^1)\n\n2*(2^2)\n\nExpressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.","type":"string","enum":[{"name":"Exponential","value":"EXPONENTIAL"},{"name":"Linear","value":"LINEAR"}]},"aws-native:appconfig:DeploymentStrategyReplicateTo":{"description":"Save the deployment strategy to a Systems Manager (SSM) document.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"SsmDocument","value":"SSM_DOCUMENT"}]},"aws-native:appconfig:DeploymentStrategyTag":{"description":"Metadata to assign to the deployment strategy. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object"},"aws-native:appconfig:DeploymentTag":{"description":"Metadata to assign to the deployment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.","properties":{"key":{"type":"string","description":"The key-value string map. The valid character set is [a-zA-Z1-9+-=._:/]. The tag key can be up to 128 characters and must not start with aws:."},"value":{"type":"string","description":"The tag value can be up to 256 characters."}},"type":"object"},"aws-native:appconfig:EnvironmentDeletionProtectionCheck":{"description":"On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html","type":"string","enum":[{"name":"AccountDefault","value":"ACCOUNT_DEFAULT"},{"name":"Apply","value":"APPLY"},{"name":"Bypass","value":"BYPASS"}]},"aws-native:appconfig:EnvironmentMonitor":{"description":"Amazon CloudWatch alarm to monitor during the deployment process.","properties":{"alarmArn":{"type":"string","description":"Amazon Resource Name (ARN) of the Amazon CloudWatch alarm."},"alarmRoleArn":{"type":"string","description":"ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn."}},"type":"object","required":["alarmArn"]},"aws-native:appconfig:EnvironmentTag":{"description":"Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.","properties":{"key":{"type":"string","description":"The key-value string map. The valid character set is [a-zA-Z1-9+-=._:/]. The tag key can be up to 128 characters and must not start with aws:."},"value":{"type":"string","description":"The tag value can be up to 256 characters."}},"type":"object","required":["key","value"]},"aws-native:appconfig:ExtensionAction":{"description":"An action for an extension to take at a specific action point.","properties":{"description":{"type":"string","description":"The description of the extension Action."},"name":{"type":"string","description":"The name of the extension action."},"roleArn":{"type":"string","description":"The ARN of the role for invoking the extension action."},"uri":{"type":"string","description":"The URI of the extension action."}},"type":"object","required":["name","uri"]},"aws-native:appconfig:ExtensionAssociationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:appconfig:ExtensionParameter":{"description":"A parameter for the extension to send to a specific action.","properties":{"description":{"type":"string","description":"The description of the extension Parameter."},"dynamic":{"type":"boolean"},"required":{"type":"boolean"}},"type":"object","required":["required"]},"aws-native:appconfig:ExtensionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:appflow:ConnectorLambdaConnectorProvisioningConfig":{"description":"Contains information about the configuration of the lambda which is being registered as the connector.","properties":{"lambdaArn":{"type":"string","description":"Lambda ARN of the connector being registered."}},"type":"object","required":["lambdaArn"]},"aws-native:appflow:ConnectorProfileAmplitudeConnectorProfileCredentials":{"properties":{"apiKey":{"type":"string","description":"A unique alphanumeric identiﬁer used to authenticate a user, developer, or calling program to your API."},"secretKey":{"type":"string","description":"The Secret Access Key portion of the credentials."}},"type":"object","required":["apiKey","secretKey"]},"aws-native:appflow:ConnectorProfileApiKeyCredentials":{"properties":{"apiKey":{"type":"string","description":"The API key required for API key authentication."},"apiSecretKey":{"type":"string","description":"The API secret key required for API key authentication."}},"type":"object","required":["apiKey"]},"aws-native:appflow:ConnectorProfileAuthenticationType":{"type":"string","enum":[{"name":"Oauth2","value":"OAUTH2"},{"name":"Apikey","value":"APIKEY"},{"name":"Basic","value":"BASIC"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:appflow:ConnectorProfileBasicAuthCredentials":{"properties":{"password":{"type":"string","description":"The password to use to connect to a resource."},"username":{"type":"string","description":"The username to use to connect to a resource."}},"type":"object","required":["password","username"]},"aws-native:appflow:ConnectorProfileConfig":{"description":"Connector specific configurations needed to create connector profile","properties":{"connectorProfileCredentials":{"$ref":"#/types/aws-native:appflow:ConnectorProfileCredentials","description":"The connector-specific credentials required by each connector."},"connectorProfileProperties":{"$ref":"#/types/aws-native:appflow:ConnectorProfileProperties","description":"The connector-specific properties of the profile configuration."}},"type":"object"},"aws-native:appflow:ConnectorProfileConnectionMode":{"description":"Mode in which data transfer should be enabled. Private connection mode is currently enabled for Salesforce, Snowflake, Trendmicro and Singular","type":"string","enum":[{"name":"Public","value":"Public"},{"name":"Private","value":"Private"}]},"aws-native:appflow:ConnectorProfileConnectorOAuthRequest":{"properties":{"authCode":{"type":"string","description":"The code provided by the connector when it has been authenticated via the connected app."},"redirectUri":{"type":"string","description":"The URL to which the authentication server redirects the browser after authorization has been\ngranted."}},"type":"object"},"aws-native:appflow:ConnectorProfileConnectorType":{"type":"string","enum":[{"name":"Salesforce","value":"Salesforce"},{"name":"Pardot","value":"Pardot"},{"name":"Singular","value":"Singular"},{"name":"Slack","value":"Slack"},{"name":"Redshift","value":"Redshift"},{"name":"Marketo","value":"Marketo"},{"name":"Googleanalytics","value":"Googleanalytics"},{"name":"Zendesk","value":"Zendesk"},{"name":"Servicenow","value":"Servicenow"},{"name":"SapoData","value":"SAPOData"},{"name":"Datadog","value":"Datadog"},{"name":"Trendmicro","value":"Trendmicro"},{"name":"Snowflake","value":"Snowflake"},{"name":"Dynatrace","value":"Dynatrace"},{"name":"Infornexus","value":"Infornexus"},{"name":"Amplitude","value":"Amplitude"},{"name":"Veeva","value":"Veeva"},{"name":"CustomConnector","value":"CustomConnector"}]},"aws-native:appflow:ConnectorProfileCredentials":{"description":"Connector specific configuration needed to create connector profile based on Authentication mechanism","properties":{"amplitude":{"$ref":"#/types/aws-native:appflow:ConnectorProfileAmplitudeConnectorProfileCredentials","description":"The connector-specific credentials required when using Amplitude."},"customConnector":{"$ref":"#/types/aws-native:appflow:ConnectorProfileCustomConnectorProfileCredentials","description":"The connector-specific profile credentials that are required when using the custom connector."},"datadog":{"$ref":"#/types/aws-native:appflow:ConnectorProfileDatadogConnectorProfileCredentials","description":"The connector-specific credentials required when using Datadog."},"dynatrace":{"$ref":"#/types/aws-native:appflow:ConnectorProfileDynatraceConnectorProfileCredentials","description":"The connector-specific credentials required when using Dynatrace."},"googleAnalytics":{"$ref":"#/types/aws-native:appflow:ConnectorProfileGoogleAnalyticsConnectorProfileCredentials","description":"The connector-specific credentials required when using Google Analytics."},"inforNexus":{"$ref":"#/types/aws-native:appflow:ConnectorProfileInforNexusConnectorProfileCredentials","description":"The connector-specific credentials required when using Infor Nexus."},"marketo":{"$ref":"#/types/aws-native:appflow:ConnectorProfileMarketoConnectorProfileCredentials","description":"The connector-specific credentials required when using Marketo."},"pardot":{"$ref":"#/types/aws-native:appflow:ConnectorProfilePardotConnectorProfileCredentials","description":"The connector-specific credentials required when using Salesforce Pardot."},"redshift":{"$ref":"#/types/aws-native:appflow:ConnectorProfileRedshiftConnectorProfileCredentials","description":"The connector-specific credentials required when using Amazon Redshift."},"salesforce":{"$ref":"#/types/aws-native:appflow:ConnectorProfileSalesforceConnectorProfileCredentials","description":"The connector-specific credentials required when using Salesforce."},"sapoData":{"$ref":"#/types/aws-native:appflow:ConnectorProfileSapoDataConnectorProfileCredentials","description":"The connector-specific profile credentials required when using SAPOData."},"serviceNow":{"$ref":"#/types/aws-native:appflow:ConnectorProfileServiceNowConnectorProfileCredentials","description":"The connector-specific credentials required when using ServiceNow."},"singular":{"$ref":"#/types/aws-native:appflow:ConnectorProfileSingularConnectorProfileCredentials","description":"The connector-specific credentials required when using Singular."},"slack":{"$ref":"#/types/aws-native:appflow:ConnectorProfileSlackConnectorProfileCredentials","description":"The connector-specific credentials required when using Slack."},"snowflake":{"$ref":"#/types/aws-native:appflow:ConnectorProfileSnowflakeConnectorProfileCredentials","description":"The connector-specific credentials required when using Snowflake."},"trendmicro":{"$ref":"#/types/aws-native:appflow:ConnectorProfileTrendmicroConnectorProfileCredentials","description":"The connector-specific credentials required when using Trend Micro."},"veeva":{"$ref":"#/types/aws-native:appflow:ConnectorProfileVeevaConnectorProfileCredentials","description":"The connector-specific credentials required when using Veeva."},"zendesk":{"$ref":"#/types/aws-native:appflow:ConnectorProfileZendeskConnectorProfileCredentials","description":"The connector-specific credentials required when using Zendesk."}},"type":"object"},"aws-native:appflow:ConnectorProfileCustomAuthCredentials":{"properties":{"credentialsMap":{"type":"object","additionalProperties":{"type":"string"},"description":"A map that holds custom authentication credentials."},"customAuthenticationType":{"type":"string","description":"The custom authentication type that the connector uses."}},"type":"object","required":["customAuthenticationType"]},"aws-native:appflow:ConnectorProfileCustomConnectorProfileCredentials":{"properties":{"apiKey":{"$ref":"#/types/aws-native:appflow:ConnectorProfileApiKeyCredentials","description":"The API keys required for the authentication of the user."},"authenticationType":{"$ref":"#/types/aws-native:appflow:ConnectorProfileAuthenticationType","description":"The authentication type that the custom connector uses for authenticating while creating a connector profile."},"basic":{"$ref":"#/types/aws-native:appflow:ConnectorProfileBasicAuthCredentials","description":"The basic credentials that are required for the authentication of the user."},"custom":{"$ref":"#/types/aws-native:appflow:ConnectorProfileCustomAuthCredentials","description":"If the connector uses the custom authentication mechanism, this holds the required credentials."},"oauth2":{"$ref":"#/types/aws-native:appflow:ConnectorProfileOAuth2Credentials","description":"The OAuth 2.0 credentials required for the authentication of the user."}},"type":"object","required":["authenticationType"]},"aws-native:appflow:ConnectorProfileCustomConnectorProfileProperties":{"properties":{"oAuth2Properties":{"$ref":"#/types/aws-native:appflow:ConnectorProfileOAuth2Properties","description":"The OAuth 2.0 properties required for OAuth 2.0 authentication."},"profileProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"A map of properties that are required to create a profile for the custom connector."}},"type":"object"},"aws-native:appflow:ConnectorProfileDatadogConnectorProfileCredentials":{"properties":{"apiKey":{"type":"string","description":"A unique alphanumeric identiﬁer used to authenticate a user, developer, or calling program to your API."},"applicationKey":{"type":"string","description":"Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API."}},"type":"object","required":["apiKey","applicationKey"]},"aws-native:appflow:ConnectorProfileDatadogConnectorProfileProperties":{"properties":{"instanceUrl":{"type":"string","description":"The location of the Datadog resource"}},"type":"object","required":["instanceUrl"]},"aws-native:appflow:ConnectorProfileDynatraceConnectorProfileCredentials":{"properties":{"apiToken":{"type":"string","description":"The API tokens used by Dynatrace API to authenticate various API calls."}},"type":"object","required":["apiToken"]},"aws-native:appflow:ConnectorProfileDynatraceConnectorProfileProperties":{"properties":{"instanceUrl":{"type":"string","description":"The location of the Dynatrace resource"}},"type":"object","required":["instanceUrl"]},"aws-native:appflow:ConnectorProfileGoogleAnalyticsConnectorProfileCredentials":{"properties":{"accessToken":{"type":"string","description":"The credentials used to access protected resources."},"clientId":{"type":"string","description":"The identiﬁer for the desired client."},"clientSecret":{"type":"string","description":"The client secret used by the oauth client to authenticate to the authorization server."},"connectorOAuthRequest":{"$ref":"#/types/aws-native:appflow:ConnectorProfileConnectorOAuthRequest","description":"The oauth needed to request security tokens from the connector endpoint."},"refreshToken":{"type":"string","description":"The credentials used to acquire new access tokens."}},"type":"object","required":["clientId","clientSecret"]},"aws-native:appflow:ConnectorProfileInforNexusConnectorProfileCredentials":{"properties":{"accessKeyId":{"type":"string","description":"The Access Key portion of the credentials."},"datakey":{"type":"string","description":"The encryption keys used to encrypt data."},"secretAccessKey":{"type":"string","description":"The secret key used to sign requests."},"userId":{"type":"string","description":"The identiﬁer for the user."}},"type":"object","required":["accessKeyId","datakey","secretAccessKey","userId"]},"aws-native:appflow:ConnectorProfileInforNexusConnectorProfileProperties":{"properties":{"instanceUrl":{"type":"string","description":"The location of the InforNexus resource"}},"type":"object","required":["instanceUrl"]},"aws-native:appflow:ConnectorProfileMarketoConnectorProfileCredentials":{"properties":{"accessToken":{"type":"string","description":"The credentials used to access protected resources."},"clientId":{"type":"string","description":"The identiﬁer for the desired client."},"clientSecret":{"type":"string","description":"The client secret used by the oauth client to authenticate to the authorization server."},"connectorOAuthRequest":{"$ref":"#/types/aws-native:appflow:ConnectorProfileConnectorOAuthRequest","description":"The oauth needed to request security tokens from the connector endpoint."}},"type":"object","required":["clientId","clientSecret"]},"aws-native:appflow:ConnectorProfileMarketoConnectorProfileProperties":{"properties":{"instanceUrl":{"type":"string","description":"The location of the Marketo resource"}},"type":"object","required":["instanceUrl"]},"aws-native:appflow:ConnectorProfileOAuth2Credentials":{"properties":{"accessToken":{"type":"string","description":"The access token used to access the connector on your behalf."},"clientId":{"type":"string","description":"The identifier for the desired client."},"clientSecret":{"type":"string","description":"The client secret used by the OAuth client to authenticate to the authorization server."},"oAuthRequest":{"$ref":"#/types/aws-native:appflow:ConnectorProfileConnectorOAuthRequest"},"refreshToken":{"type":"string","description":"The refresh token used to refresh an expired access token."}},"type":"object"},"aws-native:appflow:ConnectorProfileOAuth2GrantType":{"type":"string","enum":[{"name":"ClientCredentials","value":"CLIENT_CREDENTIALS"},{"name":"AuthorizationCode","value":"AUTHORIZATION_CODE"},{"name":"JwtBearer","value":"JWT_BEARER"}]},"aws-native:appflow:ConnectorProfileOAuth2Properties":{"properties":{"oAuth2GrantType":{"$ref":"#/types/aws-native:appflow:ConnectorProfileOAuth2GrantType","description":"The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication."},"tokenUrl":{"type":"string","description":"The token URL required for OAuth 2.0 authentication."},"tokenUrlCustomProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"Associates your token URL with a map of properties that you define. Use this parameter to provide any additional details that the connector requires to authenticate your request."}},"type":"object"},"aws-native:appflow:ConnectorProfileOAuthProperties":{"properties":{"authCodeUrl":{"type":"string","description":"The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication."},"oAuthScopes":{"type":"array","items":{"type":"string"},"description":"The OAuth scopes required for OAuth type authentication."},"tokenUrl":{"type":"string","description":"The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token."}},"type":"object"},"aws-native:appflow:ConnectorProfilePardotConnectorProfileCredentials":{"properties":{"accessToken":{"type":"string","description":"The credentials used to access protected resources."},"clientCredentialsArn":{"type":"string","description":"The client credentials to fetch access token and refresh token."},"connectorOAuthRequest":{"$ref":"#/types/aws-native:appflow:ConnectorProfileConnectorOAuthRequest","description":"The oauth needed to request security tokens from the connector endpoint."},"refreshToken":{"type":"string","description":"The credentials used to acquire new access tokens."}},"type":"object"},"aws-native:appflow:ConnectorProfilePardotConnectorProfileProperties":{"properties":{"businessUnitId":{"type":"string","description":"The Business unit id of Salesforce Pardot instance to be connected"},"instanceUrl":{"type":"string","description":"The location of the Salesforce Pardot resource"},"isSandboxEnvironment":{"type":"boolean","description":"Indicates whether the connector profile applies to a demo or production environment"}},"type":"object","required":["businessUnitId"]},"aws-native:appflow:ConnectorProfileProperties":{"description":"Connector specific properties needed to create connector profile - currently not needed for Amplitude, Trendmicro, Googleanalytics and Singular","properties":{"customConnector":{"$ref":"#/types/aws-native:appflow:ConnectorProfileCustomConnectorProfileProperties","description":"The properties required by the custom connector."},"datadog":{"$ref":"#/types/aws-native:appflow:ConnectorProfileDatadogConnectorProfileProperties","description":"The connector-specific properties required by Datadog."},"dynatrace":{"$ref":"#/types/aws-native:appflow:ConnectorProfileDynatraceConnectorProfileProperties","description":"The connector-specific properties required by Dynatrace."},"inforNexus":{"$ref":"#/types/aws-native:appflow:ConnectorProfileInforNexusConnectorProfileProperties","description":"The connector-specific properties required by Infor Nexus."},"marketo":{"$ref":"#/types/aws-native:appflow:ConnectorProfileMarketoConnectorProfileProperties","description":"The connector-specific properties required by Marketo."},"pardot":{"$ref":"#/types/aws-native:appflow:ConnectorProfilePardotConnectorProfileProperties","description":"The connector-specific properties required by Salesforce Pardot."},"redshift":{"$ref":"#/types/aws-native:appflow:ConnectorProfileRedshiftConnectorProfileProperties","description":"The connector-specific properties required by Amazon Redshift."},"salesforce":{"$ref":"#/types/aws-native:appflow:ConnectorProfileSalesforceConnectorProfileProperties","description":"The connector-specific properties required by Salesforce."},"sapoData":{"$ref":"#/types/aws-native:appflow:ConnectorProfileSapoDataConnectorProfileProperties","description":"The connector-specific profile properties required when using SAPOData."},"serviceNow":{"$ref":"#/types/aws-native:appflow:ConnectorProfileServiceNowConnectorProfileProperties","description":"The connector-specific properties required by serviceNow."},"slack":{"$ref":"#/types/aws-native:appflow:ConnectorProfileSlackConnectorProfileProperties","description":"The connector-specific properties required by Slack."},"snowflake":{"$ref":"#/types/aws-native:appflow:ConnectorProfileSnowflakeConnectorProfileProperties","description":"The connector-specific properties required by Snowflake."},"veeva":{"$ref":"#/types/aws-native:appflow:ConnectorProfileVeevaConnectorProfileProperties","description":"The connector-specific properties required by Veeva."},"zendesk":{"$ref":"#/types/aws-native:appflow:ConnectorProfileZendeskConnectorProfileProperties","description":"The connector-specific properties required by Zendesk."}},"type":"object"},"aws-native:appflow:ConnectorProfileRedshiftConnectorProfileCredentials":{"properties":{"password":{"type":"string","description":"The password that corresponds to the username."},"username":{"type":"string","description":"The name of the user."}},"type":"object"},"aws-native:appflow:ConnectorProfileRedshiftConnectorProfileProperties":{"properties":{"bucketName":{"type":"string","description":"The name of the Amazon S3 bucket associated with Redshift."},"bucketPrefix":{"type":"string","description":"The object key for the destination bucket in which Amazon AppFlow will place the ﬁles."},"clusterIdentifier":{"type":"string","description":"The unique identifier of the Amazon Redshift cluster."},"dataApiRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role that grants Amazon AppFlow access to the data through the Amazon Redshift Data API."},"databaseName":{"type":"string","description":"The name of the Amazon Redshift database that will store the transferred data."},"databaseUrl":{"type":"string","description":"The JDBC URL of the Amazon Redshift cluster."},"isRedshiftServerless":{"type":"boolean","description":"If Amazon AppFlow will connect to Amazon Redshift Serverless or Amazon Redshift cluster."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role."},"workgroupName":{"type":"string","description":"The name of the Amazon Redshift serverless workgroup"}},"type":"object","required":["bucketName","roleArn"]},"aws-native:appflow:ConnectorProfileSalesforceConnectorProfileCredentials":{"properties":{"accessToken":{"type":"string","description":"The credentials used to access protected resources."},"clientCredentialsArn":{"type":"string","description":"The client credentials to fetch access token and refresh token."},"connectorOAuthRequest":{"$ref":"#/types/aws-native:appflow:ConnectorProfileConnectorOAuthRequest","description":"The oauth needed to request security tokens from the connector endpoint."},"jwtToken":{"type":"string","description":"The credentials used to access your Salesforce records"},"oAuth2GrantType":{"$ref":"#/types/aws-native:appflow:ConnectorProfileOAuth2GrantType","description":"The grant types to fetch an access token"},"refreshToken":{"type":"string","description":"The credentials used to acquire new access tokens."}},"type":"object"},"aws-native:appflow:ConnectorProfileSalesforceConnectorProfileProperties":{"properties":{"instanceUrl":{"type":"string","description":"The location of the Salesforce resource"},"isSandboxEnvironment":{"type":"boolean","description":"Indicates whether the connector profile applies to a sandbox or production environment"},"usePrivateLinkForMetadataAndAuthorization":{"type":"boolean","description":"Indicates whether to make Metadata And Authorization calls over Pivate Network"}},"type":"object"},"aws-native:appflow:ConnectorProfileSapoDataConnectorProfileCredentials":{"properties":{"basicAuthCredentials":{"$ref":"#/types/aws-native:appflow:ConnectorProfileBasicAuthCredentials","description":"The SAPOData basic authentication credentials."},"oAuthCredentials":{"$ref":"#/types/aws-native:appflow:ConnectorProfileSapoDataConnectorProfileCredentialsOAuthCredentialsProperties","description":"The SAPOData OAuth type authentication credentials."}},"type":"object"},"aws-native:appflow:ConnectorProfileSapoDataConnectorProfileCredentialsOAuthCredentialsProperties":{"description":"The SAPOData OAuth type authentication credentials.","properties":{"accessToken":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"connectorOAuthRequest":{"$ref":"#/types/aws-native:appflow:ConnectorProfileConnectorOAuthRequest"},"refreshToken":{"type":"string"}},"type":"object"},"aws-native:appflow:ConnectorProfileSapoDataConnectorProfileProperties":{"properties":{"applicationHostUrl":{"type":"string","description":"The location of the SAPOData resource."},"applicationServicePath":{"type":"string","description":"The application path to catalog service."},"clientNumber":{"type":"string","description":"The client number for the client creating the connection."},"disableSso":{"type":"boolean","description":"If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance."},"logonLanguage":{"type":"string","description":"The logon language of SAPOData instance."},"oAuthProperties":{"$ref":"#/types/aws-native:appflow:ConnectorProfileOAuthProperties","description":"The SAPOData OAuth properties required for OAuth type authentication."},"portNumber":{"type":"integer","description":"The port number of the SAPOData instance."},"privateLinkServiceName":{"type":"string","description":"The SAPOData Private Link service name to be used for private data transfers."}},"type":"object"},"aws-native:appflow:ConnectorProfileServiceNowConnectorProfileCredentials":{"properties":{"oAuth2Credentials":{"$ref":"#/types/aws-native:appflow:ConnectorProfileOAuth2Credentials","description":"The OAuth 2.0 credentials required to authenticate the user."},"password":{"type":"string","description":"The password that corresponds to the username."},"username":{"type":"string","description":"The name of the user."}},"type":"object"},"aws-native:appflow:ConnectorProfileServiceNowConnectorProfileProperties":{"properties":{"instanceUrl":{"type":"string","description":"The location of the ServiceNow resource"}},"type":"object","required":["instanceUrl"]},"aws-native:appflow:ConnectorProfileSingularConnectorProfileCredentials":{"properties":{"apiKey":{"type":"string","description":"A unique alphanumeric identiﬁer used to authenticate a user, developer, or calling program to your API."}},"type":"object","required":["apiKey"]},"aws-native:appflow:ConnectorProfileSlackConnectorProfileCredentials":{"properties":{"accessToken":{"type":"string","description":"The credentials used to access protected resources."},"clientId":{"type":"string","description":"The identiﬁer for the desired client."},"clientSecret":{"type":"string","description":"The client secret used by the oauth client to authenticate to the authorization server."},"connectorOAuthRequest":{"$ref":"#/types/aws-native:appflow:ConnectorProfileConnectorOAuthRequest","description":"The oauth needed to request security tokens from the connector endpoint."}},"type":"object","required":["clientId","clientSecret"]},"aws-native:appflow:ConnectorProfileSlackConnectorProfileProperties":{"properties":{"instanceUrl":{"type":"string","description":"The location of the Slack resource"}},"type":"object","required":["instanceUrl"]},"aws-native:appflow:ConnectorProfileSnowflakeConnectorProfileCredentials":{"properties":{"password":{"type":"string","description":"The password that corresponds to the username."},"username":{"type":"string","description":"The name of the user."}},"type":"object","required":["password","username"]},"aws-native:appflow:ConnectorProfileSnowflakeConnectorProfileProperties":{"properties":{"accountName":{"type":"string","description":"The name of the account."},"bucketName":{"type":"string","description":"The name of the Amazon S3 bucket associated with Snowﬂake."},"bucketPrefix":{"type":"string","description":"The bucket prefix that refers to the Amazon S3 bucket associated with Snowﬂake."},"privateLinkServiceName":{"type":"string","description":"The Snowﬂake Private Link service name to be used for private data transfers."},"region":{"type":"string","description":"The region of the Snowﬂake account."},"stage":{"type":"string","description":"The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the\nSnowﬂake account. This is written in the following format: \u003c Database\u003e\u003c Schema\u003e\u003cStage Name\u003e."},"warehouse":{"type":"string","description":"The name of the Snowﬂake warehouse."}},"type":"object","required":["bucketName","stage","warehouse"]},"aws-native:appflow:ConnectorProfileTrendmicroConnectorProfileCredentials":{"properties":{"apiSecretKey":{"type":"string","description":"The Secret Access Key portion of the credentials."}},"type":"object","required":["apiSecretKey"]},"aws-native:appflow:ConnectorProfileVeevaConnectorProfileCredentials":{"properties":{"password":{"type":"string","description":"The password that corresponds to the username."},"username":{"type":"string","description":"The name of the user."}},"type":"object","required":["password","username"]},"aws-native:appflow:ConnectorProfileVeevaConnectorProfileProperties":{"properties":{"instanceUrl":{"type":"string","description":"The location of the Veeva resource"}},"type":"object","required":["instanceUrl"]},"aws-native:appflow:ConnectorProfileZendeskConnectorProfileCredentials":{"properties":{"accessToken":{"type":"string","description":"The credentials used to access protected resources."},"clientId":{"type":"string","description":"The identiﬁer for the desired client."},"clientSecret":{"type":"string","description":"The client secret used by the oauth client to authenticate to the authorization server."},"connectorOAuthRequest":{"$ref":"#/types/aws-native:appflow:ConnectorProfileConnectorOAuthRequest","description":"The oauth needed to request security tokens from the connector endpoint."}},"type":"object","required":["clientId","clientSecret"]},"aws-native:appflow:ConnectorProfileZendeskConnectorProfileProperties":{"properties":{"instanceUrl":{"type":"string","description":"The location of the Zendesk resource"}},"type":"object","required":["instanceUrl"]},"aws-native:appflow:ConnectorProvisioningConfig":{"description":"Contains information about the configuration of the connector being registered.","properties":{"lambda":{"$ref":"#/types/aws-native:appflow:ConnectorLambdaConnectorProvisioningConfig","description":"Contains information about the configuration of the lambda which is being registered as the connector."}},"type":"object"},"aws-native:appflow:FlowAggregationConfig":{"properties":{"aggregationType":{"$ref":"#/types/aws-native:appflow:FlowAggregationType","description":"Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated."},"targetFileSize":{"type":"integer","description":"The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow destination. For each file, Amazon AppFlow attempts to achieve the size that you specify. The actual file sizes might differ from this target based on the number and size of the records that each file contains."}},"type":"object"},"aws-native:appflow:FlowAggregationType":{"type":"string","enum":[{"name":"None","value":"None"},{"name":"SingleFile","value":"SingleFile"}]},"aws-native:appflow:FlowAmplitudeConnectorOperator":{"type":"string","enum":[{"name":"Between","value":"BETWEEN"}]},"aws-native:appflow:FlowAmplitudeSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Amplitude flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowConnectorOperator":{"description":"Operation to be performed on provided source fields","properties":{"amplitude":{"$ref":"#/types/aws-native:appflow:FlowAmplitudeConnectorOperator","description":"The operation to be performed on the provided Amplitude source fields."},"customConnector":{"$ref":"#/types/aws-native:appflow:FlowOperator","description":"Operators supported by the custom connector."},"datadog":{"$ref":"#/types/aws-native:appflow:FlowDatadogConnectorOperator","description":"The operation to be performed on the provided Datadog source fields."},"dynatrace":{"$ref":"#/types/aws-native:appflow:FlowDynatraceConnectorOperator","description":"The operation to be performed on the provided Dynatrace source fields."},"googleAnalytics":{"$ref":"#/types/aws-native:appflow:FlowGoogleAnalyticsConnectorOperator","description":"The operation to be performed on the provided Google Analytics source fields."},"inforNexus":{"$ref":"#/types/aws-native:appflow:FlowInforNexusConnectorOperator","description":"The operation to be performed on the provided Infor Nexus source fields."},"marketo":{"$ref":"#/types/aws-native:appflow:FlowMarketoConnectorOperator","description":"The operation to be performed on the provided Marketo source fields."},"pardot":{"$ref":"#/types/aws-native:appflow:FlowPardotConnectorOperator","description":"The operation to be performed on the provided Salesforce Pardot source fields."},"s3":{"$ref":"#/types/aws-native:appflow:FlowS3ConnectorOperator","description":"The operation to be performed on the provided Amazon S3 source fields."},"salesforce":{"$ref":"#/types/aws-native:appflow:FlowSalesforceConnectorOperator","description":"The operation to be performed on the provided Salesforce source fields."},"sapoData":{"$ref":"#/types/aws-native:appflow:FlowSapoDataConnectorOperator","description":"The operation to be performed on the provided SAPOData source fields."},"serviceNow":{"$ref":"#/types/aws-native:appflow:FlowServiceNowConnectorOperator","description":"The operation to be performed on the provided ServiceNow source fields."},"singular":{"$ref":"#/types/aws-native:appflow:FlowSingularConnectorOperator","description":"The operation to be performed on the provided Singular source fields."},"slack":{"$ref":"#/types/aws-native:appflow:FlowSlackConnectorOperator","description":"The operation to be performed on the provided Slack source fields."},"trendmicro":{"$ref":"#/types/aws-native:appflow:FlowTrendmicroConnectorOperator","description":"The operation to be performed on the provided Trend Micro source fields."},"veeva":{"$ref":"#/types/aws-native:appflow:FlowVeevaConnectorOperator","description":"The operation to be performed on the provided Veeva source fields."},"zendesk":{"$ref":"#/types/aws-native:appflow:FlowZendeskConnectorOperator","description":"The operation to be performed on the provided Zendesk source fields."}},"type":"object"},"aws-native:appflow:FlowConnectorType":{"type":"string","enum":[{"name":"SapoData","value":"SAPOData"},{"name":"Salesforce","value":"Salesforce"},{"name":"Pardot","value":"Pardot"},{"name":"Singular","value":"Singular"},{"name":"Slack","value":"Slack"},{"name":"Redshift","value":"Redshift"},{"name":"S3","value":"S3"},{"name":"Marketo","value":"Marketo"},{"name":"Googleanalytics","value":"Googleanalytics"},{"name":"Zendesk","value":"Zendesk"},{"name":"Servicenow","value":"Servicenow"},{"name":"Datadog","value":"Datadog"},{"name":"Trendmicro","value":"Trendmicro"},{"name":"Snowflake","value":"Snowflake"},{"name":"Dynatrace","value":"Dynatrace"},{"name":"Infornexus","value":"Infornexus"},{"name":"Amplitude","value":"Amplitude"},{"name":"Veeva","value":"Veeva"},{"name":"CustomConnector","value":"CustomConnector"},{"name":"EventBridge","value":"EventBridge"},{"name":"Upsolver","value":"Upsolver"},{"name":"LookoutMetrics","value":"LookoutMetrics"}]},"aws-native:appflow:FlowCustomConnectorDestinationProperties":{"properties":{"customProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"The custom properties that are specific to the connector when it's used as a destination in the flow."},"entityName":{"type":"string","description":"The entity specified in the custom connector as a destination in the flow."},"errorHandlingConfig":{"$ref":"#/types/aws-native:appflow:FlowErrorHandlingConfig","description":"The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination."},"idFieldNames":{"type":"array","items":{"type":"string"},"description":"List of fields used as ID when performing a write operation."},"writeOperationType":{"$ref":"#/types/aws-native:appflow:FlowWriteOperationType","description":"Specifies the type of write operation to be performed in the custom connector when it's used as destination."}},"type":"object","required":["entityName"]},"aws-native:appflow:FlowCustomConnectorSourceProperties":{"properties":{"customProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom properties that are required to use the custom connector as a source."},"dataTransferApi":{"$ref":"#/types/aws-native:appflow:FlowCustomConnectorSourcePropertiesDataTransferApiProperties","description":"The API of the connector application that Amazon AppFlow uses to transfer your data."},"entityName":{"type":"string","description":"The entity specified in the custom connector as a source in the flow."}},"type":"object","required":["entityName"]},"aws-native:appflow:FlowCustomConnectorSourcePropertiesDataTransferApiProperties":{"description":"The API of the connector application that Amazon AppFlow uses to transfer your data.","properties":{"name":{"type":"string"},"type":{"$ref":"#/types/aws-native:appflow:FlowCustomConnectorSourcePropertiesDataTransferApiPropertiesType"}},"type":"object","required":["name","type"]},"aws-native:appflow:FlowCustomConnectorSourcePropertiesDataTransferApiPropertiesType":{"type":"string","enum":[{"name":"Sync","value":"SYNC"},{"name":"Async","value":"ASYNC"},{"name":"Automatic","value":"AUTOMATIC"}]},"aws-native:appflow:FlowDataTransferApi":{"type":"string","enum":[{"name":"Automatic","value":"AUTOMATIC"},{"name":"Bulkv2","value":"BULKV2"},{"name":"RestSync","value":"REST_SYNC"}]},"aws-native:appflow:FlowDatadogConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"Between","value":"BETWEEN"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowDatadogSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Datadog flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowDestinationConnectorProperties":{"description":"Destination connector details","properties":{"customConnector":{"$ref":"#/types/aws-native:appflow:FlowCustomConnectorDestinationProperties","description":"The properties that are required to query the custom Connector."},"eventBridge":{"$ref":"#/types/aws-native:appflow:FlowEventBridgeDestinationProperties","description":"The properties required to query Amazon EventBridge."},"lookoutMetrics":{"$ref":"#/types/aws-native:appflow:FlowLookoutMetricsDestinationProperties","description":"The properties required to query Amazon Lookout for Metrics."},"marketo":{"$ref":"#/types/aws-native:appflow:FlowMarketoDestinationProperties","description":"The properties required to query Marketo."},"redshift":{"$ref":"#/types/aws-native:appflow:FlowRedshiftDestinationProperties","description":"The properties required to query Amazon Redshift."},"s3":{"$ref":"#/types/aws-native:appflow:FlowS3DestinationProperties","description":"The properties required to query Amazon S3."},"salesforce":{"$ref":"#/types/aws-native:appflow:FlowSalesforceDestinationProperties","description":"The properties required to query Salesforce."},"sapoData":{"$ref":"#/types/aws-native:appflow:FlowSapoDataDestinationProperties","description":"The properties required to query SAPOData."},"snowflake":{"$ref":"#/types/aws-native:appflow:FlowSnowflakeDestinationProperties","description":"The properties required to query Snowflake."},"upsolver":{"$ref":"#/types/aws-native:appflow:FlowUpsolverDestinationProperties","description":"The properties required to query Upsolver."},"zendesk":{"$ref":"#/types/aws-native:appflow:FlowZendeskDestinationProperties","description":"The properties required to query Zendesk."}},"type":"object"},"aws-native:appflow:FlowDestinationFlowConfig":{"description":"Configurations of destination connector.","properties":{"apiVersion":{"type":"string","description":"The API version that the destination connector uses."},"connectorProfileName":{"type":"string","description":"Name of destination connector profile"},"connectorType":{"$ref":"#/types/aws-native:appflow:FlowConnectorType","description":"Destination connector type"},"destinationConnectorProperties":{"$ref":"#/types/aws-native:appflow:FlowDestinationConnectorProperties","description":"Destination connector details"}},"type":"object","required":["connectorType","destinationConnectorProperties"]},"aws-native:appflow:FlowDynatraceConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"Between","value":"BETWEEN"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowDynatraceSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Dynatrace flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowErrorHandlingConfig":{"properties":{"bucketName":{"type":"string","description":"Specifies the name of the Amazon S3 bucket."},"bucketPrefix":{"type":"string","description":"Specifies the Amazon S3 bucket prefix."},"failOnFirstError":{"type":"boolean","description":"Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination."}},"type":"object"},"aws-native:appflow:FlowEventBridgeDestinationProperties":{"properties":{"errorHandlingConfig":{"$ref":"#/types/aws-native:appflow:FlowErrorHandlingConfig","description":"The object specified in the Amplitude flow source."},"object":{"type":"string","description":"The object specified in the Amazon EventBridge flow destination."}},"type":"object","required":["object"]},"aws-native:appflow:FlowFileType":{"type":"string","enum":[{"name":"Csv","value":"CSV"},{"name":"Json","value":"JSON"},{"name":"Parquet","value":"PARQUET"}]},"aws-native:appflow:FlowGlueDataCatalog":{"description":"Trigger settings of the flow.","properties":{"databaseName":{"type":"string","description":"A string containing the value for the tag"},"roleArn":{"type":"string","description":"A string containing the value for the tag"},"tablePrefix":{"type":"string","description":"A string containing the value for the tag"}},"type":"object","required":["databaseName","roleArn","tablePrefix"]},"aws-native:appflow:FlowGoogleAnalyticsConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"Between","value":"BETWEEN"}]},"aws-native:appflow:FlowGoogleAnalyticsSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Google Analytics flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowIncrementalPullConfig":{"description":"Configuration for scheduled incremental data pull","properties":{"datetimeTypeFieldName":{"type":"string","description":"A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source."}},"type":"object"},"aws-native:appflow:FlowInforNexusConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"Between","value":"BETWEEN"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowInforNexusSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Infor Nexus flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowLookoutMetricsDestinationProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Amazon Lookout for Metrics flow destination."}},"type":"object"},"aws-native:appflow:FlowMarketoConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"LessThan","value":"LESS_THAN"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Between","value":"BETWEEN"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowMarketoDestinationProperties":{"properties":{"errorHandlingConfig":{"$ref":"#/types/aws-native:appflow:FlowErrorHandlingConfig","description":"The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details."},"object":{"type":"string","description":"The object specified in the Marketo flow destination."}},"type":"object","required":["object"]},"aws-native:appflow:FlowMarketoSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Marketo flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowMetadataCatalogConfig":{"description":"Configurations of metadata catalog of the flow.","properties":{"glueDataCatalog":{"$ref":"#/types/aws-native:appflow:FlowGlueDataCatalog","description":"Configurations of glue data catalog of the flow."}},"type":"object"},"aws-native:appflow:FlowOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"LessThan","value":"LESS_THAN"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Contains","value":"CONTAINS"},{"name":"Between","value":"BETWEEN"},{"name":"LessThanOrEqualTo","value":"LESS_THAN_OR_EQUAL_TO"},{"name":"GreaterThanOrEqualTo","value":"GREATER_THAN_OR_EQUAL_TO"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"NotEqualTo","value":"NOT_EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowOperatorPropertiesKeys":{"type":"string","enum":[{"name":"Value","value":"VALUE"},{"name":"Values","value":"VALUES"},{"name":"DataType","value":"DATA_TYPE"},{"name":"UpperBound","value":"UPPER_BOUND"},{"name":"LowerBound","value":"LOWER_BOUND"},{"name":"SourceDataType","value":"SOURCE_DATA_TYPE"},{"name":"DestinationDataType","value":"DESTINATION_DATA_TYPE"},{"name":"ValidationAction","value":"VALIDATION_ACTION"},{"name":"MaskValue","value":"MASK_VALUE"},{"name":"MaskLength","value":"MASK_LENGTH"},{"name":"TruncateLength","value":"TRUNCATE_LENGTH"},{"name":"MathOperationFieldsOrder","value":"MATH_OPERATION_FIELDS_ORDER"},{"name":"ConcatFormat","value":"CONCAT_FORMAT"},{"name":"SubfieldCategoryMap","value":"SUBFIELD_CATEGORY_MAP"},{"name":"ExcludeSourceFieldsList","value":"EXCLUDE_SOURCE_FIELDS_LIST"},{"name":"IncludeNewFields","value":"INCLUDE_NEW_FIELDS"},{"name":"OrderedPartitionKeysList","value":"ORDERED_PARTITION_KEYS_LIST"}]},"aws-native:appflow:FlowPardotConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"NoOp","value":"NO_OP"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"}]},"aws-native:appflow:FlowPardotSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Salesforce Pardot flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowPathPrefix":{"type":"string","enum":[{"name":"ExecutionId","value":"EXECUTION_ID"},{"name":"SchemaVersion","value":"SCHEMA_VERSION"}]},"aws-native:appflow:FlowPrefixConfig":{"properties":{"pathPrefixHierarchy":{"type":"array","items":{"$ref":"#/types/aws-native:appflow:FlowPathPrefix"},"description":"Specifies whether the destination file path includes either or both of the following elements:\n\n- **EXECUTION_ID** - The ID that Amazon AppFlow assigns to the flow run.\n- **SCHEMA_VERSION** - The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:\n\n- Source-to-destination field mappings\n- Field data types\n- Partition keys"},"prefixFormat":{"$ref":"#/types/aws-native:appflow:FlowPrefixFormat","description":"Determines the level of granularity for the date and time that's included in the prefix."},"prefixType":{"$ref":"#/types/aws-native:appflow:FlowPrefixType","description":"Determines the format of the prefix, and whether it applies to the file name, file path, or both."}},"type":"object"},"aws-native:appflow:FlowPrefixFormat":{"type":"string","enum":[{"name":"Year","value":"YEAR"},{"name":"Month","value":"MONTH"},{"name":"Day","value":"DAY"},{"name":"Hour","value":"HOUR"},{"name":"Minute","value":"MINUTE"}]},"aws-native:appflow:FlowPrefixType":{"type":"string","enum":[{"name":"Filename","value":"FILENAME"},{"name":"Path","value":"PATH"},{"name":"PathAndFilename","value":"PATH_AND_FILENAME"}]},"aws-native:appflow:FlowRedshiftDestinationProperties":{"properties":{"bucketPrefix":{"type":"string","description":"The object key for the bucket in which Amazon AppFlow places the destination files."},"errorHandlingConfig":{"$ref":"#/types/aws-native:appflow:FlowErrorHandlingConfig","description":"The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details."},"intermediateBucketName":{"type":"string","description":"The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift."},"object":{"type":"string","description":"The object specified in the Amazon Redshift flow destination."}},"type":"object","required":["intermediateBucketName","object"]},"aws-native:appflow:FlowS3ConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"LessThan","value":"LESS_THAN"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Between","value":"BETWEEN"},{"name":"LessThanOrEqualTo","value":"LESS_THAN_OR_EQUAL_TO"},{"name":"GreaterThanOrEqualTo","value":"GREATER_THAN_OR_EQUAL_TO"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"NotEqualTo","value":"NOT_EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowS3DestinationProperties":{"properties":{"bucketName":{"type":"string","description":"The Amazon S3 bucket name in which Amazon AppFlow places the transferred data."},"bucketPrefix":{"type":"string","description":"The object key for the destination bucket in which Amazon AppFlow places the files."},"s3OutputFormatConfig":{"$ref":"#/types/aws-native:appflow:FlowS3OutputFormatConfig","description":"The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination."}},"type":"object","required":["bucketName"]},"aws-native:appflow:FlowS3InputFormatConfig":{"properties":{"s3InputFileType":{"$ref":"#/types/aws-native:appflow:FlowS3InputFormatConfigS3InputFileType","description":"The file type that Amazon AppFlow gets from your Amazon S3 bucket."}},"type":"object"},"aws-native:appflow:FlowS3InputFormatConfigS3InputFileType":{"description":"The file type that Amazon AppFlow gets from your Amazon S3 bucket.","type":"string","enum":[{"name":"Csv","value":"CSV"},{"name":"Json","value":"JSON"}]},"aws-native:appflow:FlowS3OutputFormatConfig":{"properties":{"aggregationConfig":{"$ref":"#/types/aws-native:appflow:FlowAggregationConfig","description":"The aggregation settings that you can use to customize the output format of your flow data."},"fileType":{"$ref":"#/types/aws-native:appflow:FlowFileType","description":"Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket."},"prefixConfig":{"$ref":"#/types/aws-native:appflow:FlowPrefixConfig","description":"Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date."},"preserveSourceDataTyping":{"type":"boolean","description":"If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3.\n\n- `true` : Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer or `1` in your source data is still an integer in your output.\n- `false` : Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For example, an integer of `1` in your source data becomes the string `\"1\"` in the output."}},"type":"object"},"aws-native:appflow:FlowS3SourceProperties":{"properties":{"bucketName":{"type":"string","description":"The Amazon S3 bucket name where the source files are stored."},"bucketPrefix":{"type":"string","description":"The object key for the Amazon S3 bucket in which the source files are stored."},"s3InputFormatConfig":{"$ref":"#/types/aws-native:appflow:FlowS3InputFormatConfig","description":"When you use Amazon S3 as the source, the configuration format that you provide the flow input data."}},"type":"object","required":["bucketName","bucketPrefix"]},"aws-native:appflow:FlowSalesforceConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"LessThan","value":"LESS_THAN"},{"name":"Contains","value":"CONTAINS"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Between","value":"BETWEEN"},{"name":"LessThanOrEqualTo","value":"LESS_THAN_OR_EQUAL_TO"},{"name":"GreaterThanOrEqualTo","value":"GREATER_THAN_OR_EQUAL_TO"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"NotEqualTo","value":"NOT_EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowSalesforceDestinationProperties":{"properties":{"dataTransferApi":{"$ref":"#/types/aws-native:appflow:FlowDataTransferApi","description":"Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.\n\n- **AUTOMATIC** - The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.\n\nEach of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.\n\nBy choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.\n- **BULKV2** - Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.\n\nNote that Bulk API 2.0 does not transfer Salesforce compound fields.\n- **REST_SYNC** - Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error."},"errorHandlingConfig":{"$ref":"#/types/aws-native:appflow:FlowErrorHandlingConfig","description":"The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details."},"idFieldNames":{"type":"array","items":{"type":"string"},"description":"List of fields used as ID when performing a write operation."},"object":{"type":"string","description":"The object specified in the Salesforce flow destination."},"writeOperationType":{"$ref":"#/types/aws-native:appflow:FlowWriteOperationType","description":"This specifies the type of write operation to be performed in Salesforce. When the value is `UPSERT` , then `idFieldNames` is required."}},"type":"object","required":["object"]},"aws-native:appflow:FlowSalesforceSourceProperties":{"properties":{"dataTransferApi":{"$ref":"#/types/aws-native:appflow:FlowDataTransferApi","description":"Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.\n\n- **AUTOMATIC** - The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.\n\nEach of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.\n\nBy choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.\n- **BULKV2** - Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.\n\nNote that Bulk API 2.0 does not transfer Salesforce compound fields.\n- **REST_SYNC** - Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error."},"enableDynamicFieldUpdate":{"type":"boolean","description":"The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow."},"includeDeletedRecords":{"type":"boolean","description":"Indicates whether Amazon AppFlow includes deleted files in the flow run."},"object":{"type":"string","description":"The object specified in the Salesforce flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowSapoDataConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"LessThan","value":"LESS_THAN"},{"name":"Contains","value":"CONTAINS"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Between","value":"BETWEEN"},{"name":"LessThanOrEqualTo","value":"LESS_THAN_OR_EQUAL_TO"},{"name":"GreaterThanOrEqualTo","value":"GREATER_THAN_OR_EQUAL_TO"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"NotEqualTo","value":"NOT_EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowSapoDataDestinationProperties":{"properties":{"errorHandlingConfig":{"$ref":"#/types/aws-native:appflow:FlowErrorHandlingConfig","description":"The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details."},"idFieldNames":{"type":"array","items":{"type":"string"},"description":"List of fields used as ID when performing a write operation."},"objectPath":{"type":"string","description":"The object path specified in the SAPOData flow destination."},"successResponseHandlingConfig":{"$ref":"#/types/aws-native:appflow:FlowSuccessResponseHandlingConfig","description":"Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.\n\nFor example, this setting would determine where to write the response from a destination connector upon a successful insert operation."},"writeOperationType":{"$ref":"#/types/aws-native:appflow:FlowWriteOperationType","description":"The possible write operations in the destination connector. When this value is not provided, this defaults to the `INSERT` operation."}},"type":"object","required":["objectPath"]},"aws-native:appflow:FlowSapoDataPaginationConfig":{"description":"SAP Source connector page size","properties":{"maxPageSize":{"type":"integer","description":"The maximum number of records that Amazon AppFlow receives in each page of the response from your SAP application. For transfers of OData records, the maximum page size is 3,000. For transfers of data that comes from an ODP provider, the maximum page size is 10,000."}},"type":"object","required":["maxPageSize"]},"aws-native:appflow:FlowSapoDataParallelismConfig":{"description":"SAP Source connector parallelism factor","properties":{"maxParallelism":{"type":"integer","description":"The maximum number of processes that Amazon AppFlow runs at the same time when it retrieves your data from your SAP application."}},"type":"object","required":["maxParallelism"]},"aws-native:appflow:FlowSapoDataSourceProperties":{"properties":{"objectPath":{"type":"string","description":"The object path specified in the SAPOData flow source."},"paginationConfig":{"$ref":"#/types/aws-native:appflow:FlowSapoDataPaginationConfig","description":"Sets the page size for each concurrent process that transfers OData records from your SAP instance."},"parallelismConfig":{"$ref":"#/types/aws-native:appflow:FlowSapoDataParallelismConfig","description":"Sets the number of concurrent processes that transfers OData records from your SAP instance."}},"type":"object","required":["objectPath"]},"aws-native:appflow:FlowScheduledTriggerProperties":{"description":"Details required for scheduled trigger type","properties":{"dataPullMode":{"$ref":"#/types/aws-native:appflow:FlowScheduledTriggerPropertiesDataPullMode","description":"Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run."},"firstExecutionFrom":{"type":"number","description":"Specifies the date range for the records to import from the connector in the first flow run."},"flowErrorDeactivationThreshold":{"type":"integer","description":"Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it."},"scheduleEndTime":{"type":"number","description":"The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as `2022-04-27T13:00:00-07:00` ."},"scheduleExpression":{"type":"string","description":"The scheduling expression that determines the rate at which the schedule will run, for example `rate(5minutes)` ."},"scheduleOffset":{"type":"number","description":"Specifies the optional offset that is added to the time interval for a schedule-triggered flow."},"scheduleStartTime":{"type":"number","description":"The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as `2022-04-26T13:00:00-07:00` ."},"timeZone":{"type":"string","description":"Specifies the time zone used when referring to the dates and times of a scheduled flow, such as `America/New_York` . This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.\n\nIf you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the `America/New_York` timezone are `-04:00` EDT and `-05:00 EST` ."}},"type":"object","required":["scheduleExpression"]},"aws-native:appflow:FlowScheduledTriggerPropertiesDataPullMode":{"description":"Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.","type":"string","enum":[{"name":"Incremental","value":"Incremental"},{"name":"Complete","value":"Complete"}]},"aws-native:appflow:FlowServiceNowConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"LessThan","value":"LESS_THAN"},{"name":"Contains","value":"CONTAINS"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Between","value":"BETWEEN"},{"name":"LessThanOrEqualTo","value":"LESS_THAN_OR_EQUAL_TO"},{"name":"GreaterThanOrEqualTo","value":"GREATER_THAN_OR_EQUAL_TO"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"NotEqualTo","value":"NOT_EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowServiceNowSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the ServiceNow flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowSingularConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowSingularSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Singular flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowSlackConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"Between","value":"BETWEEN"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowSlackSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Slack flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowSnowflakeDestinationProperties":{"properties":{"bucketPrefix":{"type":"string","description":"The object key for the destination bucket in which Amazon AppFlow places the files."},"errorHandlingConfig":{"$ref":"#/types/aws-native:appflow:FlowErrorHandlingConfig","description":"The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details."},"intermediateBucketName":{"type":"string","description":"The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake."},"object":{"type":"string","description":"The object specified in the Snowflake flow destination."}},"type":"object","required":["intermediateBucketName","object"]},"aws-native:appflow:FlowSourceConnectorProperties":{"description":"Source connector details required to query a connector","properties":{"amplitude":{"$ref":"#/types/aws-native:appflow:FlowAmplitudeSourceProperties","description":"Specifies the information that is required for querying Amplitude."},"customConnector":{"$ref":"#/types/aws-native:appflow:FlowCustomConnectorSourceProperties","description":"The properties that are applied when the custom connector is being used as a source."},"datadog":{"$ref":"#/types/aws-native:appflow:FlowDatadogSourceProperties","description":"Specifies the information that is required for querying Datadog."},"dynatrace":{"$ref":"#/types/aws-native:appflow:FlowDynatraceSourceProperties","description":"Specifies the information that is required for querying Dynatrace."},"googleAnalytics":{"$ref":"#/types/aws-native:appflow:FlowGoogleAnalyticsSourceProperties","description":"Specifies the information that is required for querying Google Analytics."},"inforNexus":{"$ref":"#/types/aws-native:appflow:FlowInforNexusSourceProperties","description":"Specifies the information that is required for querying Infor Nexus."},"marketo":{"$ref":"#/types/aws-native:appflow:FlowMarketoSourceProperties","description":"Specifies the information that is required for querying Marketo."},"pardot":{"$ref":"#/types/aws-native:appflow:FlowPardotSourceProperties","description":"Specifies the information that is required for querying Salesforce Pardot."},"s3":{"$ref":"#/types/aws-native:appflow:FlowS3SourceProperties","description":"Specifies the information that is required for querying Amazon S3."},"salesforce":{"$ref":"#/types/aws-native:appflow:FlowSalesforceSourceProperties","description":"Specifies the information that is required for querying Salesforce."},"sapoData":{"$ref":"#/types/aws-native:appflow:FlowSapoDataSourceProperties","description":"The properties that are applied when using SAPOData as a flow source."},"serviceNow":{"$ref":"#/types/aws-native:appflow:FlowServiceNowSourceProperties","description":"Specifies the information that is required for querying ServiceNow."},"singular":{"$ref":"#/types/aws-native:appflow:FlowSingularSourceProperties","description":"Specifies the information that is required for querying Singular."},"slack":{"$ref":"#/types/aws-native:appflow:FlowSlackSourceProperties","description":"Specifies the information that is required for querying Slack."},"trendmicro":{"$ref":"#/types/aws-native:appflow:FlowTrendmicroSourceProperties","description":"Specifies the information that is required for querying Trend Micro."},"veeva":{"$ref":"#/types/aws-native:appflow:FlowVeevaSourceProperties","description":"Specifies the information that is required for querying Veeva."},"zendesk":{"$ref":"#/types/aws-native:appflow:FlowZendeskSourceProperties","description":"Specifies the information that is required for querying Zendesk."}},"type":"object"},"aws-native:appflow:FlowSourceFlowConfig":{"description":"Configurations of Source connector of the flow.","properties":{"apiVersion":{"type":"string","description":"The API version that the destination connector uses."},"connectorProfileName":{"type":"string","description":"Name of source connector profile"},"connectorType":{"$ref":"#/types/aws-native:appflow:FlowConnectorType","description":"Type of source connector"},"incrementalPullConfig":{"$ref":"#/types/aws-native:appflow:FlowIncrementalPullConfig","description":"Configuration for scheduled incremental data pull"},"sourceConnectorProperties":{"$ref":"#/types/aws-native:appflow:FlowSourceConnectorProperties","description":"Source connector details required to query a connector"}},"type":"object","required":["connectorType","sourceConnectorProperties"]},"aws-native:appflow:FlowStatus":{"description":"Flow activation status for Scheduled- and Event-triggered flows","type":"string","enum":[{"name":"Active","value":"Active"},{"name":"Suspended","value":"Suspended"},{"name":"Draft","value":"Draft"}]},"aws-native:appflow:FlowSuccessResponseHandlingConfig":{"properties":{"bucketName":{"type":"string","description":"The name of the Amazon S3 bucket."},"bucketPrefix":{"type":"string","description":"The Amazon S3 bucket prefix."}},"type":"object"},"aws-native:appflow:FlowTag":{"description":"A label for tagging AppFlow resources","properties":{"key":{"type":"string","description":"A string used to identify this tag"},"value":{"type":"string","description":"A string containing the value for the tag"}},"type":"object","required":["key","value"]},"aws-native:appflow:FlowTask":{"properties":{"connectorOperator":{"$ref":"#/types/aws-native:appflow:FlowConnectorOperator","description":"Operation to be performed on provided source fields"},"destinationField":{"type":"string","description":"A field value on which source field should be validated"},"sourceFields":{"type":"array","items":{"type":"string"},"description":"Source fields on which particular task will be applied"},"taskProperties":{"type":"array","items":{"$ref":"#/types/aws-native:appflow:FlowTaskPropertiesObject"},"description":"A Map used to store task related info"},"taskType":{"$ref":"#/types/aws-native:appflow:FlowTaskType","description":"Type of task"}},"type":"object","required":["sourceFields","taskType"]},"aws-native:appflow:FlowTaskPropertiesObject":{"description":"An object used to store task related info","properties":{"key":{"$ref":"#/types/aws-native:appflow:FlowOperatorPropertiesKeys","description":"The task property key."},"value":{"type":"string","description":"The task property value."}},"type":"object","required":["key","value"]},"aws-native:appflow:FlowTaskType":{"type":"string","enum":[{"name":"Arithmetic","value":"Arithmetic"},{"name":"Filter","value":"Filter"},{"name":"Map","value":"Map"},{"name":"MapAll","value":"Map_all"},{"name":"Mask","value":"Mask"},{"name":"Merge","value":"Merge"},{"name":"Passthrough","value":"Passthrough"},{"name":"Truncate","value":"Truncate"},{"name":"Validate","value":"Validate"},{"name":"Partition","value":"Partition"}]},"aws-native:appflow:FlowTrendmicroConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowTrendmicroSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Trend Micro flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowTriggerConfig":{"description":"Trigger settings of the flow.","properties":{"triggerProperties":{"$ref":"#/types/aws-native:appflow:FlowScheduledTriggerProperties","description":"Details required based on the type of trigger"},"triggerType":{"$ref":"#/types/aws-native:appflow:FlowTriggerType","description":"Trigger type of the flow"}},"type":"object","required":["triggerType"]},"aws-native:appflow:FlowTriggerType":{"type":"string","enum":[{"name":"Scheduled","value":"Scheduled"},{"name":"Event","value":"Event"},{"name":"OnDemand","value":"OnDemand"}]},"aws-native:appflow:FlowUpsolverDestinationProperties":{"properties":{"bucketName":{"type":"string","description":"The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data."},"bucketPrefix":{"type":"string","description":"The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files."},"s3OutputFormatConfig":{"$ref":"#/types/aws-native:appflow:FlowUpsolverS3OutputFormatConfig","description":"The configuration that determines how data is formatted when Upsolver is used as the flow destination."}},"type":"object","required":["bucketName","s3OutputFormatConfig"]},"aws-native:appflow:FlowUpsolverS3OutputFormatConfig":{"properties":{"aggregationConfig":{"$ref":"#/types/aws-native:appflow:FlowAggregationConfig","description":"The aggregation settings that you can use to customize the output format of your flow data."},"fileType":{"$ref":"#/types/aws-native:appflow:FlowFileType","description":"Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket."},"prefixConfig":{"$ref":"#/types/aws-native:appflow:FlowPrefixConfig","description":"Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination."}},"type":"object","required":["prefixConfig"]},"aws-native:appflow:FlowVeevaConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"LessThan","value":"LESS_THAN"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Between","value":"BETWEEN"},{"name":"LessThanOrEqualTo","value":"LESS_THAN_OR_EQUAL_TO"},{"name":"GreaterThanOrEqualTo","value":"GREATER_THAN_OR_EQUAL_TO"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"NotEqualTo","value":"NOT_EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowVeevaSourceProperties":{"properties":{"documentType":{"type":"string","description":"The document type specified in the Veeva document extract flow."},"includeAllVersions":{"type":"boolean","description":"Boolean value to include All Versions of files in Veeva document extract flow."},"includeRenditions":{"type":"boolean","description":"Boolean value to include file renditions in Veeva document extract flow."},"includeSourceFiles":{"type":"boolean","description":"Boolean value to include source files in Veeva document extract flow."},"object":{"type":"string","description":"The object specified in the Veeva flow source."}},"type":"object","required":["object"]},"aws-native:appflow:FlowWriteOperationType":{"type":"string","enum":[{"name":"Insert","value":"INSERT"},{"name":"Upsert","value":"UPSERT"},{"name":"Update","value":"UPDATE"},{"name":"Delete","value":"DELETE"}]},"aws-native:appflow:FlowZendeskConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:appflow:FlowZendeskDestinationProperties":{"properties":{"errorHandlingConfig":{"$ref":"#/types/aws-native:appflow:FlowErrorHandlingConfig","description":"The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details."},"idFieldNames":{"type":"array","items":{"type":"string"},"description":"List of fields used as ID when performing a write operation."},"object":{"type":"string","description":"The object specified in the Zendesk flow destination."},"writeOperationType":{"$ref":"#/types/aws-native:appflow:FlowWriteOperationType","description":"The possible write operations in the destination connector. When this value is not provided, this defaults to the `INSERT` operation."}},"type":"object","required":["object"]},"aws-native:appflow:FlowZendeskSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Zendesk flow source."}},"type":"object","required":["object"]},"aws-native:appintegrations:ApplicationConfig":{"properties":{"contactHandling":{"$ref":"#/types/aws-native:appintegrations:ApplicationContactHandling"}},"type":"object"},"aws-native:appintegrations:ApplicationContactHandling":{"properties":{"scope":{"$ref":"#/types/aws-native:appintegrations:ApplicationContactHandlingScope"}},"type":"object","required":["scope"]},"aws-native:appintegrations:ApplicationContactHandlingScope":{"type":"string","enum":[{"name":"CrossContacts","value":"CROSS_CONTACTS"},{"name":"PerContact","value":"PER_CONTACT"}]},"aws-native:appintegrations:ApplicationExternalUrlConfig":{"properties":{"accessUrl":{"type":"string","description":"The URL to access the application."},"approvedOrigins":{"type":"array","items":{"type":"string"},"description":"Additional URLs to allow list if different than the access URL."}},"type":"object","required":["accessUrl"]},"aws-native:appintegrations:ApplicationIframeConfig":{"properties":{"allow":{"type":"array","items":{"type":"string"}},"sandbox":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:appintegrations:ApplicationSourceConfigProperties":{"description":"Application source config","properties":{"externalUrlConfig":{"$ref":"#/types/aws-native:appintegrations:ApplicationExternalUrlConfig","description":"The external URL source for the application."}},"type":"object","required":["externalUrlConfig"]},"aws-native:appintegrations:ApplicationTag":{"description":"A label for tagging Application resources","properties":{"key":{"type":"string","description":"A key to identify the tag."},"value":{"type":"string","description":"Corresponding tag value for the key."}},"type":"object","required":["key","value"]},"aws-native:appintegrations:DataIntegrationFileConfiguration":{"description":"The configuration for what files should be pulled from the source.","properties":{"filters":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Restrictions for what files should be pulled from the source."},"folders":{"type":"array","items":{"type":"string"},"description":"Identifiers for the source folders to pull all files from recursively."}},"type":"object","required":["folders"]},"aws-native:appintegrations:DataIntegrationScheduleConfig":{"properties":{"firstExecutionFrom":{"type":"string","description":"The start date for objects to import in the first flow run. Epoch or ISO timestamp format is supported."},"object":{"type":"string","description":"The name of the object to pull from the data source."},"scheduleExpression":{"type":"string","description":"How often the data should be pulled from data source."}},"type":"object","required":["scheduleExpression"]},"aws-native:appintegrations:DataIntegrationTag":{"description":"A label for tagging DataIntegration resources","properties":{"key":{"type":"string","description":"A key to identify the tag."},"value":{"type":"string","description":"Corresponding tag value for the key."}},"type":"object","required":["key","value"]},"aws-native:appintegrations:EventIntegrationEventFilter":{"properties":{"source":{"type":"string","description":"The source of the events."}},"type":"object","required":["source"]},"aws-native:appintegrations:EventIntegrationTag":{"properties":{"key":{"type":"string","description":"A key to identify the tag."},"value":{"type":"string","description":"Corresponding tag value for the key."}},"type":"object","required":["key","value"]},"aws-native:applicationautoscaling:ScalableTargetAction":{"description":"``ScalableTargetAction`` specifies the minimum and maximum capacity for the ``ScalableTargetAction`` property of the [AWS::ApplicationAutoScaling::ScalableTarget ScheduledAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html) property type.","properties":{"maxCapacity":{"type":"integer","description":"The maximum capacity."},"minCapacity":{"type":"integer","description":"The minimum capacity."}},"type":"object"},"aws-native:applicationautoscaling:ScalableTargetScheduledAction":{"description":"``ScheduledAction`` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies a scheduled action for a scalable target. \n For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) in the *Application Auto Scaling User Guide*.","properties":{"endTime":{"type":"string","description":"The date and time that the action is scheduled to end, in UTC."},"scalableTargetAction":{"$ref":"#/types/aws-native:applicationautoscaling:ScalableTargetAction","description":"The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity."},"schedule":{"type":"string","description":"The schedule for this action. The following formats are supported:\n  +  At expressions - \"``at(yyyy-mm-ddThh:mm:ss)``\"\n  +  Rate expressions - \"``rate(valueunit)``\"\n  +  Cron expressions - \"``cron(fields)``\"\n  \n At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.\n At and cron expressions use Universal Coordinated Time (UTC) by default.\n The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].\n For rate expressions, *value* is a positive integer and *unit* is ``minute`` | ``minutes`` | ``hour`` | ``hours`` | ``day`` | ``days``."},"scheduledActionName":{"type":"string","description":"The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target."},"startTime":{"type":"string","description":"The date and time that the action is scheduled to begin, in UTC."},"timezone":{"type":"string","description":"The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression."}},"type":"object","required":["schedule","scheduledActionName"]},"aws-native:applicationautoscaling:ScalableTargetSuspendedState":{"description":"``SuspendedState`` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies whether the scaling activities for a scalable target are in a suspended state.\n For more information, see [Suspending and resuming scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) in the *Application Auto Scaling User Guide*.","properties":{"dynamicScalingInSuspended":{"type":"boolean","description":"Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is ``false``."},"dynamicScalingOutSuspended":{"type":"boolean","description":"Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is ``false``."},"scheduledScalingSuspended":{"type":"boolean","description":"Whether scheduled scaling is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is ``false``."}},"type":"object"},"aws-native:applicationautoscaling:ScalingPolicyCustomizedMetricSpecification":{"description":"Contains customized metric specification information for a target tracking scaling policy for Application Auto Scaling. \n For information about the available metrics for a service, see [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*.\n To create your customized metric specification:\n  +  Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see [Publish custom metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the *Amazon CloudWatch User Guide*.\n  +  Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases, and increase when capacity decreases. \n  \n For an example of how creating new metrics can be useful, see [Scaling based on Amazon SQS](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-using-sqs-queue.html) in the *Amazon EC2 Auto Scaling User Guide*. This topic mentions Auto Scaling groups, but the same scenario for Amazon SQS can apply to the target tracking scaling policies that you create for a Spot Fleet by using Application Auto Scaling.\n For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html). \n ``CustomizedMetricSpecification`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) property type.","properties":{"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyMetricDimension"},"description":"The dimensions of the metric. \n Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy."},"metricName":{"type":"string","description":"The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that's returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html)."},"metrics":{"type":"array","items":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyTargetTrackingMetricDataQuery"},"description":"The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions."},"namespace":{"type":"string","description":"The namespace of the metric."},"statistic":{"type":"string","description":"The statistic of the metric."},"unit":{"type":"string","description":"The unit of the metric. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*."}},"type":"object"},"aws-native:applicationautoscaling:ScalingPolicyMetricDimension":{"description":"``MetricDimension`` specifies a name/value pair that is part of the identity of a CloudWatch metric for the ``Dimensions`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property type. Duplicate dimensions are not allowed.","properties":{"name":{"type":"string","description":"The name of the dimension."},"value":{"type":"string","description":"The value of the dimension."}},"type":"object","required":["name","value"]},"aws-native:applicationautoscaling:ScalingPolicyPredefinedMetricSpecification":{"description":"Contains predefined metric specification information for a target tracking scaling policy for Application Auto Scaling.\n ``PredefinedMetricSpecification`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingscalingpolicyconfiguration.html) property type.","properties":{"predefinedMetricType":{"type":"string","description":"The metric type. The ``ALBRequestCountPerTarget`` metric type applies only to Spot fleet requests and ECS services."},"resourceLabel":{"type":"string","description":"Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ``ALBRequestCountPerTarget`` and there is a target group attached to the Spot Fleet or ECS service.\n You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:\n ``app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff``.\n Where:\n  +  app/\u003cload-balancer-name\u003e/\u003cload-balancer-id\u003e is the final portion of the load balancer ARN\n  +  targetgroup/\u003ctarget-group-name\u003e/\u003ctarget-group-id\u003e is the final portion of the target group ARN.\n  \n To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation."}},"type":"object","required":["predefinedMetricType"]},"aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingCustomizedCapacityMetric":{"description":"Represents a CloudWatch metric of your choosing for a predictive scaling policy.","properties":{"metricDataQueries":{"type":"array","items":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricDataQuery"},"description":"One or more metric data queries to provide data points for a metric specification."}},"type":"object","required":["metricDataQueries"]},"aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingCustomizedLoadMetric":{"description":"The customized load metric specification.","properties":{"metricDataQueries":{"type":"array","items":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricDataQuery"}}},"type":"object","required":["metricDataQueries"]},"aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingCustomizedScalingMetric":{"description":"One or more metric data queries to provide data points for a metric specification.","properties":{"metricDataQueries":{"type":"array","items":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricDataQuery"},"description":"One or more metric data queries to provide data points for a metric specification."}},"type":"object","required":["metricDataQueries"]},"aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetric":{"description":"Describes the scaling metric.","properties":{"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricDimension"},"description":"Describes the dimensions of the metric."},"metricName":{"type":"string","description":"The name of the metric."},"namespace":{"type":"string","description":"The namespace of the metric."}},"type":"object"},"aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricDataQuery":{"description":"The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.","properties":{"expression":{"type":"string","description":"The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. \n Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both."},"id":{"type":"string","description":"A short name that identifies the object's results in the response. This name must be unique among all ``MetricDataQuery`` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter."},"label":{"type":"string","description":"A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents."},"metricStat":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricStat","description":"Information about the metric data to return. \n Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both."},"returnData":{"type":"boolean","description":"Indicates whether to return the timestamps and raw data values of this metric. \n If you use any math expressions, specify ``true`` for this value for only the final math expression that the metric specification is based on. You must specify ``false`` for ``ReturnData`` for all the other metrics and expressions used in the metric specification.\n If you are only retrieving metrics and not performing any math expressions, do not specify anything for ``ReturnData``. This sets it to its default (``true``)."}},"type":"object"},"aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricDimension":{"description":"Describes the dimension of a metric.","properties":{"name":{"type":"string","description":"The name of the dimension."},"value":{"type":"string","description":"The value of the dimension."}},"type":"object"},"aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricSpecification":{"description":"This structure specifies the metrics and target utilization settings for a predictive scaling policy. \n You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.","properties":{"customizedCapacityMetricSpecification":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingCustomizedCapacityMetric","description":"The customized capacity metric specification."},"customizedLoadMetricSpecification":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingCustomizedLoadMetric","description":"The customized load metric specification."},"customizedScalingMetricSpecification":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingCustomizedScalingMetric","description":"The customized scaling metric specification."},"predefinedLoadMetricSpecification":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingPredefinedLoadMetric","description":"The predefined load metric specification."},"predefinedMetricPairSpecification":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingPredefinedMetricPair","description":"The predefined metric pair specification that determines the appropriate scaling metric and load metric to use."},"predefinedScalingMetricSpecification":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingPredefinedScalingMetric","description":"The predefined scaling metric specification."},"targetValue":{"type":"number","description":"Specifies the target utilization."}},"type":"object","required":["targetValue"]},"aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricStat":{"description":"This structure defines the CloudWatch metric to return, along with the statistic and unit.","properties":{"metric":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetric","description":"The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html)."},"stat":{"type":"string","description":"The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide*. \n The most commonly used metrics for predictive scaling are ``Average`` and ``Sum``."},"unit":{"type":"string","description":"The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*."}},"type":"object"},"aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingPolicyConfiguration":{"description":"Represents a predictive scaling policy configuration. Predictive scaling is supported on Amazon ECS services.","properties":{"maxCapacityBreachBehavior":{"type":"string","description":"Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to ``HonorMaxCapacity`` if not specified."},"maxCapacityBuffer":{"type":"integer","description":"The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55. \n Required if the ``MaxCapacityBreachBehavior`` property is set to ``IncreaseMaxCapacity``, and cannot be used otherwise."},"metricSpecifications":{"type":"array","items":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingMetricSpecification"},"description":"This structure includes the metrics and target utilization to use for predictive scaling. \n This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric."},"mode":{"type":"string","description":"The predictive scaling mode. Defaults to ``ForecastOnly`` if not specified."},"schedulingBufferTime":{"type":"integer","description":"The amount of time, in seconds, that the start time can be advanced. \n The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified."}},"type":"object","required":["metricSpecifications"]},"aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingPredefinedLoadMetric":{"description":"Describes a load metric for a predictive scaling policy. \n When returned in the output of ``DescribePolicies``, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.\n The following predefined metrics are available for predictive scaling:\n  +   ``ECSServiceAverageCPUUtilization`` \n  +   ``ECSServiceAverageMemoryUtilization`` \n  +   ``ECSServiceCPUUtilization`` \n  +   ``ECSServiceMemoryUtilization`` \n  +   ``ECSServiceTotalCPUUtilization`` \n  +   ``ECSServiceTotalMemoryUtilization`` \n  +   ``ALBRequestCount`` \n  +   ``ALBRequestCountPerTarget`` \n  +   ``TotalALBRequestCount``","properties":{"predefinedMetricType":{"type":"string","description":"The metric type."},"resourceLabel":{"type":"string","description":"A label that uniquely identifies a target group."}},"type":"object","required":["predefinedMetricType"]},"aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingPredefinedMetricPair":{"description":"Represents a metric pair for a predictive scaling policy. \n The following predefined metrics are available for predictive scaling:\n  +   ``ECSServiceAverageCPUUtilization`` \n  +   ``ECSServiceAverageMemoryUtilization`` \n  +   ``ECSServiceCPUUtilization`` \n  +   ``ECSServiceMemoryUtilization`` \n  +   ``ECSServiceTotalCPUUtilization`` \n  +   ``ECSServiceTotalMemoryUtilization`` \n  +   ``ALBRequestCount`` \n  +   ``ALBRequestCountPerTarget`` \n  +   ``TotalALBRequestCount``","properties":{"predefinedMetricType":{"type":"string","description":"Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric."},"resourceLabel":{"type":"string","description":"A label that uniquely identifies a specific target group from which to determine the total and average request count."}},"type":"object","required":["predefinedMetricType"]},"aws-native:applicationautoscaling:ScalingPolicyPredictiveScalingPredefinedScalingMetric":{"description":"Describes a scaling metric for a predictive scaling policy. \n When returned in the output of ``DescribePolicies``, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.\n The following predefined metrics are available for predictive scaling:\n  +   ``ECSServiceAverageCPUUtilization`` \n  +   ``ECSServiceAverageMemoryUtilization`` \n  +   ``ECSServiceCPUUtilization`` \n  +   ``ECSServiceMemoryUtilization`` \n  +   ``ECSServiceTotalCPUUtilization`` \n  +   ``ECSServiceTotalMemoryUtilization`` \n  +   ``ALBRequestCount`` \n  +   ``ALBRequestCountPerTarget`` \n  +   ``TotalALBRequestCount``","properties":{"predefinedMetricType":{"type":"string","description":"The metric type."},"resourceLabel":{"type":"string","description":"A label that uniquely identifies a specific target group from which to determine the average request count."}},"type":"object","required":["predefinedMetricType"]},"aws-native:applicationautoscaling:ScalingPolicyStepAdjustment":{"description":"``StepAdjustment`` specifies a step adjustment for the ``StepAdjustments`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy StepScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-stepscalingpolicyconfiguration.html) property type. \n For the following examples, suppose that you have an alarm with a breach threshold of 50: \n  +  To trigger a step adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10. \n  +  To trigger a step adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0. \n  \n For more information, see [Step adjustments](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#as-scaling-steps) in the *Application Auto Scaling User Guide*.\n You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html#aws-resource-applicationautoscaling-scalingpolicy--examples) section of the ``AWS::ApplicationAutoScaling::ScalingPolicy`` documentation.","properties":{"metricIntervalLowerBound":{"type":"number","description":"The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.\n You must specify at least one upper or lower bound."},"metricIntervalUpperBound":{"type":"number","description":"The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.\n You must specify at least one upper or lower bound."},"scalingAdjustment":{"type":"integer","description":"The amount by which to scale. The adjustment is based on the value that you specified in the ``AdjustmentType`` property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity."}},"type":"object","required":["scalingAdjustment"]},"aws-native:applicationautoscaling:ScalingPolicyStepScalingPolicyConfiguration":{"description":"``StepScalingPolicyConfiguration`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a step scaling policy configuration for Application Auto Scaling. \n For more information, see [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.","properties":{"adjustmentType":{"type":"string","description":"Specifies whether the ``ScalingAdjustment`` value in the ``StepAdjustment`` property is an absolute number or a percentage of the current capacity."},"cooldown":{"type":"integer","description":"The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see [Cooldown period](https://docs.aws.amazon.com/autoscaling/application/userguide/step-scaling-policy-overview.html#step-scaling-cooldown) in the *Application Auto Scaling User Guide*."},"metricAggregationType":{"type":"string","description":"The aggregation type for the CloudWatch metrics. Valid values are ``Minimum``, ``Maximum``, and ``Average``. If the aggregation type is null, the value is treated as ``Average``."},"minAdjustmentMagnitude":{"type":"integer","description":"The minimum value to scale by when the adjustment type is ``PercentChangeInCapacity``. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a ``MinAdjustmentMagnitude`` of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a ``MinAdjustmentMagnitude`` of 2, Application Auto Scaling scales out the service by 2 tasks."},"stepAdjustments":{"type":"array","items":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyStepAdjustment"},"description":"A set of adjustments that enable you to scale based on the size of the alarm breach.\n At least one step adjustment is required if you are adding a new step scaling policy configuration."}},"type":"object"},"aws-native:applicationautoscaling:ScalingPolicyTargetTrackingMetric":{"description":"Represents a specific metric for a target tracking scaling policy for Application Auto Scaling.\n Metric is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricstat.html) property type.","properties":{"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyTargetTrackingMetricDimension"},"description":"The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*. \n Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy."},"metricName":{"type":"string","description":"The name of the metric."},"namespace":{"type":"string","description":"The namespace of the metric. For more information, see the table in [services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide*."}},"type":"object"},"aws-native:applicationautoscaling:ScalingPolicyTargetTrackingMetricDataQuery":{"description":"The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.\n You can call for a single metric or perform math expressions on multiple metrics. Any expressions used in a metric specification must eventually return a single time series.\n For more information and examples, see [Create a target tracking scaling policy for Application Auto Scaling using metric math](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html) in the *Application Auto Scaling User Guide*.\n ``TargetTrackingMetricDataQuery`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-customizedmetricspecification.html) property type.","properties":{"expression":{"type":"string","description":"The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. \n Conditional: Within each ``TargetTrackingMetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both."},"id":{"type":"string","description":"A short name that identifies the object's results in the response. This name must be unique among all ``MetricDataQuery`` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter."},"label":{"type":"string","description":"A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents."},"metricStat":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyTargetTrackingMetricStat","description":"Information about the metric data to return.\n Conditional: Within each ``MetricDataQuery`` object, you must specify either ``Expression`` or ``MetricStat``, but not both."},"returnData":{"type":"boolean","description":"Indicates whether to return the timestamps and raw data values of this metric. \n If you use any math expressions, specify ``true`` for this value for only the final math expression that the metric specification is based on. You must specify ``false`` for ``ReturnData`` for all the other metrics and expressions used in the metric specification.\n If you are only retrieving metrics and not performing any math expressions, do not specify anything for ``ReturnData``. This sets it to its default (``true``)."}},"type":"object"},"aws-native:applicationautoscaling:ScalingPolicyTargetTrackingMetricDimension":{"description":"``TargetTrackingMetricDimension`` specifies a name/value pair that is part of the identity of a CloudWatch metric for the ``Dimensions`` property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetric.html) property type. Duplicate dimensions are not allowed.","properties":{"name":{"type":"string","description":"The name of the dimension."},"value":{"type":"string","description":"The value of the dimension."}},"type":"object"},"aws-native:applicationautoscaling:ScalingPolicyTargetTrackingMetricStat":{"description":"This structure defines the CloudWatch metric to return, along with the statistic and unit.\n ``TargetTrackingMetricStat`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingMetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalingpolicy-targettrackingmetricdataquery.html) property type.\n For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide*.","properties":{"metric":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyTargetTrackingMetric","description":"The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html)."},"stat":{"type":"string","description":"The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide*.\n The most commonly used metric for scaling is ``Average``."},"unit":{"type":"string","description":"The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*."}},"type":"object"},"aws-native:applicationautoscaling:ScalingPolicyTargetTrackingScalingPolicyConfiguration":{"description":"``TargetTrackingScalingPolicyConfiguration`` is a property of the [AWS::ApplicationAutoScaling::ScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html) resource that specifies a target tracking scaling policy configuration for Application Auto Scaling. Use a target tracking scaling policy to adjust the capacity of the specified scalable target in response to actual workloads, so that resource utilization remains at or near the target utilization value. \n For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) in the *Application Auto Scaling User Guide*.","properties":{"customizedMetricSpecification":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyCustomizedMetricSpecification","description":"A customized metric. You can specify either a predefined metric or a customized metric."},"disableScaleIn":{"type":"boolean","description":"Indicates whether scale in by the target tracking scaling policy is disabled. If the value is ``true``, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is ``false``."},"predefinedMetricSpecification":{"$ref":"#/types/aws-native:applicationautoscaling:ScalingPolicyPredefinedMetricSpecification","description":"A predefined metric. You can specify either a predefined metric or a customized metric."},"scaleInCooldown":{"type":"integer","description":"The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling User Guide*."},"scaleOutCooldown":{"type":"integer","description":"The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see [Define cooldown periods](https://docs.aws.amazon.com/autoscaling/application/userguide/target-tracking-scaling-policy-overview.html#target-tracking-cooldown) in the *Application Auto Scaling User Guide*."},"targetValue":{"type":"number","description":"The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out."}},"type":"object","required":["targetValue"]},"aws-native:applicationinsights:ApplicationAlarm":{"description":"A CloudWatch alarm to be monitored for the component.","properties":{"alarmName":{"type":"string","description":"The name of the CloudWatch alarm to be monitored for the component."},"severity":{"$ref":"#/types/aws-native:applicationinsights:ApplicationAlarmSeverity","description":"Indicates the degree of outage when the alarm goes off."}},"type":"object","required":["alarmName"]},"aws-native:applicationinsights:ApplicationAlarmMetric":{"description":"A metric to be monitored for the component.","properties":{"alarmMetricName":{"type":"string","description":"The name of the metric to be monitored for the component."}},"type":"object","required":["alarmMetricName"]},"aws-native:applicationinsights:ApplicationAlarmSeverity":{"description":"Indicates the degree of outage when the alarm goes off.","type":"string","enum":[{"name":"High","value":"HIGH"},{"name":"Medium","value":"MEDIUM"},{"name":"Low","value":"LOW"}]},"aws-native:applicationinsights:ApplicationComponentConfiguration":{"description":"The configuration settings of the component.","properties":{"configurationDetails":{"$ref":"#/types/aws-native:applicationinsights:ApplicationConfigurationDetails","description":"The configuration settings"},"subComponentTypeConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationSubComponentTypeConfiguration"},"description":"Sub component configurations of the component."}},"type":"object"},"aws-native:applicationinsights:ApplicationComponentMonitoringSetting":{"description":"The monitoring setting of the component.","properties":{"componentArn":{"type":"string","description":"The ARN of the compnonent."},"componentConfigurationMode":{"$ref":"#/types/aws-native:applicationinsights:ApplicationComponentMonitoringSettingComponentConfigurationMode","description":"The component monitoring configuration mode."},"componentName":{"type":"string","description":"The name of the component."},"customComponentConfiguration":{"$ref":"#/types/aws-native:applicationinsights:ApplicationComponentConfiguration","description":"The monitoring configuration of the component."},"defaultOverwriteComponentConfiguration":{"$ref":"#/types/aws-native:applicationinsights:ApplicationComponentConfiguration","description":"The overwritten settings on default component monitoring configuration."},"tier":{"type":"string","description":"The tier of the application component."}},"type":"object","required":["componentConfigurationMode","tier"]},"aws-native:applicationinsights:ApplicationComponentMonitoringSettingComponentConfigurationMode":{"description":"The component monitoring configuration mode.","type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"DefaultWithOverwrite","value":"DEFAULT_WITH_OVERWRITE"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:applicationinsights:ApplicationConfigurationDetails":{"description":"The configuration settings.","properties":{"alarmMetrics":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationAlarmMetric"},"description":"A list of metrics to monitor for the component."},"alarms":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationAlarm"},"description":"A list of alarms to monitor for the component."},"haClusterPrometheusExporter":{"$ref":"#/types/aws-native:applicationinsights:ApplicationHaClusterPrometheusExporter","description":"The HA cluster Prometheus Exporter settings."},"hanaPrometheusExporter":{"$ref":"#/types/aws-native:applicationinsights:ApplicationHanaPrometheusExporter","description":"The HANA DB Prometheus Exporter settings."},"jmxPrometheusExporter":{"$ref":"#/types/aws-native:applicationinsights:ApplicationJmxPrometheusExporter","description":"The JMX Prometheus Exporter settings."},"logs":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationLog"},"description":"A list of logs to monitor for the component."},"netWeaverPrometheusExporter":{"$ref":"#/types/aws-native:applicationinsights:ApplicationNetWeaverPrometheusExporter","description":"The NetWeaver Prometheus Exporter settings."},"processes":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationProcess"},"description":"A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section."},"sqlServerPrometheusExporter":{"$ref":"#/types/aws-native:applicationinsights:ApplicationSqlServerPrometheusExporter","description":"The SQL Prometheus Exporter settings."},"windowsEvents":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationWindowsEvent"},"description":"A list of Windows Events to log."}},"type":"object"},"aws-native:applicationinsights:ApplicationCustomComponent":{"description":"The custom grouped component.","properties":{"componentName":{"type":"string","description":"The name of the component."},"resourceList":{"type":"array","items":{"type":"string"},"description":"The list of resource ARNs that belong to the component."}},"type":"object","required":["componentName","resourceList"]},"aws-native:applicationinsights:ApplicationEventLevel":{"description":"The level of event to log.","type":"string","enum":[{"name":"Information","value":"INFORMATION"},{"name":"Warning","value":"WARNING"},{"name":"Error","value":"ERROR"},{"name":"Critical","value":"CRITICAL"},{"name":"Verbose","value":"VERBOSE"}]},"aws-native:applicationinsights:ApplicationGroupingType":{"description":"The grouping type of the application","type":"string","enum":[{"name":"AccountBased","value":"ACCOUNT_BASED"}]},"aws-native:applicationinsights:ApplicationHaClusterPrometheusExporter":{"description":"The HA cluster Prometheus Exporter settings.","properties":{"prometheusPort":{"type":"string","description":"Prometheus exporter port."}},"type":"object"},"aws-native:applicationinsights:ApplicationHanaPrometheusExporter":{"description":"The HANA DB Prometheus Exporter settings.","properties":{"agreeToInstallHanadbClient":{"type":"boolean","description":"A flag which indicates agreeing to install SAP HANA DB client."},"hanaPort":{"type":"string","description":"The HANA DB port."},"hanaSecretName":{"type":"string","description":"The secret name which manages the HANA DB credentials e.g. {\n  \"username\": \"\u003c\u003e\",\n  \"password\": \"\u003c\u003e\"\n}."},"hanasid":{"type":"string","description":"HANA DB SID."},"prometheusPort":{"type":"string","description":"Prometheus exporter port."}},"type":"object","required":["agreeToInstallHanadbClient","hanaPort","hanaSecretName","hanasid"]},"aws-native:applicationinsights:ApplicationJmxPrometheusExporter":{"description":"The JMX Prometheus Exporter settings.","properties":{"hostPort":{"type":"string","description":"Java agent host port"},"jmxurl":{"type":"string","description":"JMX service URL."},"prometheusPort":{"type":"string","description":"Prometheus exporter port."}},"type":"object"},"aws-native:applicationinsights:ApplicationLog":{"description":"A log to be monitored for the component.","properties":{"encoding":{"$ref":"#/types/aws-native:applicationinsights:ApplicationLogEncoding","description":"The type of encoding of the logs to be monitored."},"logGroupName":{"type":"string","description":"The CloudWatch log group name to be associated to the monitored log."},"logPath":{"type":"string","description":"The path of the logs to be monitored."},"logType":{"type":"string","description":"The log type decides the log patterns against which Application Insights analyzes the log."},"patternSet":{"type":"string","description":"The name of the log pattern set."}},"type":"object","required":["logType"]},"aws-native:applicationinsights:ApplicationLogEncoding":{"description":"The type of encoding of the logs to be monitored.","type":"string","enum":[{"name":"Utf8","value":"utf-8"},{"name":"Utf16","value":"utf-16"},{"name":"Ascii","value":"ascii"}]},"aws-native:applicationinsights:ApplicationLogPattern":{"description":"The log pattern.","properties":{"pattern":{"type":"string","description":"The log pattern."},"patternName":{"type":"string","description":"The name of the log pattern."},"rank":{"type":"integer","description":"Rank of the log pattern."}},"type":"object","required":["pattern","patternName","rank"]},"aws-native:applicationinsights:ApplicationLogPatternSet":{"description":"The log pattern set.","properties":{"logPatterns":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationLogPattern"},"description":"The log patterns of a set."},"patternSetName":{"type":"string","description":"The name of the log pattern set."}},"type":"object","required":["logPatterns","patternSetName"]},"aws-native:applicationinsights:ApplicationNetWeaverPrometheusExporter":{"description":"The NetWeaver Prometheus Exporter Settings.","properties":{"instanceNumbers":{"type":"array","items":{"type":"string"},"description":"SAP instance numbers for ASCS, ERS, and App Servers."},"prometheusPort":{"type":"string","description":"Prometheus exporter port."},"sapsid":{"type":"string","description":"SAP NetWeaver SID."}},"type":"object","required":["instanceNumbers","sapsid"]},"aws-native:applicationinsights:ApplicationProcess":{"description":"A process to be monitored for the component.","properties":{"alarmMetrics":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationAlarmMetric"},"description":"A list of metrics to monitor for the component."},"processName":{"type":"string","description":"The name of the process to be monitored for the component."}},"type":"object","required":["alarmMetrics","processName"]},"aws-native:applicationinsights:ApplicationSqlServerPrometheusExporter":{"description":"The SQL prometheus exporter settings.","properties":{"prometheusPort":{"type":"string","description":"Prometheus exporter port."},"sqlSecretName":{"type":"string","description":"Secret name which managers SQL exporter connection. e.g. {\"data_source_name\": \"sqlserver://\u003cUSERNAME\u003e:\u003cPASSWORD\u003e@localhost:1433\"}"}},"type":"object","required":["prometheusPort","sqlSecretName"]},"aws-native:applicationinsights:ApplicationSubComponentConfigurationDetails":{"description":"The configuration settings of sub components.","properties":{"alarmMetrics":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationAlarmMetric"},"description":"A list of metrics to monitor for the component."},"logs":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationLog"},"description":"A list of logs to monitor for the component."},"processes":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationProcess"},"description":"A list of processes to monitor for the component. Only Windows EC2 instances can have a processes section."},"windowsEvents":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationWindowsEvent"},"description":"A list of Windows Events to log."}},"type":"object"},"aws-native:applicationinsights:ApplicationSubComponentTypeConfiguration":{"description":"One type sub component configurations for the component.","properties":{"subComponentConfigurationDetails":{"$ref":"#/types/aws-native:applicationinsights:ApplicationSubComponentConfigurationDetails","description":"The configuration settings of sub components."},"subComponentType":{"$ref":"#/types/aws-native:applicationinsights:ApplicationSubComponentTypeConfigurationSubComponentType","description":"The sub component type."}},"type":"object","required":["subComponentConfigurationDetails","subComponentType"]},"aws-native:applicationinsights:ApplicationSubComponentTypeConfigurationSubComponentType":{"description":"The sub component type.","type":"string","enum":[{"name":"Awsec2Instance","value":"AWS::EC2::Instance"},{"name":"Awsec2Volume","value":"AWS::EC2::Volume"}]},"aws-native:applicationinsights:ApplicationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:applicationinsights:ApplicationWindowsEvent":{"description":"A Windows Event to be monitored for the component.","properties":{"eventLevels":{"type":"array","items":{"$ref":"#/types/aws-native:applicationinsights:ApplicationEventLevel"},"description":"The levels of event to log. "},"eventName":{"type":"string","description":"The type of Windows Events to log."},"logGroupName":{"type":"string","description":"The CloudWatch log group name to be associated to the monitored log."},"patternSet":{"type":"string","description":"The name of the log pattern set."}},"type":"object","required":["eventLevels","eventName","logGroupName"]},"aws-native:applicationsignals:GroupingConfigurationGroupingAttributeDefinition":{"properties":{"defaultGroupingValue":{"type":"string"},"groupingName":{"type":"string"},"groupingSourceKeys":{"type":"array","items":{"type":"string"}}},"type":"object","required":["groupingName","groupingSourceKeys"]},"aws-native:applicationsignals:ServiceLevelObjectiveBurnRateConfiguration":{"description":"This object defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO. A burn rate of exactly 1 indicates that the SLO goal will be met exactly.\nFor example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:\nburn rate = error rate over the look-back window / (1 - attainment goal percentage)","properties":{"lookBackWindowMinutes":{"type":"integer","description":"The number of minutes to use as the look-back window."}},"type":"object","required":["lookBackWindowMinutes"]},"aws-native:applicationsignals:ServiceLevelObjectiveCalendarInterval":{"description":"If the interval for this service level objective is a calendar interval, this structure contains the interval specifications.","properties":{"duration":{"type":"integer","description":"Specifies the duration of each calendar interval. For example, if `Duration` is `1` and `DurationUnit` is `MONTH` , each interval is one month, aligned with the calendar."},"durationUnit":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveDurationUnit","description":"Specifies the calendar interval unit."},"startTime":{"type":"integer","description":"Epoch time in seconds you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.\nAs soon as one calendar interval ends, another automatically begins."}},"type":"object","required":["duration","durationUnit","startTime"]},"aws-native:applicationsignals:ServiceLevelObjectiveDependencyConfig":{"description":"Configuration for identifying a dependency and its operation","properties":{"dependencyKeyAttributes":{"type":"object","additionalProperties":{"type":"string"},"description":"If this SLO is related to a metric collected by Application Signals, you must use this field to specify which dependency the SLO metric is related to.\n\n- `Type` designates the type of object this is.\n- `ResourceType` specifies the type of the resource. This field is used only when the value of the `Type` field is `Resource` or `AWS::Resource` .\n- `Name` specifies the name of the object. This is used only if the value of the `Type` field is `Service` , `RemoteService` , or `AWS::Service` .\n- `Identifier` identifies the resource objects of this resource. This is used only if the value of the `Type` field is `Resource` or `AWS::Resource` .\n- `Environment` specifies the location where this object is hosted, or what it belongs to."},"dependencyOperationName":{"type":"string","description":"When the SLO monitors a specific operation of the dependency, this field specifies the name of that operation in the dependency."}},"type":"object","required":["dependencyKeyAttributes","dependencyOperationName"]},"aws-native:applicationsignals:ServiceLevelObjectiveDimension":{"description":"A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish `InstanceId` as a dimension name, and the actual instance ID as the value for that dimension. You can assign up to 30 dimensions to a metric.","properties":{"name":{"type":"string","description":"The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). ASCII control characters are not supported as part of dimension names."},"value":{"type":"string","description":"The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values"}},"type":"object","required":["name","value"]},"aws-native:applicationsignals:ServiceLevelObjectiveDurationUnit":{"description":"Specifies the interval unit.","type":"string","enum":[{"name":"Minute","value":"MINUTE"},{"name":"Hour","value":"HOUR"},{"name":"Day","value":"DAY"},{"name":"Month","value":"MONTH"}]},"aws-native:applicationsignals:ServiceLevelObjectiveEvaluationType":{"description":"Displays whether this is a period-based SLO or a request-based SLO.","type":"string","enum":[{"name":"PeriodBased","value":"PeriodBased"},{"name":"RequestBased","value":"RequestBased"}]},"aws-native:applicationsignals:ServiceLevelObjectiveExclusionWindow":{"description":"This object defines a time exclusion window for this SLO. The time exclusion window is used to exclude breaching data points from affecting attainment rate, error budget, and burn rate metrics.","properties":{"reason":{"type":"string","description":"An optional reason for scheduling this time exclusion window. Default is 'No reason'."},"recurrenceRule":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveRecurrenceRule"},"startTime":{"type":"string","description":"The time you want the exclusion window to start at. Note that time exclusion windows can only be scheduled in the future, not the past."},"window":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveWindow"}},"type":"object","required":["window"]},"aws-native:applicationsignals:ServiceLevelObjectiveGoal":{"description":"A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.","properties":{"attainmentGoal":{"type":"number","description":"The threshold that determines if the goal is being met. An attainment goal is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.\nIf you omit this parameter, 99 is used to represent 99% as the attainment goal."},"interval":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveInterval","description":"The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.\n\nIf you omit this parameter, a rolling interval of 7 days is used."},"warningThreshold":{"type":"number","description":"The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used."}},"type":"object"},"aws-native:applicationsignals:ServiceLevelObjectiveInterval":{"description":"The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.\nIf you omit this parameter, a rolling interval of 7 days is used.","properties":{"calendarInterval":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveCalendarInterval","description":"If the interval is a calendar interval, this structure contains the interval specifications."},"rollingInterval":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveRollingInterval","description":"If the interval is a rolling interval, this structure contains the interval specifications."}},"type":"object"},"aws-native:applicationsignals:ServiceLevelObjectiveMetric":{"description":"This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions.","properties":{"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveDimension"},"description":"An array of one or more dimensions to use to define the metric that you want to use."},"metricName":{"type":"string","description":"The name of the metric to use."},"namespace":{"type":"string","description":"The namespace of the metric."}},"type":"object"},"aws-native:applicationsignals:ServiceLevelObjectiveMetricDataQuery":{"description":"Use this structure to define a metric or metric math expression that you want to use as for a service level objective.\nEach `MetricDataQuery` in the `MetricDataQueries` array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single `MetricDataQueries` array can include as many as 20 `MetricDataQuery` structures in the array. The 20 structures can include as many as 10 structures that contain a `MetricStat` parameter to retrieve a metric, and as many as 10 structures that contain the `Expression` parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for `ReturnData`. The result of this expression used for the SLO.","properties":{"accountId":{"type":"string","description":"The ID of the account where the metrics are located, if this is a cross-account alarm."},"expression":{"type":"string","description":"The math expression to be performed on the returned data."},"id":{"type":"string","description":"A short name used to tie this object to the results in the response."},"metricStat":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveMetricStat","description":"A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery, you must specify either Expression or MetricStat but not both."},"returnData":{"type":"boolean","description":"This option indicates whether to return the timestamps and raw data values of this metric."}},"type":"object","required":["id"]},"aws-native:applicationsignals:ServiceLevelObjectiveMetricStat":{"description":"A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO. Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.","properties":{"metric":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveMetric"},"period":{"type":"integer","description":"The granularity, in seconds, to be used for the metric."},"stat":{"type":"string","description":"The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic."},"unit":{"type":"string","description":"If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions."}},"type":"object","required":["metric","period","stat"]},"aws-native:applicationsignals:ServiceLevelObjectiveMonitoredRequestCountMetric":{"description":"This structure defines the metric that is used as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in `TotalRequestCountMetric` is divided by the number found for `MonitoredRequestCountMetric` to determine the percentage of successful requests that this SLO tracks.","properties":{"badCountMetric":{"type":"array","items":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveMetricDataQuery"},"description":"If you want to count \"bad requests\" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as \"bad requests\" in this structure."},"goodCountMetric":{"type":"array","items":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveMetricDataQuery"},"description":"If you want to count \"good requests\" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as \"good requests\" in this structure."}},"type":"object"},"aws-native:applicationsignals:ServiceLevelObjectiveRecurrenceRule":{"description":"This object defines how often to repeat a time exclusion window.","properties":{"expression":{"type":"string","description":"A cron or rate expression denoting how often to repeat this exclusion window."}},"type":"object","required":["expression"]},"aws-native:applicationsignals:ServiceLevelObjectiveRequestBasedSli":{"description":"This structure contains information about the performance metric that a request-based SLO monitors.","properties":{"comparisonOperator":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveRequestBasedSliComparisonOperator","description":"The arithmetic operation used when comparing the specified metric to the threshold."},"metricThreshold":{"type":"number","description":"The value that the SLI metric is compared to."},"requestBasedSliMetric":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveRequestBasedSliMetric","description":"A structure that contains information about the metric that the SLO monitors."}},"type":"object","required":["requestBasedSliMetric"]},"aws-native:applicationsignals:ServiceLevelObjectiveRequestBasedSliComparisonOperator":{"description":"The arithmetic operation used when comparing the specified metric to the threshold.","type":"string","enum":[{"name":"GreaterThanOrEqualTo","value":"GreaterThanOrEqualTo"},{"name":"LessThanOrEqualTo","value":"LessThanOrEqualTo"},{"name":"LessThan","value":"LessThan"},{"name":"GreaterThan","value":"GreaterThan"}]},"aws-native:applicationsignals:ServiceLevelObjectiveRequestBasedSliMetric":{"description":"This structure contains the information about the metric that is used for a request-based SLO.","properties":{"dependencyConfig":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveDependencyConfig","description":"Identifies the dependency using the `DependencyKeyAttributes` and `DependencyOperationName` ."},"keyAttributes":{"type":"object","additionalProperties":{"type":"string"},"description":"This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.\n\n- `Type` designates the type of object that this SLO is related to.\n- `ResourceType` specifies the type of the resource. This field is used only when the value of the `Type` field is `Resource` or `AWS::Resource` .\n- `Name` specifies the name of the object. This is used only if the value of the `Type` field is `Service` , `RemoteService` , or `AWS::Service` .\n- `Identifier` identifies the resource objects of this resource. This is used only if the value of the `Type` field is `Resource` or `AWS::Resource` .\n- `Environment` specifies the location where this object is hosted, or what it belongs to.\n- `AwsAccountId` allows you to create an SLO for an object that exists in another account."},"metricType":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveRequestBasedSliMetricMetricType","description":"If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used."},"monitoredRequestCountMetric":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveMonitoredRequestCountMetric","description":"Use this structure to define the metric that you want to use as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in `TotalRequestCountMetric` will be divided by the number found for `MonitoredRequestCountMetric` to determine the percentage of successful requests that this SLO tracks."},"operationName":{"type":"string","description":"If the SLO monitors a specific operation of the service, this field displays that operation name."},"totalRequestCountMetric":{"type":"array","items":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveMetricDataQuery"},"description":"This structure defines the metric that is used as the \"total requests\" number for a request-based SLO. The number observed for this metric is divided by the number of \"good requests\" or \"bad requests\" that is observed for the metric defined in `MonitoredRequestCountMetric`."}},"type":"object"},"aws-native:applicationsignals:ServiceLevelObjectiveRequestBasedSliMetricMetricType":{"description":"If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.","type":"string","enum":[{"name":"Latency","value":"LATENCY"},{"name":"Availability","value":"AVAILABILITY"}]},"aws-native:applicationsignals:ServiceLevelObjectiveRollingInterval":{"description":"If the interval is a calendar interval, this structure contains the interval specifications.","properties":{"duration":{"type":"integer","description":"Specifies the duration of each rolling interval. For example, if `Duration` is `7` and `DurationUnit` is `DAY` , each rolling interval is seven days."},"durationUnit":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveDurationUnit","description":"Specifies the rolling interval unit."}},"type":"object","required":["duration","durationUnit"]},"aws-native:applicationsignals:ServiceLevelObjectiveSli":{"description":"This structure contains information about the performance metric that an SLO monitors.","properties":{"comparisonOperator":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveSliComparisonOperator","description":"The arithmetic operation used when comparing the specified metric to the threshold."},"metricThreshold":{"type":"number","description":"The value that the SLI metric is compared to."},"sliMetric":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveSliMetric","description":"Use this structure to specify the metric to be used for the SLO."}},"type":"object","required":["comparisonOperator","metricThreshold","sliMetric"]},"aws-native:applicationsignals:ServiceLevelObjectiveSliComparisonOperator":{"description":"The arithmetic operation used when comparing the specified metric to the threshold.","type":"string","enum":[{"name":"GreaterThanOrEqualTo","value":"GreaterThanOrEqualTo"},{"name":"LessThanOrEqualTo","value":"LessThanOrEqualTo"},{"name":"LessThan","value":"LessThan"},{"name":"GreaterThan","value":"GreaterThan"}]},"aws-native:applicationsignals:ServiceLevelObjectiveSliMetric":{"description":"A structure that contains information about the metric that the SLO monitors.","properties":{"dependencyConfig":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveDependencyConfig","description":"Identifies the dependency using the `DependencyKeyAttributes` and `DependencyOperationName` ."},"keyAttributes":{"type":"object","additionalProperties":{"type":"string"},"description":"If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the `Type` , `Name` , and `Environment` attributes.\n\nThis is a string-to-string map. It can include the following fields.\n\n- `Type` designates the type of object this is.\n- `ResourceType` specifies the type of the resource. This field is used only when the value of the `Type` field is `Resource` or `AWS::Resource` .\n- `Name` specifies the name of the object. This is used only if the value of the `Type` field is `Service` , `RemoteService` , or `AWS::Service` .\n- `Identifier` identifies the resource objects of this resource. This is used only if the value of the `Type` field is `Resource` or `AWS::Resource` .\n- `Environment` specifies the location where this object is hosted, or what it belongs to."},"metricDataQueries":{"type":"array","items":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveMetricDataQuery"},"description":"If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression."},"metricType":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveSliMetricMetricType","description":"If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used."},"operationName":{"type":"string","description":"If the SLO monitors a specific operation of the service, this field displays that operation name."},"periodSeconds":{"type":"integer","description":"The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance."},"statistic":{"type":"string","description":"The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic"}},"type":"object"},"aws-native:applicationsignals:ServiceLevelObjectiveSliMetricMetricType":{"description":"If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.","type":"string","enum":[{"name":"Latency","value":"LATENCY"},{"name":"Availability","value":"AVAILABILITY"}]},"aws-native:applicationsignals:ServiceLevelObjectiveTag":{"properties":{"key":{"type":"string","description":"A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:applicationsignals:ServiceLevelObjectiveWindow":{"description":"This object defines the length of time an exclusion window should span.","properties":{"duration":{"type":"integer"},"durationUnit":{"$ref":"#/types/aws-native:applicationsignals:ServiceLevelObjectiveDurationUnit"}},"type":"object","required":["duration","durationUnit"]},"aws-native:apprunner:AutoScalingConfigurationTag":{"properties":{"key":{"type":"string","description":"The key of the tag assigned to the `AutoScalingConfiguration` resource of the App Runner service."},"value":{"type":"string","description":"The value of the tag assigned to the `AutoScalingConfiguration` resource of the App Runner service."}},"type":"object"},"aws-native:apprunner:ObservabilityConfigurationTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object"},"aws-native:apprunner:ObservabilityConfigurationTraceConfiguration":{"description":"Describes the configuration of the tracing feature within an AWS App Runner observability configuration.","properties":{"vendor":{"$ref":"#/types/aws-native:apprunner:ObservabilityConfigurationTraceConfigurationVendor","description":"The implementation provider chosen for tracing App Runner services."}},"type":"object","required":["vendor"]},"aws-native:apprunner:ObservabilityConfigurationTraceConfigurationVendor":{"description":"The implementation provider chosen for tracing App Runner services.","type":"string","enum":[{"name":"Awsxray","value":"AWSXRAY"}]},"aws-native:apprunner:ServiceAuthenticationConfiguration":{"description":"Authentication Configuration","properties":{"accessRoleArn":{"type":"string","description":"Access Role Arn"},"connectionArn":{"type":"string","description":"Connection Arn"}},"type":"object"},"aws-native:apprunner:ServiceCodeConfiguration":{"description":"Code Configuration","properties":{"codeConfigurationValues":{"$ref":"#/types/aws-native:apprunner:ServiceCodeConfigurationValues","description":"The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a `apprunner.yaml` file in the source code repository (or ignoring the file if it exists)."},"configurationSource":{"$ref":"#/types/aws-native:apprunner:ServiceCodeConfigurationConfigurationSource","description":"Configuration Source"}},"type":"object","required":["configurationSource"]},"aws-native:apprunner:ServiceCodeConfigurationConfigurationSource":{"description":"Configuration Source","type":"string","enum":[{"name":"Repository","value":"REPOSITORY"},{"name":"Api","value":"API"}]},"aws-native:apprunner:ServiceCodeConfigurationValues":{"description":"Code Configuration Values","properties":{"buildCommand":{"type":"string","description":"Build Command"},"port":{"type":"string","description":"Port"},"runtime":{"$ref":"#/types/aws-native:apprunner:ServiceCodeConfigurationValuesRuntime","description":"Runtime"},"runtimeEnvironmentSecrets":{"type":"array","items":{"$ref":"#/types/aws-native:apprunner:ServiceKeyValuePair"},"description":"The secrets and parameters that get referenced by your service as environment variables"},"runtimeEnvironmentVariables":{"type":"array","items":{"$ref":"#/types/aws-native:apprunner:ServiceKeyValuePair"},"description":"The environment variables that are available to your running AWS App Runner service. An array of key-value pairs."},"startCommand":{"type":"string","description":"Start Command"}},"type":"object","required":["runtime"]},"aws-native:apprunner:ServiceCodeConfigurationValuesRuntime":{"description":"Runtime","type":"string","enum":[{"name":"Python3","value":"PYTHON_3"},{"name":"Nodejs12","value":"NODEJS_12"},{"name":"Nodejs14","value":"NODEJS_14"},{"name":"Corretto8","value":"CORRETTO_8"},{"name":"Corretto11","value":"CORRETTO_11"},{"name":"Nodejs16","value":"NODEJS_16"},{"name":"Go1","value":"GO_1"},{"name":"Dotnet6","value":"DOTNET_6"},{"name":"Php81","value":"PHP_81"},{"name":"Ruby31","value":"RUBY_31"},{"name":"Python311","value":"PYTHON_311"},{"name":"Nodejs18","value":"NODEJS_18"},{"name":"Nodejs22","value":"NODEJS_22"}]},"aws-native:apprunner:ServiceCodeRepository":{"description":"Source Code Repository","properties":{"codeConfiguration":{"$ref":"#/types/aws-native:apprunner:ServiceCodeConfiguration","description":"Configuration for building and running the service from a source code repository.\n\n\u003e `CodeConfiguration` is required only for `CreateService` request."},"repositoryUrl":{"type":"string","description":"Repository Url"},"sourceCodeVersion":{"$ref":"#/types/aws-native:apprunner:ServiceSourceCodeVersion","description":"The version that should be used within the source code repository."},"sourceDirectory":{"type":"string","description":"Source Directory"}},"type":"object","required":["repositoryUrl","sourceCodeVersion"]},"aws-native:apprunner:ServiceEgressConfiguration":{"description":"Network egress configuration","properties":{"egressType":{"$ref":"#/types/aws-native:apprunner:ServiceEgressConfigurationEgressType","description":"Network egress type."},"vpcConnectorArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the App Runner VpcConnector."}},"type":"object","required":["egressType"]},"aws-native:apprunner:ServiceEgressConfigurationEgressType":{"description":"Network egress type.","type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"Vpc","value":"VPC"}]},"aws-native:apprunner:ServiceEncryptionConfiguration":{"description":"Encryption configuration (KMS key)","properties":{"kmsKey":{"type":"string","description":"The KMS Key"}},"type":"object","required":["kmsKey"]},"aws-native:apprunner:ServiceHealthCheckConfiguration":{"description":"Health check configuration","properties":{"healthyThreshold":{"type":"integer","description":"Health check Healthy Threshold"},"interval":{"type":"integer","description":"Health check Interval"},"path":{"type":"string","description":"Health check Path"},"protocol":{"$ref":"#/types/aws-native:apprunner:ServiceHealthCheckConfigurationProtocol","description":"Health Check Protocol"},"timeout":{"type":"integer","description":"Health check Timeout"},"unhealthyThreshold":{"type":"integer","description":"Health check Unhealthy Threshold"}},"type":"object"},"aws-native:apprunner:ServiceHealthCheckConfigurationProtocol":{"description":"Health Check Protocol","type":"string","enum":[{"name":"Tcp","value":"TCP"},{"name":"Http","value":"HTTP"}]},"aws-native:apprunner:ServiceImageConfiguration":{"description":"Image Configuration","properties":{"port":{"type":"string","description":"Port"},"runtimeEnvironmentSecrets":{"type":"array","items":{"$ref":"#/types/aws-native:apprunner:ServiceKeyValuePair"},"description":"The secrets and parameters that get referenced by your service as environment variables"},"runtimeEnvironmentVariables":{"type":"array","items":{"$ref":"#/types/aws-native:apprunner:ServiceKeyValuePair"},"description":"Environment variables that are available to your running App Runner service. An array of key-value pairs."},"startCommand":{"type":"string","description":"Start Command"}},"type":"object"},"aws-native:apprunner:ServiceImageRepository":{"description":"Image Repository","properties":{"imageConfiguration":{"$ref":"#/types/aws-native:apprunner:ServiceImageConfiguration","description":"Configuration for running the identified image."},"imageIdentifier":{"type":"string","description":"Image Identifier"},"imageRepositoryType":{"$ref":"#/types/aws-native:apprunner:ServiceImageRepositoryImageRepositoryType","description":"Image Repository Type"}},"type":"object","required":["imageIdentifier","imageRepositoryType"]},"aws-native:apprunner:ServiceImageRepositoryImageRepositoryType":{"description":"Image Repository Type","type":"string","enum":[{"name":"Ecr","value":"ECR"},{"name":"EcrPublic","value":"ECR_PUBLIC"}]},"aws-native:apprunner:ServiceIngressConfiguration":{"description":"Network ingress configuration","properties":{"isPubliclyAccessible":{"type":"boolean","description":"It's set to true if the Apprunner service is publicly accessible. It's set to false otherwise."}},"type":"object","required":["isPubliclyAccessible"]},"aws-native:apprunner:ServiceInstanceConfiguration":{"description":"Instance Configuration","properties":{"cpu":{"type":"string","description":"CPU"},"instanceRoleArn":{"type":"string","description":"Instance Role Arn"},"memory":{"type":"string","description":"Memory"}},"type":"object"},"aws-native:apprunner:ServiceKeyValuePair":{"properties":{"name":{"type":"string","description":"The key name string to map to a value."},"value":{"type":"string","description":"The value string to which the key name is mapped."}},"type":"object"},"aws-native:apprunner:ServiceNetworkConfiguration":{"description":"Network configuration","properties":{"egressConfiguration":{"$ref":"#/types/aws-native:apprunner:ServiceEgressConfiguration","description":"Network configuration settings for outbound message traffic."},"ingressConfiguration":{"$ref":"#/types/aws-native:apprunner:ServiceIngressConfiguration","description":"Network configuration settings for inbound message traffic."},"ipAddressType":{"$ref":"#/types/aws-native:apprunner:ServiceNetworkConfigurationIpAddressType","description":"App Runner service endpoint IP address type"}},"type":"object"},"aws-native:apprunner:ServiceNetworkConfigurationIpAddressType":{"description":"App Runner service endpoint IP address type","type":"string","enum":[{"name":"Ipv4","value":"IPV4"},{"name":"DualStack","value":"DUAL_STACK"}]},"aws-native:apprunner:ServiceObservabilityConfiguration":{"description":"Service observability configuration","properties":{"observabilityConfigurationArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the App Runner ObservabilityConfiguration."},"observabilityEnabled":{"type":"boolean","description":"Observability enabled"}},"type":"object","required":["observabilityEnabled"]},"aws-native:apprunner:ServiceSourceCodeVersion":{"description":"Source Code Version","properties":{"type":{"$ref":"#/types/aws-native:apprunner:ServiceSourceCodeVersionType","description":"Source Code Version Type"},"value":{"type":"string","description":"Source Code Version Value"}},"type":"object","required":["type","value"]},"aws-native:apprunner:ServiceSourceCodeVersionType":{"description":"Source Code Version Type","type":"string","enum":[{"name":"Branch","value":"BRANCH"}]},"aws-native:apprunner:ServiceSourceConfiguration":{"description":"Source Code configuration","properties":{"authenticationConfiguration":{"$ref":"#/types/aws-native:apprunner:ServiceAuthenticationConfiguration","description":"Describes the resources that are needed to authenticate access to some source repositories."},"autoDeploymentsEnabled":{"type":"boolean","description":"Auto Deployment enabled"},"codeRepository":{"$ref":"#/types/aws-native:apprunner:ServiceCodeRepository","description":"The description of a source code repository.\n\nYou must provide either this member or `ImageRepository` (but not both)."},"imageRepository":{"$ref":"#/types/aws-native:apprunner:ServiceImageRepository","description":"The description of a source image repository.\n\nYou must provide either this member or `CodeRepository` (but not both)."}},"type":"object"},"aws-native:apprunner:ServiceTag":{"properties":{"key":{"type":"string","description":"The key of the tag assigned to an App Runner service."},"value":{"type":"string","description":"The value of the tag assigned to an App Runner service."}},"type":"object"},"aws-native:apprunner:VpcConnectorTag":{"properties":{"key":{"type":"string","description":"The key of the tag assigned to the `VpcConnector` resource of the App Runner service."},"value":{"type":"string","description":"The value of the tag assigned to the `VpcConnector` resource of the App Runner service."}},"type":"object"},"aws-native:apprunner:VpcIngressConnectionIngressVpcConfiguration":{"description":"The configuration of customer’s VPC and related VPC endpoint","properties":{"vpcEndpointId":{"type":"string","description":"The ID of the VPC endpoint that your App Runner service connects to."},"vpcId":{"type":"string","description":"The ID of the VPC that the VPC endpoint is used in."}},"type":"object","required":["vpcEndpointId","vpcId"]},"aws-native:apprunner:VpcIngressConnectionStatus":{"description":"The current status of the VpcIngressConnection.","type":"string","enum":[{"name":"Available","value":"AVAILABLE"},{"name":"PendingCreation","value":"PENDING_CREATION"},{"name":"PendingUpdate","value":"PENDING_UPDATE"},{"name":"PendingDeletion","value":"PENDING_DELETION"},{"name":"FailedCreation","value":"FAILED_CREATION"},{"name":"FailedUpdate","value":"FAILED_UPDATE"},{"name":"FailedDeletion","value":"FAILED_DELETION"},{"name":"Deleted","value":"DELETED"}]},"aws-native:apprunner:VpcIngressConnectionTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag assigned to `VpcIngressConnection` resource of the App Runner service."}},"type":"object"},"aws-native:appstream:AppBlockBuilderAccessEndpoint":{"properties":{"endpointType":{"type":"string","description":"The type of interface endpoint."},"vpceId":{"type":"string","description":"The identifier (ID) of the VPC in which the interface endpoint is used."}},"type":"object","required":["endpointType","vpceId"]},"aws-native:appstream:AppBlockBuilderTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:appstream:AppBlockBuilderVpcConfig":{"properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the security groups for the fleet or image builder."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet."}},"type":"object"},"aws-native:appstream:AppBlockS3Location":{"properties":{"s3Bucket":{"type":"string","description":"The S3 bucket of the app block."},"s3Key":{"type":"string","description":"The S3 key of the S3 object of the virtual hard disk.\n\nThis is required when it's used by `SetupScriptDetails` and `PostSetupScriptDetails` ."}},"type":"object","required":["s3Bucket"]},"aws-native:appstream:AppBlockScriptDetails":{"properties":{"executableParameters":{"type":"string","description":"The parameters used in the run path for the script."},"executablePath":{"type":"string","description":"The run path for the script."},"scriptS3Location":{"$ref":"#/types/aws-native:appstream:AppBlockS3Location","description":"The S3 object location of the script."},"timeoutInSeconds":{"type":"integer","description":"The run timeout, in seconds, for the script."}},"type":"object","required":["executablePath","scriptS3Location","timeoutInSeconds"]},"aws-native:appstream:AppBlockTag0Properties":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:appstream:AppBlockTag1Properties":{"properties":{"tagKey":{"type":"string"},"tagValue":{"type":"string"}},"type":"object","required":["tagKey","tagValue"]},"aws-native:appstream:ApplicationS3Location":{"properties":{"s3Bucket":{"type":"string","description":"The S3 bucket of the S3 object."},"s3Key":{"type":"string","description":"The S3 key of the S3 object."}},"type":"object","required":["s3Bucket","s3Key"]},"aws-native:appstream:ApplicationTag0Properties":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:appstream:ApplicationTag1Properties":{"properties":{"tagKey":{"type":"string"},"tagValue":{"type":"string"}},"type":"object","required":["tagKey","tagValue"]},"aws-native:appstream:DirectoryConfigCertificateBasedAuthProperties":{"properties":{"certificateAuthorityArn":{"type":"string","description":"The ARN of the AWS Certificate Manager Private CA resource."},"status":{"type":"string","description":"The status of the certificate-based authentication properties. Fallback is turned on by default when certificate-based authentication is *Enabled* . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. *Enabled_no_directory_login_fallback* enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates."}},"type":"object"},"aws-native:appstream:DirectoryConfigServiceAccountCredentials":{"properties":{"accountName":{"type":"string","description":"The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified."},"accountPassword":{"type":"string","description":"The password for the account."}},"type":"object","required":["accountName","accountPassword"]},"aws-native:appstream:EntitlementAttribute":{"properties":{"name":{"type":"string","description":"A supported AWS IAM SAML PrincipalTag attribute that is matched to a value when a user identity federates to an AppStream 2.0 SAML application.\n\nThe following are supported values:\n\n- roles\n- department\n- organization\n- groups\n- title\n- costCenter\n- userType"},"value":{"type":"string","description":"A value that is matched to a supported SAML attribute name when a user identity federates to an AppStream 2.0 SAML application."}},"type":"object","required":["name","value"]},"aws-native:appstream:ImageBuilderAccessEndpoint":{"properties":{"endpointType":{"type":"string","description":"The type of interface endpoint."},"vpceId":{"type":"string","description":"The identifier (ID) of the VPC in which the interface endpoint is used."}},"type":"object","required":["endpointType","vpceId"]},"aws-native:appstream:ImageBuilderDomainJoinInfo":{"properties":{"directoryName":{"type":"string","description":"The fully qualified name of the directory (for example, corp.example.com)."},"organizationalUnitDistinguishedName":{"type":"string","description":"The distinguished name of the organizational unit for computer accounts."}},"type":"object"},"aws-native:appstream:ImageBuilderTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:appstream:ImageBuilderVpcConfig":{"properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the security groups for the image builder."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The identifier of the subnet to which a network interface is attached from the image builder instance. An image builder instance can use one subnet."}},"type":"object"},"aws-native:appsync:ApiAuthMode":{"description":"An auth mode.","properties":{"authType":{"$ref":"#/types/aws-native:appsync:ApiAuthenticationType"}},"type":"object"},"aws-native:appsync:ApiAuthProvider":{"description":"An auth provider for the AppSync API.","properties":{"authType":{"$ref":"#/types/aws-native:appsync:ApiAuthenticationType"},"cognitoConfig":{"$ref":"#/types/aws-native:appsync:ApiCognitoConfig"},"lambdaAuthorizerConfig":{"$ref":"#/types/aws-native:appsync:ApiLambdaAuthorizerConfig"},"openIdConnectConfig":{"$ref":"#/types/aws-native:appsync:ApiOpenIdConnectConfig"}},"type":"object","required":["authType"]},"aws-native:appsync:ApiAuthenticationType":{"description":"Security configuration for your AppSync API.","type":"string","enum":[{"name":"AmazonCognitoUserPools","value":"AMAZON_COGNITO_USER_POOLS"},{"name":"AwsIam","value":"AWS_IAM"},{"name":"ApiKey","value":"API_KEY"},{"name":"OpenidConnect","value":"OPENID_CONNECT"},{"name":"AwsLambda","value":"AWS_LAMBDA"}]},"aws-native:appsync:ApiCognitoConfig":{"description":"Optional authorization configuration for using Amazon Cognito user pools with your API endpoint.","properties":{"appIdClientRegex":{"type":"string"},"awsRegion":{"type":"string"},"userPoolId":{"type":"string"}},"type":"object","required":["awsRegion","userPoolId"]},"aws-native:appsync:ApiDnsMap":{"description":"A map of DNS names for the AppSync API.","properties":{"http":{"type":"string","description":"The domain name of the Api's HTTP endpoint."},"realtime":{"type":"string","description":"The domain name of the Api's real-time endpoint."}},"type":"object"},"aws-native:appsync:ApiEventConfig":{"description":"The configuration for an Event Api","properties":{"authProviders":{"type":"array","items":{"$ref":"#/types/aws-native:appsync:ApiAuthProvider"},"description":"A list of authorization providers."},"connectionAuthModes":{"type":"array","items":{"$ref":"#/types/aws-native:appsync:ApiAuthMode"},"description":"A list of valid authorization modes for the Event API connections."},"defaultPublishAuthModes":{"type":"array","items":{"$ref":"#/types/aws-native:appsync:ApiAuthMode"},"description":"A list of valid authorization modes for the Event API publishing."},"defaultSubscribeAuthModes":{"type":"array","items":{"$ref":"#/types/aws-native:appsync:ApiAuthMode"},"description":"A list of valid authorization modes for the Event API subscriptions."},"logConfig":{"$ref":"#/types/aws-native:appsync:ApiEventLogConfig","description":"The CloudWatch Logs configuration for the Event API."}},"type":"object","required":["authProviders","connectionAuthModes","defaultPublishAuthModes","defaultSubscribeAuthModes"]},"aws-native:appsync:ApiEventLogConfig":{"description":"The log config for the AppSync API.","properties":{"cloudWatchLogsRoleArn":{"type":"string","description":"The IAM service role that AWS AppSync assumes to publish CloudWatch Logs in your account."},"logLevel":{"$ref":"#/types/aws-native:appsync:ApiEventLogLevel","description":"The type of information to log for the Event API."}},"type":"object","required":["cloudWatchLogsRoleArn","logLevel"]},"aws-native:appsync:ApiEventLogLevel":{"description":"Logging level for the AppSync API.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Error","value":"ERROR"},{"name":"All","value":"ALL"},{"name":"Info","value":"INFO"},{"name":"Debug","value":"DEBUG"}]},"aws-native:appsync:ApiLambdaAuthorizerConfig":{"description":"A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.","properties":{"authorizerResultTtlInSeconds":{"type":"integer"},"authorizerUri":{"type":"string"},"identityValidationExpression":{"type":"string"}},"type":"object","required":["authorizerUri"]},"aws-native:appsync:ApiOpenIdConnectConfig":{"description":"The OpenID Connect configuration.","properties":{"authTtl":{"type":"number"},"clientId":{"type":"string"},"iatTtl":{"type":"number"},"issuer":{"type":"string"}},"type":"object","required":["issuer"]},"aws-native:appsync:ApiTag":{"description":"An arbitrary set of tags (key-value pairs) for this AppSync API.","properties":{"key":{"type":"string","description":"A string used to identify this tag. You can specify a maximum of 128 characters for a tag key."},"value":{"type":"string","description":"A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value."}},"type":"object","required":["key","value"]},"aws-native:appsync:ChannelNamespaceAuthMode":{"description":"An auth mode.","properties":{"authType":{"$ref":"#/types/aws-native:appsync:ChannelNamespaceAuthenticationType"}},"type":"object"},"aws-native:appsync:ChannelNamespaceAuthenticationType":{"description":"Security configuration for your AppSync API.","type":"string","enum":[{"name":"AmazonCognitoUserPools","value":"AMAZON_COGNITO_USER_POOLS"},{"name":"AwsIam","value":"AWS_IAM"},{"name":"ApiKey","value":"API_KEY"},{"name":"OpenidConnect","value":"OPENID_CONNECT"},{"name":"AwsLambda","value":"AWS_LAMBDA"}]},"aws-native:appsync:ChannelNamespaceHandlerBehavior":{"description":"Integration behavior for a handler configuration.","type":"string","enum":[{"name":"Code","value":"CODE"},{"name":"Direct","value":"DIRECT"}]},"aws-native:appsync:ChannelNamespaceHandlerConfig":{"properties":{"behavior":{"$ref":"#/types/aws-native:appsync:ChannelNamespaceHandlerBehavior","description":"The behavior for the handler."},"integration":{"$ref":"#/types/aws-native:appsync:ChannelNamespaceIntegration","description":"The integration data source configuration for the handler."}},"type":"object","required":["behavior","integration"]},"aws-native:appsync:ChannelNamespaceHandlerConfigs":{"properties":{"onPublish":{"$ref":"#/types/aws-native:appsync:ChannelNamespaceHandlerConfig","description":"The configuration for the `OnPublish` handler."},"onSubscribe":{"$ref":"#/types/aws-native:appsync:ChannelNamespaceHandlerConfig","description":"The configuration for the `OnSubscribe` handler."}},"type":"object"},"aws-native:appsync:ChannelNamespaceIntegration":{"properties":{"dataSourceName":{"type":"string","description":"Data source to invoke for this integration."},"lambdaConfig":{"$ref":"#/types/aws-native:appsync:ChannelNamespaceLambdaConfig","description":"The configuration for a Lambda data source."}},"type":"object","required":["dataSourceName"]},"aws-native:appsync:ChannelNamespaceInvokeType":{"description":"Invocation type for direct lambda integrations.","type":"string","enum":[{"name":"RequestResponse","value":"REQUEST_RESPONSE"},{"name":"Event","value":"EVENT"}]},"aws-native:appsync:ChannelNamespaceLambdaConfig":{"properties":{"invokeType":{"$ref":"#/types/aws-native:appsync:ChannelNamespaceInvokeType","description":"The invocation type for a Lambda data source."}},"type":"object","required":["invokeType"]},"aws-native:appsync:ChannelNamespaceTag":{"description":"An arbitrary set of tags (key-value pairs) for this AppSync API.","properties":{"key":{"type":"string","description":"A string used to identify this tag. You can specify a maximum of 128 characters for a tag key."},"value":{"type":"string","description":"A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value."}},"type":"object","required":["key","value"]},"aws-native:appsync:DataSourceAuthorizationConfig":{"properties":{"authorizationType":{"type":"string","description":"The authorization type that the HTTP endpoint requires."},"awsIamConfig":{"$ref":"#/types/aws-native:appsync:DataSourceAwsIamConfig","description":"The AWS Identity and Access Management settings."}},"type":"object","required":["authorizationType"]},"aws-native:appsync:DataSourceAwsIamConfig":{"properties":{"signingRegion":{"type":"string","description":"The signing Region for AWS Identity and Access Management authorization."},"signingServiceName":{"type":"string","description":"The signing service name for AWS Identity and Access Management authorization."}},"type":"object"},"aws-native:appsync:DataSourceDeltaSyncConfig":{"properties":{"baseTableTtl":{"type":"string","description":"The number of minutes that an Item is stored in the data source."},"deltaSyncTableName":{"type":"string","description":"The Delta Sync table name."},"deltaSyncTableTtl":{"type":"string","description":"The number of minutes that a Delta Sync log entry is stored in the Delta Sync table."}},"type":"object","required":["baseTableTtl","deltaSyncTableName","deltaSyncTableTtl"]},"aws-native:appsync:DataSourceDynamoDbConfig":{"properties":{"awsRegion":{"type":"string","description":"The AWS Region."},"deltaSyncConfig":{"$ref":"#/types/aws-native:appsync:DataSourceDeltaSyncConfig","description":"The DeltaSyncConfig for a versioned datasource."},"tableName":{"type":"string","description":"The table name."},"useCallerCredentials":{"type":"boolean","description":"Set to TRUE to use AWS Identity and Access Management with this data source."},"versioned":{"type":"boolean","description":"Set to TRUE to use Conflict Detection and Resolution with this data source."}},"type":"object","required":["awsRegion","tableName"]},"aws-native:appsync:DataSourceElasticsearchConfig":{"properties":{"awsRegion":{"type":"string","description":"The AWS Region."},"endpoint":{"type":"string","description":"The endpoint."}},"type":"object","required":["awsRegion","endpoint"]},"aws-native:appsync:DataSourceEventBridgeConfig":{"properties":{"eventBusArn":{"type":"string","description":"ARN for the EventBridge bus."}},"type":"object","required":["eventBusArn"]},"aws-native:appsync:DataSourceHttpConfig":{"properties":{"authorizationConfig":{"$ref":"#/types/aws-native:appsync:DataSourceAuthorizationConfig","description":"The authorization configuration."},"endpoint":{"type":"string","description":"The endpoint."}},"type":"object","required":["endpoint"]},"aws-native:appsync:DataSourceLambdaConfig":{"properties":{"lambdaFunctionArn":{"type":"string","description":"The ARN for the Lambda function."}},"type":"object","required":["lambdaFunctionArn"]},"aws-native:appsync:DataSourceMetricsConfig":{"description":"Enables or disables enhanced data source metrics for specified data sources. Note that `MetricsConfig` won't be used unless the `dataSourceLevelMetricsBehavior` value is set to `PER_DATA_SOURCE_METRICS` . If the `dataSourceLevelMetricsBehavior` is set to `FULL_REQUEST_DATA_SOURCE_METRICS` instead, `MetricsConfig` will be ignored. However, you can still set its value.\n\n`MetricsConfig` can be `ENABLED` or `DISABLED` .","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:appsync:DataSourceOpenSearchServiceConfig":{"properties":{"awsRegion":{"type":"string","description":"The AWS Region."},"endpoint":{"type":"string","description":"The endpoint."}},"type":"object","required":["awsRegion","endpoint"]},"aws-native:appsync:DataSourceRdsHttpEndpointConfig":{"properties":{"awsRegion":{"type":"string","description":"AWS Region for RDS HTTP endpoint."},"awsSecretStoreArn":{"type":"string","description":"The ARN for database credentials stored in AWS Secrets Manager."},"databaseName":{"type":"string","description":"Logical database name."},"dbClusterIdentifier":{"type":"string","description":"Amazon RDS cluster Amazon Resource Name (ARN)."},"schema":{"type":"string","description":"Logical schema name."}},"type":"object","required":["awsRegion","awsSecretStoreArn","dbClusterIdentifier"]},"aws-native:appsync:DataSourceRelationalDatabaseConfig":{"properties":{"rdsHttpEndpointConfig":{"$ref":"#/types/aws-native:appsync:DataSourceRdsHttpEndpointConfig","description":"Information about the Amazon RDS resource."},"relationalDatabaseSourceType":{"type":"string","description":"The type of relational data source."}},"type":"object","required":["relationalDatabaseSourceType"]},"aws-native:appsync:DomainNameTag":{"description":"An arbitrary set of tags (key-value pairs) for this Domain Name.","properties":{"key":{"type":"string","description":"A string used to identify this tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value."}},"type":"object","required":["key","value"]},"aws-native:appsync:FunctionConfigurationAppSyncRuntime":{"description":"Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.","properties":{"name":{"type":"string","description":"The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS."},"runtimeVersion":{"type":"string","description":"The version of the runtime to use. Currently, the only allowed version is 1.0.0."}},"type":"object","required":["name","runtimeVersion"]},"aws-native:appsync:FunctionConfigurationLambdaConflictHandlerConfig":{"description":"The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.","properties":{"lambdaConflictHandlerArn":{"type":"string","description":"The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler."}},"type":"object"},"aws-native:appsync:FunctionConfigurationSyncConfig":{"description":"Describes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.","properties":{"conflictDetection":{"type":"string","description":"The Conflict Detection strategy to use."},"conflictHandler":{"type":"string","description":"The Conflict Resolution strategy to perform in the event of a conflict."},"lambdaConflictHandlerConfig":{"$ref":"#/types/aws-native:appsync:FunctionConfigurationLambdaConflictHandlerConfig","description":"The `LambdaConflictHandlerConfig` when configuring `LAMBDA` as the Conflict Handler."}},"type":"object","required":["conflictDetection"]},"aws-native:appsync:GraphQlApiAdditionalAuthenticationProvider":{"properties":{"authenticationType":{"type":"string","description":"The authentication type for API key, AWS Identity and Access Management, OIDC, Amazon Cognito user pools, or AWS Lambda."},"lambdaAuthorizerConfig":{"$ref":"#/types/aws-native:appsync:GraphQlApiLambdaAuthorizerConfig","description":"Configuration for AWS Lambda function authorization."},"openIdConnectConfig":{"$ref":"#/types/aws-native:appsync:GraphQlApiOpenIdConnectConfig","description":"The OIDC configuration."},"userPoolConfig":{"$ref":"#/types/aws-native:appsync:GraphQlApiCognitoUserPoolConfig","description":"The Amazon Cognito user pool configuration."}},"type":"object","required":["authenticationType"]},"aws-native:appsync:GraphQlApiCognitoUserPoolConfig":{"properties":{"appIdClientRegex":{"type":"string","description":"A regular expression for validating the incoming Amazon Cognito user pool app client ID. "},"awsRegion":{"type":"string","description":"The AWS Region in which the user pool was created."},"userPoolId":{"type":"string","description":"The user pool ID"}},"type":"object"},"aws-native:appsync:GraphQlApiEnhancedMetricsConfig":{"properties":{"dataSourceLevelMetricsBehavior":{"type":"string","description":"Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:\n\n"},"operationLevelMetricsConfig":{"type":"string","description":"Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:\n\n"},"resolverLevelMetricsBehavior":{"type":"string","description":"Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:\n\n"}},"type":"object","required":["dataSourceLevelMetricsBehavior","operationLevelMetricsConfig","resolverLevelMetricsBehavior"]},"aws-native:appsync:GraphQlApiLambdaAuthorizerConfig":{"properties":{"authorizerResultTtlInSeconds":{"type":"integer","description":"The number of seconds a response should be cached for."},"authorizerUri":{"type":"string","description":"The ARN of the Lambda function to be called for authorization."},"identityValidationExpression":{"type":"string","description":"A regular expression for validation of tokens before the Lambda function is called."}},"type":"object"},"aws-native:appsync:GraphQlApiLogConfig":{"properties":{"cloudWatchLogsRoleArn":{"type":"string","description":"The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account."},"excludeVerboseContent":{"type":"boolean","description":"Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level."},"fieldLogLevel":{"type":"string","description":"The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL."}},"type":"object"},"aws-native:appsync:GraphQlApiOpenIdConnectConfig":{"properties":{"authTtl":{"type":"number","description":"The number of milliseconds that a token is valid after being authenticated."},"clientId":{"type":"string","description":"The client identifier of the Relying party at the OpenID identity provider."},"iatTtl":{"type":"number","description":"The number of milliseconds that a token is valid after it's issued to a user.\n\n"},"issuer":{"type":"string","description":"The issuer for the OIDC configuration. "}},"type":"object"},"aws-native:appsync:GraphQlApiTag":{"properties":{"key":{"type":"string","description":"Describes the key of the tag."},"value":{"type":"string","description":"Describes the value of the tag."}},"type":"object","required":["key","value"]},"aws-native:appsync:GraphQlApiUserPoolConfig":{"properties":{"appIdClientRegex":{"type":"string","description":"A regular expression for validating the incoming Amazon Cognito user pool app client ID."},"awsRegion":{"type":"string","description":"The AWS Region in which the user pool was created."},"defaultAction":{"type":"string","description":"The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration."},"userPoolId":{"type":"string","description":"The user pool ID."}},"type":"object"},"aws-native:appsync:ResolverAppSyncRuntime":{"description":"Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.","properties":{"name":{"type":"string","description":"The ``name`` of the runtime to use. Currently, the only allowed value is ``APPSYNC_JS``."},"runtimeVersion":{"type":"string","description":"The ``version`` of the runtime to use. Currently, the only allowed version is ``1.0.0``."}},"type":"object","required":["name","runtimeVersion"]},"aws-native:appsync:ResolverCachingConfig":{"description":"The caching configuration for a resolver that has caching activated.","properties":{"cachingKeys":{"type":"array","items":{"type":"string"},"description":"The caching keys for a resolver that has caching activated.\n Valid values are entries from the ``$context.arguments``, ``$context.source``, and ``$context.identity`` maps."},"ttl":{"type":"number","description":"The TTL in seconds for a resolver that has caching activated.\n Valid values are 1–3,600 seconds."}},"type":"object","required":["ttl"]},"aws-native:appsync:ResolverLambdaConflictHandlerConfig":{"description":"The ``LambdaConflictHandlerConfig`` when configuring LAMBDA as the Conflict Handler.","properties":{"lambdaConflictHandlerArn":{"type":"string","description":"The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler."}},"type":"object"},"aws-native:appsync:ResolverMetricsConfig":{"description":"Enables or disables enhanced resolver metrics for specified resolvers. Note that ``MetricsConfig`` won't be used unless the ``resolverLevelMetricsBehavior`` value is set to ``PER_RESOLVER_METRICS``. If the ``resolverLevelMetricsBehavior`` is set to ``FULL_REQUEST_RESOLVER_METRICS`` instead, ``MetricsConfig`` will be ignored. However, you can still set its value.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:appsync:ResolverPipelineConfig":{"description":"Use the ``PipelineConfig`` property type to specify ``PipelineConfig`` for an APSYlong resolver.\n ``PipelineConfig`` is a property of the [AWS::AppSync::Resolver](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html) resource.","properties":{"functions":{"type":"array","items":{"type":"string"},"description":"A list of ``Function`` objects."}},"type":"object"},"aws-native:appsync:ResolverSyncConfig":{"description":"Describes a Sync configuration for a resolver.\n Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.","properties":{"conflictDetection":{"type":"string","description":"The Conflict Detection strategy to use.\n  +  *VERSION*: Detect conflicts based on object versions for this resolver.\n  +  *NONE*: Do not detect conflicts when invoking this resolver."},"conflictHandler":{"type":"string","description":"The Conflict Resolution strategy to perform in the event of a conflict.\n  +  *OPTIMISTIC_CONCURRENCY*: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.\n  +  *AUTOMERGE*: Resolve conflicts with the Automerge conflict resolution strategy.\n  +  *LAMBDA*: Resolve conflicts with an LAMlong function supplied in the ``LambdaConflictHandlerConfig``."},"lambdaConflictHandlerConfig":{"$ref":"#/types/aws-native:appsync:ResolverLambdaConflictHandlerConfig","description":"The ``LambdaConflictHandlerConfig`` when configuring ``LAMBDA`` as the Conflict Handler."}},"type":"object","required":["conflictDetection"]},"aws-native:appsync:SourceApiAssociationConfig":{"properties":{"mergeType":{"$ref":"#/types/aws-native:appsync:SourceApiAssociationConfigMergeType","description":"Configuration of the merged behavior for the association. For example when it could be auto or has to be manual."}},"type":"object"},"aws-native:appsync:SourceApiAssociationConfigMergeType":{"description":"Configuration of the merged behavior for the association. For example when it could be auto or has to be manual.","type":"string","enum":[{"name":"AutoMerge","value":"AUTO_MERGE"},{"name":"ManualMerge","value":"MANUAL_MERGE"}]},"aws-native:appsync:SourceApiAssociationStatus":{"description":"Current status of SourceApiAssociation.","type":"string","enum":[{"name":"MergeScheduled","value":"MERGE_SCHEDULED"},{"name":"MergeFailed","value":"MERGE_FAILED"},{"name":"MergeSuccess","value":"MERGE_SUCCESS"},{"name":"MergeInProgress","value":"MERGE_IN_PROGRESS"},{"name":"AutoMergeScheduleFailed","value":"AUTO_MERGE_SCHEDULE_FAILED"},{"name":"DeletionScheduled","value":"DELETION_SCHEDULED"},{"name":"DeletionInProgress","value":"DELETION_IN_PROGRESS"},{"name":"DeletionFailed","value":"DELETION_FAILED"}]},"aws-native:aps:AnomalyDetectorConfiguration":{"properties":{"randomCutForest":{"$ref":"#/types/aws-native:aps:AnomalyDetectorRandomCutForestConfiguration","description":"The Random Cut Forest algorithm configuration for anomaly detection."}},"type":"object","required":["randomCutForest"]},"aws-native:aps:AnomalyDetectorIgnoreNearExpected":{"properties":{"amount":{"type":"number"},"ratio":{"type":"number"}},"type":"object"},"aws-native:aps:AnomalyDetectorLabel":{"description":"A key-value pair to provide meta-data and multi-dimensional data analysis for filtering and aggregation.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:aps:AnomalyDetectorMissingDataAction":{"properties":{"markAsAnomaly":{"type":"boolean"},"skip":{"type":"boolean"}},"type":"object"},"aws-native:aps:AnomalyDetectorRandomCutForestConfiguration":{"properties":{"ignoreNearExpectedFromAbove":{"$ref":"#/types/aws-native:aps:AnomalyDetectorIgnoreNearExpected","description":"Configuration for ignoring values that are near expected values from above during anomaly detection."},"ignoreNearExpectedFromBelow":{"$ref":"#/types/aws-native:aps:AnomalyDetectorIgnoreNearExpected","description":"Configuration for ignoring values that are near expected values from below during anomaly detection."},"query":{"type":"string","description":"The Prometheus query used to retrieve the time-series data for anomaly detection.\n\n\u003e Random Cut Forest queries must be wrapped by a supported PromQL aggregation operator. For more information, see [Aggregation operators](https://docs.aws.amazon.com/https://prometheus.io/docs/prometheus/latest/querying/operators/#aggregation-operators) on the *Prometheus docs* website.\n\u003e \n\u003e *Supported PromQL aggregation operators* : `avg` , `count` , `group` , `max` , `min` , `quantile` , `stddev` , `stdvar` , and `sum` ."},"sampleSize":{"type":"integer","description":"The number of data points sampled from the input stream for the Random Cut Forest algorithm. The default number is 256 consecutive data points."},"shingleSize":{"type":"integer","description":"The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm. The default number is 8 consecutive data points."}},"type":"object","required":["query"]},"aws-native:aps:AnomalyDetectorTag":{"description":"A key-value pair to associate a tag level security for the resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:aps:RuleGroupsNamespaceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:aps:ScraperCloudWatchLogDestination":{"description":"Represents a cloudwatch logs destination for scraper logging","properties":{"logGroupArn":{"type":"string","description":"ARN of the CloudWatch log group"}},"type":"object"},"aws-native:aps:ScraperComponent":{"properties":{"config":{"$ref":"#/types/aws-native:aps:ScraperComponentConfig","description":"The configuration settings for the scraper component."},"type":{"$ref":"#/types/aws-native:aps:ScraperComponentType","description":"The type of the scraper component."}},"type":"object","required":["type"]},"aws-native:aps:ScraperComponentConfig":{"properties":{"options":{"type":"object","additionalProperties":{"type":"string"},"description":"Configuration options for the scraper component."}},"type":"object"},"aws-native:aps:ScraperComponentType":{"description":"Type of scraper component","type":"string","enum":[{"name":"ServiceDiscovery","value":"SERVICE_DISCOVERY"},{"name":"Collector","value":"COLLECTOR"},{"name":"Exporter","value":"EXPORTER"}]},"aws-native:aps:ScraperDestination":{"description":"Scraper metrics destination","properties":{"ampConfiguration":{"$ref":"#/types/aws-native:aps:ScraperDestinationAmpConfigurationProperties","description":"Configuration for Amazon Managed Prometheus metrics destination"}},"type":"object"},"aws-native:aps:ScraperDestinationAmpConfigurationProperties":{"description":"Configuration for Amazon Managed Prometheus metrics destination","properties":{"workspaceArn":{"type":"string","description":"ARN of an Amazon Managed Prometheus workspace"}},"type":"object","required":["workspaceArn"]},"aws-native:aps:ScraperLoggingConfiguration":{"description":"Configuration for scraper logging","properties":{"loggingDestination":{"$ref":"#/types/aws-native:aps:ScraperLoggingDestination"},"scraperComponents":{"type":"array","items":{"$ref":"#/types/aws-native:aps:ScraperComponent"}}},"type":"object","required":["loggingDestination","scraperComponents"]},"aws-native:aps:ScraperLoggingDestination":{"description":"Destination for scraper logging","properties":{"cloudWatchLogs":{"$ref":"#/types/aws-native:aps:ScraperCloudWatchLogDestination","description":"The CloudWatch Logs configuration for the scraper logging destination."}},"type":"object"},"aws-native:aps:ScraperRoleConfiguration":{"description":"Role configuration","properties":{"sourceRoleArn":{"type":"string","description":"IAM Role in source account"},"targetRoleArn":{"type":"string","description":"IAM Role in the target account"}},"type":"object"},"aws-native:aps:ScraperScrapeConfiguration":{"description":"Scraper configuration","properties":{"configurationBlob":{"type":"string","description":"Prometheus compatible scrape configuration in base64 encoded blob format"}},"type":"object"},"aws-native:aps:ScraperSource":{"description":"Scraper metrics source","properties":{"eksConfiguration":{"$ref":"#/types/aws-native:aps:ScraperSourceEksConfigurationProperties","description":"Configuration for EKS metrics source"},"vpcConfiguration":{"$ref":"#/types/aws-native:aps:ScraperSourceVpcConfigurationProperties","description":"Configuration for VPC metrics source"}},"type":"object"},"aws-native:aps:ScraperSourceEksConfigurationProperties":{"description":"Configuration for EKS metrics source","properties":{"clusterArn":{"type":"string","description":"ARN of an EKS cluster"},"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"List of security group IDs"},"subnetIds":{"type":"array","items":{"type":"string"},"description":"List of subnet IDs"}},"type":"object","required":["clusterArn","subnetIds"]},"aws-native:aps:ScraperSourceVpcConfigurationProperties":{"description":"Configuration for VPC metrics source","properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"List of security group IDs"},"subnetIds":{"type":"array","items":{"type":"string"},"description":"List of subnet IDs"}},"type":"object","required":["securityGroupIds","subnetIds"]},"aws-native:aps:ScraperTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:aps:WorkspaceCloudWatchLogDestination":{"description":"Represents a cloudwatch logs destination for query logging","properties":{"logGroupArn":{"type":"string","description":"The ARN of the CloudWatch Logs log group"}},"type":"object","required":["logGroupArn"]},"aws-native:aps:WorkspaceConfiguration":{"description":"Workspace configuration","properties":{"limitsPerLabelSets":{"type":"array","items":{"$ref":"#/types/aws-native:aps:WorkspaceLimitsPerLabelSet"},"description":"An array of label set and associated limits"},"retentionPeriodInDays":{"type":"integer","description":"How many days that metrics are retained in the workspace"}},"type":"object"},"aws-native:aps:WorkspaceLabel":{"description":"Series label","properties":{"name":{"type":"string","description":"Name of the label"},"value":{"type":"string","description":"Value of the label"}},"type":"object","required":["name","value"]},"aws-native:aps:WorkspaceLimitsPerLabelSet":{"description":"Label set and its associated limits","properties":{"labelSet":{"type":"array","items":{"$ref":"#/types/aws-native:aps:WorkspaceLabel"},"description":"An array of series labels"},"limits":{"$ref":"#/types/aws-native:aps:WorkspaceLimitsPerLabelSetEntry","description":"This structure contains the information about the limits that apply to time series that match this label set."}},"type":"object","required":["labelSet","limits"]},"aws-native:aps:WorkspaceLimitsPerLabelSetEntry":{"description":"Limits that can be applied to a label set","properties":{"maxSeries":{"type":"integer","description":"The maximum number of active series that can be ingested for this label set"}},"type":"object"},"aws-native:aps:WorkspaceLoggingConfiguration":{"description":"Logging configuration","properties":{"logGroupArn":{"type":"string","description":"CloudWatch log group ARN"}},"type":"object"},"aws-native:aps:WorkspaceLoggingDestination":{"description":"Destinations for query logging","properties":{"cloudWatchLogs":{"$ref":"#/types/aws-native:aps:WorkspaceCloudWatchLogDestination","description":"Configuration details for logging to CloudWatch Logs."},"filters":{"$ref":"#/types/aws-native:aps:WorkspaceLoggingFilter","description":"Filtering criteria that determine which queries are logged."}},"type":"object","required":["cloudWatchLogs","filters"]},"aws-native:aps:WorkspaceLoggingFilter":{"description":"Filters for logging","properties":{"qspThreshold":{"type":"integer","description":"Query logs with QSP above this limit are vended"}},"type":"object","required":["qspThreshold"]},"aws-native:aps:WorkspaceQueryLoggingConfiguration":{"description":"Query logging configuration","properties":{"destinations":{"type":"array","items":{"$ref":"#/types/aws-native:aps:WorkspaceLoggingDestination"},"description":"The destinations configuration for query logging"}},"type":"object","required":["destinations"]},"aws-native:aps:WorkspaceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:arcregionswitch:PlanAlarmCondition":{"type":"string","enum":[{"name":"Red","value":"red"},{"name":"Green","value":"green"}]},"aws-native:arcregionswitch:PlanAlarmType":{"type":"string","enum":[{"name":"ApplicationHealth","value":"applicationHealth"},{"name":"Trigger","value":"trigger"}]},"aws-native:arcregionswitch:PlanArcRoutingControlConfiguration":{"properties":{"crossAccountRole":{"type":"string"},"externalId":{"type":"string"},"regionAndRoutingControls":{"type":"object","additionalProperties":{"$ref":"pulumi.json#/Any"}},"timeoutMinutes":{"type":"number"}},"type":"object","required":["regionAndRoutingControls"]},"aws-native:arcregionswitch:PlanArcRoutingControlState":{"properties":{"routingControlArn":{"type":"string"},"state":{"$ref":"#/types/aws-native:arcregionswitch:PlanRoutingControlStateChange"}},"type":"object","required":["routingControlArn","state"]},"aws-native:arcregionswitch:PlanAsg":{"properties":{"arn":{"type":"string"},"crossAccountRole":{"type":"string"},"externalId":{"type":"string"}},"type":"object"},"aws-native:arcregionswitch:PlanAssociatedAlarm":{"properties":{"alarmType":{"$ref":"#/types/aws-native:arcregionswitch:PlanAlarmType","description":"The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm."},"crossAccountRole":{"type":"string","description":"The cross account role for the configuration."},"externalId":{"type":"string","description":"The external ID (secret key) for the configuration."},"resourceIdentifier":{"type":"string","description":"The resource identifier for alarms that you associate with a plan."}},"type":"object","required":["alarmType","resourceIdentifier"]},"aws-native:arcregionswitch:PlanCustomActionLambdaConfiguration":{"properties":{"lambdas":{"type":"array","items":{"$ref":"#/types/aws-native:arcregionswitch:PlanLambdas"}},"regionToRun":{"$ref":"#/types/aws-native:arcregionswitch:PlanRegionToRunIn"},"retryIntervalMinutes":{"type":"number"},"timeoutMinutes":{"type":"number"},"ungraceful":{"$ref":"#/types/aws-native:arcregionswitch:PlanLambdaUngraceful"}},"type":"object","required":["lambdas","regionToRun","retryIntervalMinutes"]},"aws-native:arcregionswitch:PlanDocumentDbConfiguration":{"properties":{"behavior":{"$ref":"pulumi.json#/Any"},"crossAccountRole":{"type":"string"},"databaseClusterArns":{"type":"array","items":{"type":"string"}},"externalId":{"type":"string"},"globalClusterIdentifier":{"type":"string"},"timeoutMinutes":{"type":"number"},"ungraceful":{"$ref":"#/types/aws-native:arcregionswitch:PlanDocumentDbUngraceful"}},"type":"object","required":["behavior","databaseClusterArns","globalClusterIdentifier"]},"aws-native:arcregionswitch:PlanDocumentDbUngraceful":{"properties":{"ungraceful":{"$ref":"#/types/aws-native:arcregionswitch:PlanDocumentDbUngracefulBehavior"}},"type":"object"},"aws-native:arcregionswitch:PlanDocumentDbUngracefulBehavior":{"type":"string","enum":[{"name":"Failover","value":"failover"}]},"aws-native:arcregionswitch:PlanEc2AsgCapacityIncreaseConfiguration":{"properties":{"asgs":{"type":"array","items":{"$ref":"#/types/aws-native:arcregionswitch:PlanAsg"}},"capacityMonitoringApproach":{"$ref":"pulumi.json#/Any"},"targetPercent":{"type":"number"},"timeoutMinutes":{"type":"number"},"ungraceful":{"$ref":"#/types/aws-native:arcregionswitch:PlanEc2Ungraceful"}},"type":"object","required":["asgs"]},"aws-native:arcregionswitch:PlanEc2Ungraceful":{"properties":{"minimumSuccessPercentage":{"type":"number"}},"type":"object","required":["minimumSuccessPercentage"]},"aws-native:arcregionswitch:PlanEcsCapacityIncreaseConfiguration":{"properties":{"capacityMonitoringApproach":{"$ref":"pulumi.json#/Any"},"services":{"type":"array","items":{"$ref":"#/types/aws-native:arcregionswitch:PlanService"}},"targetPercent":{"type":"number"},"timeoutMinutes":{"type":"number"},"ungraceful":{"$ref":"#/types/aws-native:arcregionswitch:PlanEcsUngraceful"}},"type":"object","required":["services"]},"aws-native:arcregionswitch:PlanEcsUngraceful":{"properties":{"minimumSuccessPercentage":{"type":"number"}},"type":"object","required":["minimumSuccessPercentage"]},"aws-native:arcregionswitch:PlanEksCluster":{"properties":{"clusterArn":{"type":"string"},"crossAccountRole":{"type":"string"},"externalId":{"type":"string"}},"type":"object","required":["clusterArn"]},"aws-native:arcregionswitch:PlanEksResourceScalingConfiguration":{"properties":{"capacityMonitoringApproach":{"$ref":"pulumi.json#/Any"},"eksClusters":{"type":"array","items":{"$ref":"#/types/aws-native:arcregionswitch:PlanEksCluster"}},"kubernetesResourceType":{"$ref":"#/types/aws-native:arcregionswitch:PlanKubernetesResourceType"},"scalingResources":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"pulumi.json#/Any"}}},"targetPercent":{"type":"number"},"timeoutMinutes":{"type":"number"},"ungraceful":{"$ref":"#/types/aws-native:arcregionswitch:PlanEksResourceScalingUngraceful"}},"type":"object","required":["kubernetesResourceType"]},"aws-native:arcregionswitch:PlanEksResourceScalingUngraceful":{"properties":{"minimumSuccessPercentage":{"type":"number"}},"type":"object","required":["minimumSuccessPercentage"]},"aws-native:arcregionswitch:PlanExecutionApprovalConfiguration":{"properties":{"approvalRole":{"type":"string"},"timeoutMinutes":{"type":"number"}},"type":"object","required":["approvalRole"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration0Properties":{"properties":{"customActionLambdaConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanCustomActionLambdaConfiguration"}},"type":"object","required":["customActionLambdaConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration10Properties":{"properties":{"documentDbConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanDocumentDbConfiguration"}},"type":"object","required":["documentDbConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration11Properties":{"properties":{"rdsPromoteReadReplicaConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanRdsPromoteReadReplicaConfiguration"}},"type":"object","required":["rdsPromoteReadReplicaConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration12Properties":{"properties":{"rdsCreateCrossRegionReadReplicaConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanRdsCreateCrossRegionReplicaConfiguration"}},"type":"object","required":["rdsCreateCrossRegionReadReplicaConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration1Properties":{"properties":{"ec2AsgCapacityIncreaseConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanEc2AsgCapacityIncreaseConfiguration"}},"type":"object","required":["ec2AsgCapacityIncreaseConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration2Properties":{"properties":{"executionApprovalConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionApprovalConfiguration"}},"type":"object","required":["executionApprovalConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration3Properties":{"properties":{"arcRoutingControlConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanArcRoutingControlConfiguration"}},"type":"object","required":["arcRoutingControlConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration4Properties":{"properties":{"globalAuroraConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanGlobalAuroraConfiguration"}},"type":"object","required":["globalAuroraConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration5Properties":{"properties":{"parallelConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanParallelExecutionBlockConfiguration"}},"type":"object","required":["parallelConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration6Properties":{"properties":{"regionSwitchPlanConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanRegionSwitchPlanConfiguration"}},"type":"object","required":["regionSwitchPlanConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration7Properties":{"properties":{"ecsCapacityIncreaseConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanEcsCapacityIncreaseConfiguration"}},"type":"object","required":["ecsCapacityIncreaseConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration8Properties":{"properties":{"eksResourceScalingConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanEksResourceScalingConfiguration"}},"type":"object","required":["eksResourceScalingConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockConfiguration9Properties":{"properties":{"route53HealthCheckConfig":{"$ref":"#/types/aws-native:arcregionswitch:PlanRoute53HealthCheckConfiguration"}},"type":"object","required":["route53HealthCheckConfig"]},"aws-native:arcregionswitch:PlanExecutionBlockType":{"type":"string","enum":[{"name":"CustomActionLambda","value":"CustomActionLambda"},{"name":"ManualApproval","value":"ManualApproval"},{"name":"AuroraGlobalDatabase","value":"AuroraGlobalDatabase"},{"name":"Ec2AutoScaling","value":"EC2AutoScaling"},{"name":"ArcRoutingControl","value":"ARCRoutingControl"},{"name":"ArcRegionSwitchPlan","value":"ARCRegionSwitchPlan"},{"name":"Parallel","value":"Parallel"},{"name":"EcsServiceScaling","value":"ECSServiceScaling"},{"name":"EksResourceScaling","value":"EKSResourceScaling"},{"name":"Route53HealthCheck","value":"Route53HealthCheck"},{"name":"DocumentDb","value":"DocumentDb"},{"name":"RdsPromoteReadReplica","value":"RdsPromoteReadReplica"},{"name":"RdsCreateCrossRegionReplica","value":"RdsCreateCrossRegionReplica"}]},"aws-native:arcregionswitch:PlanGlobalAuroraConfiguration":{"properties":{"behavior":{"$ref":"pulumi.json#/Any"},"crossAccountRole":{"type":"string"},"databaseClusterArns":{"type":"array","items":{"type":"string"}},"externalId":{"type":"string"},"globalClusterIdentifier":{"type":"string"},"timeoutMinutes":{"type":"number"},"ungraceful":{"$ref":"#/types/aws-native:arcregionswitch:PlanGlobalAuroraUngraceful"}},"type":"object","required":["behavior","databaseClusterArns","globalClusterIdentifier"]},"aws-native:arcregionswitch:PlanGlobalAuroraUngraceful":{"properties":{"ungraceful":{"$ref":"#/types/aws-native:arcregionswitch:PlanGlobalAuroraUngracefulBehavior"}},"type":"object"},"aws-native:arcregionswitch:PlanGlobalAuroraUngracefulBehavior":{"type":"string","enum":[{"name":"Failover","value":"failover"}]},"aws-native:arcregionswitch:PlanHealthCheckState":{"properties":{"healthCheckId":{"type":"string"},"region":{"type":"string"}},"type":"object"},"aws-native:arcregionswitch:PlanKubernetesResourceType":{"properties":{"apiVersion":{"type":"string"},"kind":{"type":"string"}},"type":"object","required":["apiVersion","kind"]},"aws-native:arcregionswitch:PlanKubernetesScalingResource":{"properties":{"hpaName":{"type":"string"},"name":{"type":"string"},"namespace":{"type":"string"}},"type":"object","required":["name","namespace"]},"aws-native:arcregionswitch:PlanLambdaUngraceful":{"properties":{"behavior":{"$ref":"pulumi.json#/Any"}},"type":"object"},"aws-native:arcregionswitch:PlanLambdas":{"properties":{"arn":{"type":"string"},"crossAccountRole":{"type":"string"},"externalId":{"type":"string"}},"type":"object"},"aws-native:arcregionswitch:PlanParallelExecutionBlockConfiguration":{"properties":{"steps":{"type":"array","items":{"$ref":"#/types/aws-native:arcregionswitch:PlanStep"}}},"type":"object","required":["steps"]},"aws-native:arcregionswitch:PlanRdsCreateCrossRegionReplicaConfiguration":{"properties":{"crossAccountRole":{"type":"string"},"dbInstanceArnMap":{"type":"object","additionalProperties":{"type":"string"}},"externalId":{"type":"string"},"timeoutMinutes":{"type":"number"}},"type":"object","required":["dbInstanceArnMap"]},"aws-native:arcregionswitch:PlanRdsPromoteReadReplicaConfiguration":{"properties":{"crossAccountRole":{"type":"string"},"dbInstanceArnMap":{"type":"object","additionalProperties":{"type":"string"}},"externalId":{"type":"string"},"timeoutMinutes":{"type":"number"}},"type":"object","required":["dbInstanceArnMap"]},"aws-native:arcregionswitch:PlanRecoveryApproach":{"type":"string","enum":[{"name":"ActiveActive","value":"activeActive"},{"name":"ActivePassive","value":"activePassive"}]},"aws-native:arcregionswitch:PlanRegionSwitchPlanConfiguration":{"properties":{"arn":{"type":"string"},"crossAccountRole":{"type":"string"},"externalId":{"type":"string"}},"type":"object","required":["arn"]},"aws-native:arcregionswitch:PlanRegionToRunIn":{"type":"string","enum":[{"name":"ActivatingRegion","value":"activatingRegion"},{"name":"DeactivatingRegion","value":"deactivatingRegion"},{"name":"ActiveRegion","value":"activeRegion"},{"name":"InactiveRegion","value":"inactiveRegion"}]},"aws-native:arcregionswitch:PlanReportConfiguration":{"properties":{"reportOutput":{"type":"array","items":{"$ref":"#/types/aws-native:arcregionswitch:PlanReportOutputConfigurationProperties"},"description":"The output configuration for the report."}},"type":"object"},"aws-native:arcregionswitch:PlanReportOutputConfiguration0Properties":{"properties":{"s3Configuration":{"$ref":"#/types/aws-native:arcregionswitch:PlanS3ReportOutputConfiguration"}},"type":"object","required":["s3Configuration"]},"aws-native:arcregionswitch:PlanReportOutputConfigurationProperties":{"properties":{"s3Configuration":{"$ref":"#/types/aws-native:arcregionswitch:PlanS3ReportOutputConfiguration"}},"type":"object","required":["s3Configuration"]},"aws-native:arcregionswitch:PlanRoute53HealthCheckConfiguration":{"properties":{"crossAccountRole":{"type":"string"},"externalId":{"type":"string"},"hostedZoneId":{"type":"string"},"recordName":{"type":"string"},"recordSets":{"type":"array","items":{"$ref":"#/types/aws-native:arcregionswitch:PlanRoute53ResourceRecordSet"}},"timeoutMinutes":{"type":"number"}},"type":"object","required":["hostedZoneId","recordName"]},"aws-native:arcregionswitch:PlanRoute53ResourceRecordSet":{"properties":{"recordSetIdentifier":{"type":"string"},"region":{"type":"string"}},"type":"object"},"aws-native:arcregionswitch:PlanRoutingControlStateChange":{"type":"string","enum":[{"name":"On","value":"On"},{"name":"Off","value":"Off"}]},"aws-native:arcregionswitch:PlanS3ReportOutputConfiguration":{"properties":{"bucketOwner":{"type":"string"},"bucketPath":{"type":"string"}},"type":"object"},"aws-native:arcregionswitch:PlanService":{"properties":{"clusterArn":{"type":"string"},"crossAccountRole":{"type":"string"},"externalId":{"type":"string"},"serviceArn":{"type":"string"}},"type":"object"},"aws-native:arcregionswitch:PlanStep":{"properties":{"description":{"type":"string","description":"The description of a step in a workflow."},"executionBlockConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration0Properties"},{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration1Properties"},{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration2Properties"},{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration3Properties"},{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration4Properties"},{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration5Properties"},{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration6Properties"},{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration7Properties"},{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration8Properties"},{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration9Properties"},{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration10Properties"},{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration11Properties"},{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockConfiguration12Properties"}],"description":"The configuration for an execution block in a workflow."},"executionBlockType":{"$ref":"#/types/aws-native:arcregionswitch:PlanExecutionBlockType","description":"The type of an execution block in a workflow."},"name":{"type":"string","description":"The name of a step in a workflow."}},"type":"object","required":["executionBlockConfiguration","executionBlockType","name"]},"aws-native:arcregionswitch:PlanTrigger":{"properties":{"action":{"$ref":"#/types/aws-native:arcregionswitch:PlanWorkflowTargetAction","description":"The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE."},"conditions":{"type":"array","items":{"$ref":"#/types/aws-native:arcregionswitch:PlanTriggerCondition"},"description":"The conditions that must be met for the trigger to fire."},"description":{"type":"string","description":"The description for a trigger."},"minDelayMinutesBetweenExecutions":{"type":"number","description":"The minimum time, in minutes, that must elapse between automatic executions of the plan."},"targetRegion":{"type":"string","description":"The AWS Region for a trigger."}},"type":"object","required":["action","conditions","minDelayMinutesBetweenExecutions","targetRegion"]},"aws-native:arcregionswitch:PlanTriggerCondition":{"properties":{"associatedAlarmName":{"type":"string","description":"The name of the CloudWatch alarm associated with the condition."},"condition":{"$ref":"#/types/aws-native:arcregionswitch:PlanAlarmCondition","description":"The condition that must be met. Valid values include ALARM and OK."}},"type":"object","required":["associatedAlarmName","condition"]},"aws-native:arcregionswitch:PlanWorkflow":{"properties":{"steps":{"type":"array","items":{"$ref":"#/types/aws-native:arcregionswitch:PlanStep"},"description":"The steps that make up the workflow."},"workflowDescription":{"type":"string","description":"The description of the workflow."},"workflowTargetAction":{"$ref":"#/types/aws-native:arcregionswitch:PlanWorkflowTargetAction","description":"The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE."},"workflowTargetRegion":{"type":"string","description":"The AWS Region that the workflow targets."}},"type":"object","required":["workflowTargetAction"]},"aws-native:arcregionswitch:PlanWorkflowTargetAction":{"type":"string","enum":[{"name":"Activate","value":"activate"},{"name":"Deactivate","value":"deactivate"},{"name":"PostRecovery","value":"postRecovery"}]},"aws-native:arcregionswitch:Route53HealthChecksProperties":{"properties":{"healthCheckIds":{"type":"array","items":{"type":"string"}},"hostedZoneIds":{"type":"array","items":{"type":"string"}},"recordNames":{"type":"array","items":{"type":"string"}},"regions":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:arczonalshift:AutoshiftObserverNotificationStatusEnum":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"}]},"aws-native:arczonalshift:ZonalAutoshiftConfigurationControlCondition":{"properties":{"alarmIdentifier":{"type":"string","description":"The Amazon Resource Name (ARN) for an Amazon CloudWatch alarm that you specify as a control condition for a practice run."},"type":{"type":"string","description":"The type of alarm specified for a practice run. You can only specify Amazon CloudWatch alarms for practice runs, so the only valid value is `CLOUDWATCH` ."}},"type":"object","required":["alarmIdentifier","type"]},"aws-native:arczonalshift:ZonalAutoshiftConfigurationPracticeRunConfiguration":{"properties":{"blockedDates":{"type":"array","items":{"type":"string"},"description":"An array of one or more dates that you can specify when AWS does not start practice runs for a resource. Dates are in UTC.\n\nSpecify blocked dates in the format `YYYY-MM-DD` , separated by spaces."},"blockedWindows":{"type":"array","items":{"type":"string"},"description":"An array of one or more days and times that you can specify when ARC does not start practice runs for a resource. Days and times are in UTC.\n\nSpecify blocked windows in the format `DAY:HH:MM-DAY:HH:MM` , separated by spaces. For example, `MON:18:30-MON:19:30 TUE:18:30-TUE:19:30` .\n\n\u003e Blocked windows have to start and end on the same day. Windows that span multiple days aren't supported."},"blockingAlarms":{"type":"array","items":{"$ref":"#/types/aws-native:arczonalshift:ZonalAutoshiftConfigurationControlCondition"},"description":"An optional alarm that you can specify that blocks practice runs when the alarm is in an `ALARM` state. When a blocking alarm goes into an `ALARM` state, it prevents practice runs from being started, and ends practice runs that are in progress."},"outcomeAlarms":{"type":"array","items":{"$ref":"#/types/aws-native:arczonalshift:ZonalAutoshiftConfigurationControlCondition"},"description":"The alarm that you specify to monitor the health of your application during practice runs. When the outcome alarm goes into an `ALARM` state, the practice run is ended and the outcome is set to `FAILED` ."}},"type":"object","required":["outcomeAlarms"]},"aws-native:arczonalshift:ZonalAutoshiftConfigurationZonalAutoshiftStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"}]},"aws-native:athena:CapacityReservationCapacityAssignment":{"properties":{"workgroupNames":{"type":"array","items":{"type":"string"}}},"type":"object","required":["workgroupNames"]},"aws-native:athena:CapacityReservationCapacityAssignmentConfiguration":{"description":"Assignment configuration to assign workgroups to a reservation","properties":{"capacityAssignments":{"type":"array","items":{"$ref":"#/types/aws-native:athena:CapacityReservationCapacityAssignment"},"description":"The list of assignments that make up the capacity assignment configuration."}},"type":"object","required":["capacityAssignments"]},"aws-native:athena:CapacityReservationStatus":{"type":"string","enum":[{"name":"Pending","value":"PENDING"},{"name":"Active","value":"ACTIVE"},{"name":"Cancelling","value":"CANCELLING"},{"name":"Cancelled","value":"CANCELLED"},{"name":"Failed","value":"FAILED"},{"name":"UpdatePending","value":"UPDATE_PENDING"}]},"aws-native:athena:CapacityReservationTag":{"properties":{"key":{"type":"string","description":"A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource."},"value":{"type":"string","description":"A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive."}},"type":"object","required":["key","value"]},"aws-native:athena:DataCatalogStatus":{"description":"The status of the creation or deletion of the data catalog. LAMBDA, GLUE, and HIVE data catalog types are created synchronously. Their status is either CREATE_COMPLETE or CREATE_FAILED. The FEDERATED data catalog type is created asynchronously.","type":"string","enum":[{"name":"CreateInProgress","value":"CREATE_IN_PROGRESS"},{"name":"CreateComplete","value":"CREATE_COMPLETE"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"CreateFailedCleanupInProgress","value":"CREATE_FAILED_CLEANUP_IN_PROGRESS"},{"name":"CreateFailedCleanupComplete","value":"CREATE_FAILED_CLEANUP_COMPLETE"},{"name":"CreateFailedCleanupFailed","value":"CREATE_FAILED_CLEANUP_FAILED"},{"name":"DeleteInProgress","value":"DELETE_IN_PROGRESS"},{"name":"DeleteComplete","value":"DELETE_COMPLETE"},{"name":"DeleteFailed","value":"DELETE_FAILED"}]},"aws-native:athena:DataCatalogTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:athena:DataCatalogType":{"description":"The type of data catalog to create: LAMBDA for a federated catalog, GLUE for AWS Glue Catalog, or HIVE for an external hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.","type":"string","enum":[{"name":"Lambda","value":"LAMBDA"},{"name":"Glue","value":"GLUE"},{"name":"Hive","value":"HIVE"},{"name":"Federated","value":"FEDERATED"}]},"aws-native:athena:WorkGroupAclConfiguration":{"description":"Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results","properties":{"s3AclOption":{"$ref":"#/types/aws-native:athena:WorkGroupS3AclOption","description":"The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is `BUCKET_OWNER_FULL_CONTROL` . If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) in the *Amazon S3 User Guide* ."}},"type":"object","required":["s3AclOption"]},"aws-native:athena:WorkGroupClassification":{"description":"A classification refers to a set of specific configurations.","properties":{"name":{"type":"string","description":"The name of the configuration classification."},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"A set of properties specified within a configuration classification."}},"type":"object"},"aws-native:athena:WorkGroupCloudWatchLoggingConfiguration":{"description":"Configuration settings for delivering logs to Amazon CloudWatch log groups.","properties":{"enabled":{"type":"boolean","description":"Enables CloudWatch logging."},"logGroup":{"type":"string","description":"The name of the log group in Amazon CloudWatch Logs where you want to publish your logs."},"logStreamNamePrefix":{"type":"string","description":"Prefix for the CloudWatch log stream name."},"logTypes":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"The types of logs that you want to publish to CloudWatch."}},"type":"object"},"aws-native:athena:WorkGroupConfiguration":{"properties":{"additionalConfiguration":{"type":"string","description":"Specifies a user defined JSON string that is passed to the session engine."},"bytesScannedCutoffPerQuery":{"type":"integer","description":"The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.\n\n\u003e This property currently supports integer types. Support for long values is planned."},"customerContentEncryptionConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupCustomerContentEncryptionConfiguration","description":"Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups."},"enforceWorkGroupConfiguration":{"type":"boolean","description":"If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\", client-side settings are used. For more information, see [Override client-side settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) ."},"engineConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupEngineConfiguration"},"engineVersion":{"$ref":"#/types/aws-native:athena:WorkGroupEngineVersion","description":"The engine version that all queries running on the workgroup use."},"executionRole":{"type":"string","description":"Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena."},"managedQueryResultsConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupManagedQueryResultsConfiguration","description":"The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results."},"monitoringConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupMonitoringConfiguration","description":"Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc."},"publishCloudWatchMetricsEnabled":{"type":"boolean","description":"Indicates that the Amazon CloudWatch metrics are enabled for the workgroup."},"requesterPaysEnabled":{"type":"boolean","description":"If set to `true` , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to `false` , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is `false` . For more information about Requester Pays buckets, see [Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in the *Amazon Simple Storage Service Developer Guide* ."},"resultConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupResultConfiguration","description":"Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see [Work with query results and recent queries](https://docs.aws.amazon.com/athena/latest/ug/querying.html) ."}},"type":"object"},"aws-native:athena:WorkGroupConfigurationUpdates":{"description":"The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified. ","properties":{"additionalConfiguration":{"type":"string"},"bytesScannedCutoffPerQuery":{"type":"integer"},"customerContentEncryptionConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupCustomerContentEncryptionConfiguration"},"enforceWorkGroupConfiguration":{"type":"boolean"},"engineConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupEngineConfiguration"},"engineVersion":{"$ref":"#/types/aws-native:athena:WorkGroupEngineVersion"},"executionRole":{"type":"string"},"managedQueryResultsConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupManagedQueryResultsConfiguration"},"monitoringConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupMonitoringConfiguration"},"publishCloudWatchMetricsEnabled":{"type":"boolean"},"removeBytesScannedCutoffPerQuery":{"type":"boolean"},"removeCustomerContentEncryptionConfiguration":{"type":"boolean"},"requesterPaysEnabled":{"type":"boolean"},"resultConfigurationUpdates":{"$ref":"#/types/aws-native:athena:WorkGroupResultConfigurationUpdates"}},"type":"object"},"aws-native:athena:WorkGroupCustomerContentEncryptionConfiguration":{"description":"Indicates the KMS key for encrypting notebook content.","properties":{"kmsKey":{"type":"string","description":"The customer managed KMS key that is used to encrypt the user's data stores in Athena."}},"type":"object","required":["kmsKey"]},"aws-native:athena:WorkGroupEncryptionConfiguration":{"description":"If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information.","properties":{"encryptionOption":{"$ref":"#/types/aws-native:athena:WorkGroupEncryptionOption","description":"Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys ( `SSE_S3` ), server-side encryption with KMS-managed keys ( `SSE_KMS` ), or client-side encryption with KMS-managed keys ( `CSE_KMS` ) is used.\n\nIf a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup."},"kmsKey":{"type":"string","description":"For `SSE_KMS` and `CSE_KMS` , this is the KMS key ARN or ID."}},"type":"object","required":["encryptionOption"]},"aws-native:athena:WorkGroupEncryptionOption":{"description":"Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used.","type":"string","enum":[{"name":"SseS3","value":"SSE_S3"},{"name":"SseKms","value":"SSE_KMS"},{"name":"CseKms","value":"CSE_KMS"}]},"aws-native:athena:WorkGroupEngineConfiguration":{"description":"The engine configuration for running queries.","properties":{"additionalConfigs":{"type":"object","additionalProperties":{"type":"string"},"description":"Contains additional notebook engine MAP\u003cstring, string\u003e parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID."},"classifications":{"type":"array","items":{"$ref":"#/types/aws-native:athena:WorkGroupClassification"},"description":"The configuration classifications that can be specified for the engine."},"coordinatorDpuSize":{"type":"integer","description":"The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1."},"defaultExecutorDpuSize":{"type":"integer","description":"The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1."},"maxConcurrentDpus":{"type":"integer","description":"The maximum number of DPUs that can run concurrently."},"sparkProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning."}},"type":"object"},"aws-native:athena:WorkGroupEngineVersion":{"description":"The Athena engine version for running queries.","properties":{"effectiveEngineVersion":{"type":"string","description":"Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a `CreateWorkGroup` or `UpdateWorkGroup` operation, the `EffectiveEngineVersion` field is ignored."},"selectedEngineVersion":{"type":"string","description":"The engine version requested by the user. Possible values are determined by the output of `ListEngineVersions` , including AUTO. The default is AUTO."}},"type":"object"},"aws-native:athena:WorkGroupManagedLoggingConfiguration":{"description":"Configuration settings for managed log persistence.","properties":{"enabled":{"type":"boolean","description":"Enables managed log persistence."},"kmsKey":{"type":"string","description":"The KMS key ARN to encrypt the logs stored in managed log persistence."}},"type":"object"},"aws-native:athena:WorkGroupManagedQueryResultsConfiguration":{"description":"The configuration for the managed query results and encryption option. ResultConfiguration and ManagedQueryResultsConfiguration cannot be set at the same time","properties":{"enabled":{"type":"boolean","description":"If set to true, allows you to store query results in Athena owned storage. If set to false, workgroup member stores query results in location specified under `ResultConfiguration$OutputLocation` . The default is false. A workgroup cannot have the `ResultConfiguration$OutputLocation` parameter when you set this field to true."},"encryptionConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupManagedStorageEncryptionConfiguration","description":"If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information."}},"type":"object"},"aws-native:athena:WorkGroupManagedStorageEncryptionConfiguration":{"description":"Indicates the encryption configuration for Athena Managed Storage. If not setting this field, Managed Storage will encrypt the query results with Athena's encryption key","properties":{"kmsKey":{"type":"string"}},"type":"object"},"aws-native:athena:WorkGroupMonitoringConfiguration":{"description":"Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.","properties":{"cloudWatchLoggingConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupCloudWatchLoggingConfiguration","description":"Configuration settings for delivering logs to Amazon CloudWatch log groups."},"managedLoggingConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupManagedLoggingConfiguration","description":"Configuration settings for managed log persistence."},"s3LoggingConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupS3LoggingConfiguration","description":"Configuration settings for delivering logs to Amazon S3 buckets."}},"type":"object"},"aws-native:athena:WorkGroupResultConfiguration":{"description":"The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the workgroup settings.\n","properties":{"aclConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupAclConfiguration","description":"Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is `BUCKET_OWNER_FULL_CONTROL` . This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See `EnforceWorkGroupConfiguration` ."},"encryptionConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupEncryptionConfiguration","description":"If query results are encrypted in Amazon S3, indicates the encryption option used (for example, `SSE_KMS` or `CSE_KMS` ) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See `EnforceWorkGroupConfiguration` and [Override client-side settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) ."},"expectedBucketOwner":{"type":"string","description":"The account ID that you expect to be the owner of the Amazon S3 bucket specified by `ResultConfiguration:OutputLocation` . If set, Athena uses the value for `ExpectedBucketOwner` when it makes Amazon S3 calls to your specified output location. If the `ExpectedBucketOwner` account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.\n\nThis is a client-side setting. If workgroup settings override client-side settings, then the query uses the `ExpectedBucketOwner` setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See `EnforceWorkGroupConfiguration` ."},"outputLocation":{"type":"string","description":"The location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/` . To run a query, you must specify the query results location using either a client-side setting for individual queries or a location specified by the workgroup. If workgroup settings override client-side settings, then the query uses the location specified for the workgroup. If no query location is set, Athena issues an error. For more information, see [Work with query results and recent queries](https://docs.aws.amazon.com/athena/latest/ug/querying.html) and `EnforceWorkGroupConfiguration` ."}},"type":"object"},"aws-native:athena:WorkGroupResultConfigurationUpdates":{"description":"The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results. ","properties":{"aclConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupAclConfiguration","description":"The ACL configuration for the query results."},"encryptionConfiguration":{"$ref":"#/types/aws-native:athena:WorkGroupEncryptionConfiguration","description":"The encryption configuration for the query results."},"expectedBucketOwner":{"type":"string","description":"The AWS account ID that you expect to be the owner of the Amazon S3 bucket specified by [](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-outputlocation) . If set, Athena uses the value for `ExpectedBucketOwner` when it makes Amazon S3 calls to your specified output location. If the `ExpectedBucketOwner` AWS account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.\n\nIf workgroup settings override client-side settings, then the query uses the `ExpectedBucketOwner` setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See [](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration) and [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) ."},"outputLocation":{"type":"string","description":"The location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/` . For more information, see [Query Results](https://docs.aws.amazon.com/athena/latest/ug/querying.html) If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See `EnforceWorkGroupConfiguration` ."},"removeAclConfiguration":{"type":"boolean","description":"If set to `true` , indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to `false` or not set, and a value is present in the `AclConfiguration` of `ResultConfigurationUpdates` , the `AclConfiguration` in the workgroup's `ResultConfiguration` is updated with the new value. For more information, see [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) ."},"removeEncryptionConfiguration":{"type":"boolean","description":"If set to \"true\", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see [Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) ."},"removeExpectedBucketOwner":{"type":"boolean","description":"If set to \"true\", removes the AWS account ID previously specified for [](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-expectedbucketowner) . If set to \"false\" or not set, and a value is present in the `ExpectedBucketOwner` in `ResultConfigurationUpdates` (the client-side setting), the `ExpectedBucketOwner` in the workgroup's `ResultConfiguration` is updated with the new value. For more information, see [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) ."},"removeOutputLocation":{"type":"boolean","description":"If set to \"true\", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see [Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html) ."}},"type":"object"},"aws-native:athena:WorkGroupS3AclOption":{"description":"The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL","type":"string","enum":[{"name":"BucketOwnerFullControl","value":"BUCKET_OWNER_FULL_CONTROL"}]},"aws-native:athena:WorkGroupS3LoggingConfiguration":{"description":"Configuration settings for delivering logs to Amazon S3 buckets.","properties":{"enabled":{"type":"boolean","description":"Enables S3 log delivery."},"kmsKey":{"type":"string","description":"The KMS key ARN to encrypt the logs published to the given Amazon S3 destination."},"logLocation":{"type":"string","description":"The Amazon S3 destination URI for log publishing."}},"type":"object"},"aws-native:athena:WorkGroupState":{"description":"The state of the workgroup: ENABLED or DISABLED.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:athena:WorkGroupTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:auditmanager:AssessmentAwsAccount":{"description":"The AWS account associated with the assessment.","properties":{"emailAddress":{"type":"string","description":"The email address that's associated with the AWS account ."},"id":{"type":"string","description":"The identifier for the AWS account ."},"name":{"type":"string","description":"The name of the AWS account ."}},"type":"object"},"aws-native:auditmanager:AssessmentAwsService":{"description":"An AWS service such as Amazon S3, AWS CloudTrail, and so on.","properties":{"serviceName":{"type":"string","description":"The name of the AWS service ."}},"type":"object"},"aws-native:auditmanager:AssessmentDelegation":{"description":"The assignment of a control set to a delegate for review.","properties":{"assessmentId":{"type":"string","description":"The identifier for the assessment that's associated with the delegation."},"assessmentName":{"type":"string","description":"The name of the assessment that's associated with the delegation."},"comment":{"type":"string","description":"The comment that's related to the delegation."},"controlSetId":{"type":"string","description":"The identifier for the control set that's associated with the delegation."},"createdBy":{"type":"string","description":"The user or role that created the delegation.\n\n*Minimum* : `1`\n\n*Maximum* : `100`\n\n*Pattern* : `^[a-zA-Z0-9-_()\\\\[\\\\]\\\\s]+$`"},"creationTime":{"type":"number","description":"Specifies when the delegation was created."},"id":{"type":"string","description":"The unique identifier for the delegation."},"lastUpdated":{"type":"number","description":"Specifies when the delegation was last updated."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role."},"roleType":{"$ref":"#/types/aws-native:auditmanager:AssessmentRoleType","description":"The type of customer persona.\n\n\u003e In `CreateAssessment` , `roleType` can only be `PROCESS_OWNER` .\n\u003e \n\u003e In `UpdateSettings` , `roleType` can only be `PROCESS_OWNER` .\n\u003e \n\u003e In `BatchCreateDelegationByAssessment` , `roleType` can only be `RESOURCE_OWNER` ."},"status":{"$ref":"#/types/aws-native:auditmanager:AssessmentDelegationStatus","description":"The status of the delegation."}},"type":"object"},"aws-native:auditmanager:AssessmentDelegationStatus":{"description":"The status of the delegation.","type":"string","enum":[{"name":"InProgress","value":"IN_PROGRESS"},{"name":"UnderReview","value":"UNDER_REVIEW"},{"name":"Complete","value":"COMPLETE"}]},"aws-native:auditmanager:AssessmentReportDestinationType":{"description":"The destination type, such as Amazon S3.","type":"string","enum":[{"name":"S3","value":"S3"}]},"aws-native:auditmanager:AssessmentReportsDestination":{"description":"The destination in which evidence reports are stored for the specified assessment.","properties":{"destination":{"type":"string","description":"The destination bucket where Audit Manager stores assessment reports."},"destinationType":{"$ref":"#/types/aws-native:auditmanager:AssessmentReportDestinationType","description":"The destination type, such as Amazon S3."}},"type":"object"},"aws-native:auditmanager:AssessmentRole":{"description":"The wrapper that contains AWS Audit Manager role information, such as the role type and IAM ARN.","properties":{"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role."},"roleType":{"$ref":"#/types/aws-native:auditmanager:AssessmentRoleType","description":"The type of customer persona.\n\n\u003e In `CreateAssessment` , `roleType` can only be `PROCESS_OWNER` .\n\u003e \n\u003e In `UpdateSettings` , `roleType` can only be `PROCESS_OWNER` .\n\u003e \n\u003e In `BatchCreateDelegationByAssessment` , `roleType` can only be `RESOURCE_OWNER` ."}},"type":"object"},"aws-native:auditmanager:AssessmentRoleType":{"description":" The IAM role type.","type":"string","enum":[{"name":"ProcessOwner","value":"PROCESS_OWNER"},{"name":"ResourceOwner","value":"RESOURCE_OWNER"}]},"aws-native:auditmanager:AssessmentScope":{"description":"The wrapper that contains the AWS accounts and AWS services in scope for the assessment.","properties":{"awsAccounts":{"type":"array","items":{"$ref":"#/types/aws-native:auditmanager:AssessmentAwsAccount"},"description":"The AWS accounts included in scope."},"awsServices":{"type":"array","items":{"$ref":"#/types/aws-native:auditmanager:AssessmentAwsService"},"description":"The AWS services included in scope."}},"type":"object"},"aws-native:auditmanager:AssessmentStatus":{"description":"The status of the specified assessment. ","type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Inactive","value":"INACTIVE"}]},"aws-native:auditmanager:AssessmentTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:autoscaling:AutoScalingGroupAcceleratorCountRequest":{"description":"``AcceleratorCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of accelerators for an instance type.","properties":{"max":{"type":"integer","description":"The maximum value."},"min":{"type":"integer","description":"The minimum value."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupAcceleratorTotalMemoryMiBRequest":{"description":"``AcceleratorTotalMemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB.","properties":{"max":{"type":"integer","description":"The memory maximum in MiB."},"min":{"type":"integer","description":"The memory minimum in MiB."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupAvailabilityZoneDistribution":{"description":"``AvailabilityZoneDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.","properties":{"capacityDistributionStrategy":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupAvailabilityZoneDistributionCapacityDistributionStrategy","description":"If launches fail in an Availability Zone, the following strategies are available. The default is ``balanced-best-effort``. \n  +  ``balanced-only`` - If launches fail in an Availability Zone, Auto Scaling will continue to attempt to launch in the unhealthy zone to preserve a balanced distribution.\n  +  ``balanced-best-effort`` - If launches fail in an Availability Zone, Auto Scaling will attempt to launch in another healthy Availability Zone instead."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupAvailabilityZoneDistributionCapacityDistributionStrategy":{"description":"If launches fail in an Availability Zone, the following strategies are available. The default is ``balanced-best-effort``. \n  +  ``balanced-only`` - If launches fail in an Availability Zone, Auto Scaling will continue to attempt to launch in the unhealthy zone to preserve a balanced distribution.\n  +  ``balanced-best-effort`` - If launches fail in an Availability Zone, Auto Scaling will attempt to launch in another healthy Availability Zone instead.","type":"string","enum":[{"name":"BalancedBestEffort","value":"balanced-best-effort"},{"name":"BalancedOnly","value":"balanced-only"}]},"aws-native:autoscaling:AutoScalingGroupAvailabilityZoneImpairmentPolicy":{"description":"Describes an Availability Zone impairment policy.","properties":{"impairedZoneHealthCheckBehavior":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupAvailabilityZoneImpairmentPolicyImpairedZoneHealthCheckBehavior","description":"Specifies the health check behavior for the impaired Availability Zone in an active zonal shift. If you select ``Replace unhealthy``, instances that appear unhealthy will be replaced in all Availability Zones. If you select ``Ignore unhealthy``, instances will not be replaced in the Availability Zone with the active zonal shift. For more information, see [Auto Scaling group zonal shift](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-zonal-shift.html) in the *Amazon EC2 Auto Scaling User Guide*."},"zonalShiftEnabled":{"type":"boolean","description":"If ``true``, enable zonal shift for your Auto Scaling group."}},"type":"object","required":["impairedZoneHealthCheckBehavior","zonalShiftEnabled"]},"aws-native:autoscaling:AutoScalingGroupAvailabilityZoneImpairmentPolicyImpairedZoneHealthCheckBehavior":{"description":"Specifies the health check behavior for the impaired Availability Zone in an active zonal shift. If you select ``Replace unhealthy``, instances that appear unhealthy will be replaced in all Availability Zones. If you select ``Ignore unhealthy``, instances will not be replaced in the Availability Zone with the active zonal shift. For more information, see [Auto Scaling group zonal shift](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-zonal-shift.html) in the *Amazon EC2 Auto Scaling User Guide*.","type":"string","enum":[{"name":"IgnoreUnhealthy","value":"IgnoreUnhealthy"},{"name":"ReplaceUnhealthy","value":"ReplaceUnhealthy"}]},"aws-native:autoscaling:AutoScalingGroupBaselineEbsBandwidthMbpsRequest":{"description":"``BaselineEbsBandwidthMbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps.","properties":{"max":{"type":"integer","description":"The maximum value in Mbps."},"min":{"type":"integer","description":"The minimum value in Mbps."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupBaselinePerformanceFactorsRequest":{"description":"The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Auto Scaling uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. \n Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` uses the CPU performance of the ``c6i`` family as the baseline reference.","properties":{"cpu":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupCpuPerformanceFactorRequest","description":"The CPU performance to consider, using an instance family as the baseline reference."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupCapacityReservationSpecification":{"description":"Describes the Capacity Reservation preference and targeting options. If you specify ``open`` or ``none`` for ``CapacityReservationPreference``, do not specify a ``CapacityReservationTarget``.","properties":{"capacityReservationPreference":{"type":"string","description":"The capacity reservation preference. The following options are available: \n  +  ``capacity-reservations-only`` - Auto Scaling will only launch instances into a Capacity Reservation or Capacity Reservation resource group. If capacity isn't available, instances will fail to launch.\n  +  ``capacity-reservations-first`` - Auto Scaling will try to launch instances into a Capacity Reservation or Capacity Reservation resource group first. If capacity isn't available, instances will run in On-Demand capacity.\n  +  ``none`` - Auto Scaling will not launch instances into a Capacity Reservation. Instances will run in On-Demand capacity. \n  +  ``default`` - Auto Scaling uses the Capacity Reservation preference from your launch template or an open Capacity Reservation."},"capacityReservationTarget":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupCapacityReservationTarget","description":"Describes a target Capacity Reservation or Capacity Reservation resource group."}},"type":"object","required":["capacityReservationPreference"]},"aws-native:autoscaling:AutoScalingGroupCapacityReservationTarget":{"description":"The target for the Capacity Reservation. Specify Capacity Reservations IDs or Capacity Reservation resource group ARNs.","properties":{"capacityReservationIds":{"type":"array","items":{"type":"string"},"description":"The Capacity Reservation IDs to launch instances into."},"capacityReservationResourceGroupArns":{"type":"array","items":{"type":"string"},"description":"The resource group ARNs of the Capacity Reservation to launch instances into."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupCpuPerformanceFactorRequest":{"description":"The CPU performance to consider, using an instance family as the baseline reference.","properties":{"references":{"type":"array","items":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupPerformanceFactorReferenceRequest"},"description":"Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. \n  Currently only one instance family can be specified in the list."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupInstanceLifecyclePolicy":{"description":"The instance lifecycle policy for the Auto Scaling group. This policy controls instance behavior when an instance transitions through its lifecycle states. Configure retention triggers to specify when instances should move to a ``Retained`` state instead of automatic termination. \n For more information, see [Control instance retention with instance lifecycle policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/instance-lifecycle-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.","properties":{"retentionTriggers":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupRetentionTriggers","description":"Specifies the conditions that trigger instance retention behavior. These triggers determine when instances should move to a ``Retained`` state instead of automatic termination. This allows you to maintain control over instance management when lifecycles transition and operations fail."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupInstanceMaintenancePolicy":{"description":"``InstanceMaintenancePolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\n For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.","properties":{"maxHealthyPercentage":{"type":"integer","description":"Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``.\n Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time."},"minHealthyPercentage":{"type":"integer","description":"Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupInstanceRequirements":{"description":"The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n  +  ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n  +  ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n  \n  You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n  For an example template, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).\n For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User Guide for Linux Instances*.\n ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.","properties":{"acceleratorCount":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupAcceleratorCountRequest","description":"The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.\n To exclude accelerator-enabled instance types, set ``Max`` to ``0``.\n Default: No minimum or maximum limits"},"acceleratorManufacturers":{"type":"array","items":{"type":"string"},"description":"Indicates whether instance types must have accelerators by specific manufacturers.\n  +  For instance types with NVIDIA devices, specify ``nvidia``.\n  +  For instance types with AMD devices, specify ``amd``.\n  +  For instance types with AWS devices, specify ``amazon-web-services``.\n  +  For instance types with Xilinx devices, specify ``xilinx``.\n  \n Default: Any manufacturer"},"acceleratorNames":{"type":"array","items":{"type":"string"},"description":"Lists the accelerators that must be on an instance type.\n  +  For instance types with NVIDIA A100 GPUs, specify ``a100``.\n  +  For instance types with NVIDIA V100 GPUs, specify ``v100``.\n  +  For instance types with NVIDIA K80 GPUs, specify ``k80``.\n  +  For instance types with NVIDIA T4 GPUs, specify ``t4``.\n  +  For instance types with NVIDIA M60 GPUs, specify ``m60``.\n  +  For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``.\n  +  For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.\n  \n Default: Any accelerator"},"acceleratorTotalMemoryMiB":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupAcceleratorTotalMemoryMiBRequest","description":"The minimum and maximum total memory size for the accelerators on an instance type, in MiB.\n Default: No minimum or maximum limits"},"acceleratorTypes":{"type":"array","items":{"type":"string"},"description":"Lists the accelerator types that must be on an instance type.\n  +  For instance types with GPU accelerators, specify ``gpu``.\n  +  For instance types with FPGA accelerators, specify ``fpga``.\n  +  For instance types with inference accelerators, specify ``inference``.\n  \n Default: Any accelerator type"},"allowedInstanceTypes":{"type":"array","items":{"type":"string"},"description":"The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.\n  If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.\n  Default: All instance types"},"bareMetal":{"type":"string","description":"Indicates whether bare metal instance types are included, excluded, or required.\n Default: ``excluded``"},"baselineEbsBandwidthMbps":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupBaselineEbsBandwidthMbpsRequest","description":"The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.\n Default: No minimum or maximum limits"},"baselinePerformanceFactors":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupBaselinePerformanceFactorsRequest","description":"The baseline performance factors for the instance requirements."},"burstablePerformance":{"type":"string","description":"Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide*.\n Default: ``excluded``"},"cpuManufacturers":{"type":"array","items":{"type":"string"},"description":"Lists which specific CPU manufacturers to include.\n  +  For instance types with Intel CPUs, specify ``intel``.\n  +  For instance types with AMD CPUs, specify ``amd``.\n  +  For instance types with AWS CPUs, specify ``amazon-web-services``.\n  +  For instance types with Apple CPUs, specify ``apple``.\n  \n  Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. \n  Default: Any manufacturer"},"excludedInstanceTypes":{"type":"array","items":{"type":"string"},"description":"The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. \n For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.\n  If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.\n  Default: No excluded instance types"},"instanceGenerations":{"type":"array","items":{"type":"string"},"description":"Indicates whether current or previous generation instance types are included.\n  +  For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.\n  +  For previous generation instance types, specify ``previous``.\n  \n Default: Any current or previous generation"},"localStorage":{"type":"string","description":"Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*.\n Default: ``included``"},"localStorageTypes":{"type":"array","items":{"type":"string"},"description":"Indicates the type of local storage that is required.\n  +  For instance types with hard disk drive (HDD) storage, specify ``hdd``.\n  +  For instance types with solid state drive (SSD) storage, specify ``ssd``.\n  \n Default: Any local storage type"},"maxSpotPriceAsPercentageOfOptimalOnDemandPrice":{"type":"integer","description":"[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. \n  Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``."},"memoryGiBPerVCpu":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupMemoryGiBPerVCpuRequest","description":"The minimum and maximum amount of memory per vCPU for an instance type, in GiB.\n Default: No minimum or maximum limits"},"memoryMiB":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupMemoryMiBRequest","description":"The minimum and maximum instance memory size for an instance type, in MiB."},"networkBandwidthGbps":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupNetworkBandwidthGbpsRequest","description":"The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Default: No minimum or maximum limits"},"networkInterfaceCount":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupNetworkInterfaceCountRequest","description":"The minimum and maximum number of network interfaces for an instance type.\n Default: No minimum or maximum limits"},"onDemandMaxPricePercentageOverLowestPrice":{"type":"integer","description":"[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. \n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.\n To turn off price protection, specify a high value, such as ``999999``. \n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. \n Default: ``20``"},"requireHibernateSupport":{"type":"boolean","description":"Indicates whether instance types must provide On-Demand Instance hibernation support.\n Default: ``false``"},"spotMaxPricePercentageOverLowestPrice":{"type":"integer","description":"[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. \n If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. \n  Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``."},"totalLocalStorageGb":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupTotalLocalStorageGbRequest","description":"The minimum and maximum total local storage size for an instance type, in GB.\n Default: No minimum or maximum limits"},"vCpuCount":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupVCpuCountRequest","description":"The minimum and maximum number of vCPUs for an instance type."}},"type":"object","required":["memoryMiB","vCpuCount"]},"aws-native:autoscaling:AutoScalingGroupInstancesDistribution":{"description":"Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy.\n For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.\n ``InstancesDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.","properties":{"onDemandAllocationStrategy":{"type":"string","description":"The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.\n The following lists the valid values:\n  + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do."},"onDemandBaseCapacity":{"type":"integer","description":"The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.\n This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.\n Default: 0\n  An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones."},"onDemandPercentageAboveBaseCapacity":{"type":"integer","description":"Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.\n Default: 100\n  An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones."},"spotAllocationStrategy":{"type":"string","description":"The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.\n The following lists the valid values:\n  + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price."},"spotInstancePools":{"type":"integer","description":"The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1–20.\n Default: 2"},"spotMaxPrice":{"type":"string","description":"The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string (\"\") for the value.\n  If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.\n  Valid Range: Minimum value of 0.001"}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupLaunchTemplate":{"description":"Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy.\n ``LaunchTemplate`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.","properties":{"launchTemplateSpecification":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupLaunchTemplateSpecification","description":"The launch template."},"overrides":{"type":"array","items":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupLaunchTemplateOverrides"},"description":"Any properties that you specify override the same properties in the launch template."}},"type":"object","required":["launchTemplateSpecification"]},"aws-native:autoscaling:AutoScalingGroupLaunchTemplateOverrides":{"description":"Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy:\n  +  Override the instance type that is specified in the launch template.\n  +  Use multiple instance types.\n  \n Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group.\n After you define your instance requirements, you don't have to keep updating these settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine whether a new EC2 instance type can be used.\n ``LaunchTemplateOverrides`` is a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.","properties":{"imageId":{"type":"string","description":"The ID of the Amazon Machine Image (AMI) to use for instances launched with this override. When using Instance Refresh with ``ReplaceRootVolume`` strategy, this specifies the AMI for root volume replacement operations. \n  For ``ReplaceRootVolume`` operations: \n  +  All overrides in the ``MixedInstancesPolicy`` must specify an ImageId\n  +  The AMI must contain only a single root volume\n  +  Root volume replacement doesn't support multi-volume AMIs"},"instanceRequirements":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupInstanceRequirements","description":"The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.\n You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. \n  If you specify ``InstanceRequirements``, you can't specify ``InstanceType``."},"instanceType":{"type":"string","description":"The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.\n You can specify up to 40 instance types per Auto Scaling group."},"launchTemplateSpecification":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupLaunchTemplateSpecification","description":"Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``LaunchTemplate`` definition. For more information, see [Specifying a different launch template for an instance type](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the *Amazon EC2 Auto Scaling User Guide*. \n You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit."},"weightedCapacity":{"type":"string","description":"If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [Configure instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon EC2 Auto Scaling User Guide*. Value must be in the range of 1-999. \n If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them.\n  Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupLaunchTemplateSpecification":{"description":"Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group.\n You must specify the following:\n  +  The ID or the name of the launch template, but not both.\n  +  The version of the launch template.\n  \n ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types.\n For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*.\n For examples of launch templates, see [Create launch templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-launch-templates.html).","properties":{"launchTemplateId":{"type":"string","description":"The ID of the launch template.\n You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both."},"launchTemplateName":{"type":"string","description":"The name of the launch template.\n You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both."},"version":{"type":"string","description":"The version number of the launch template.\n Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).\n  For an example of using the ``Fn::GetAtt`` function, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource."}},"type":"object","required":["version"]},"aws-native:autoscaling:AutoScalingGroupLifecycleHookSpecification":{"description":"``LifecycleHookSpecification`` specifies a lifecycle hook for the ``LifecycleHookSpecificationList`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. A lifecycle hook specifies actions to perform when Amazon EC2 Auto Scaling launches or terminates instances. \n For more information, see [Amazon EC2 Auto Scaling lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-lifecyclehook.html#aws-resource-as-lifecyclehook--examples) section of the ``AWS::AutoScaling::LifecycleHook`` resource.","properties":{"defaultResult":{"type":"string","description":"The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``.\n Valid values: ``CONTINUE`` | ``ABANDON``"},"heartbeatTimeout":{"type":"integer","description":"The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour)."},"lifecycleHookName":{"type":"string","description":"The name of the lifecycle hook."},"lifecycleTransition":{"type":"string","description":"The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.\n  +  To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``.\n  +  To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``."},"notificationMetadata":{"type":"string","description":"Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target."},"notificationTargetArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue."},"roleArn":{"type":"string","description":"The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Prepare to add a lifecycle hook to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html) in the *Amazon EC2 Auto Scaling User Guide*.\n Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue."}},"type":"object","required":["lifecycleHookName","lifecycleTransition"]},"aws-native:autoscaling:AutoScalingGroupMemoryGiBPerVCpuRequest":{"description":"``MemoryGiBPerVCpuRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB.","properties":{"max":{"type":"number","description":"The memory maximum in GiB."},"min":{"type":"number","description":"The memory minimum in GiB."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupMemoryMiBRequest":{"description":"``MemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum instance memory size for an instance type, in MiB.","properties":{"max":{"type":"integer","description":"The memory maximum in MiB."},"min":{"type":"integer","description":"The memory minimum in MiB."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupMetricsCollection":{"description":"``MetricsCollection`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource that describes the group metrics that an Amazon EC2 Auto Scaling group sends to Amazon CloudWatch. These metrics describe the group rather than any of its instances. \n For more information, see [Monitor CloudWatch metrics for your Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.","properties":{"granularity":{"type":"string","description":"The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``."},"metrics":{"type":"array","items":{"type":"string"},"description":"Identifies the metrics to enable.\n You can specify one or more of the following metrics:\n  +   ``GroupMinSize`` \n  +   ``GroupMaxSize`` \n  +   ``GroupDesiredCapacity`` \n  +   ``GroupInServiceInstances`` \n  +   ``GroupPendingInstances`` \n  +   ``GroupStandbyInstances`` \n  +   ``GroupTerminatingInstances`` \n  +   ``GroupTotalInstances`` \n  +   ``GroupInServiceCapacity`` \n  +   ``GroupPendingCapacity`` \n  +   ``GroupStandbyCapacity`` \n  +   ``GroupTerminatingCapacity`` \n  +   ``GroupTotalCapacity`` \n  +   ``WarmPoolDesiredCapacity`` \n  +   ``WarmPoolWarmedCapacity`` \n  +   ``WarmPoolPendingCapacity`` \n  +   ``WarmPoolTerminatingCapacity`` \n  +   ``WarmPoolTotalCapacity`` \n  +   ``GroupAndWarmPoolDesiredCapacity`` \n  +   ``GroupAndWarmPoolTotalCapacity`` \n  \n If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled.\n For more information, see [Amazon CloudWatch metrics for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-metrics.html) in the *Amazon EC2 Auto Scaling User Guide*."}},"type":"object","required":["granularity"]},"aws-native:autoscaling:AutoScalingGroupMixedInstancesPolicy":{"description":"Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.\n A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*.\n You can create a mixed instances policy for new and existing Auto Scaling groups. You must use a launch template to configure the policy. You cannot use a launch configuration.\n There are key differences between Spot Instances and On-Demand Instances:\n  +  The price for Spot Instances varies based on demand\n  +  Amazon EC2 can terminate an individual Spot Instance as the availability of, or price for, Spot Instances changes\n  \n When a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a replacement instance to maintain the desired capacity for the group. \n ``MixedInstancesPolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.","properties":{"instancesDistribution":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupInstancesDistribution","description":"The instances distribution."},"launchTemplate":{"$ref":"#/types/aws-native:autoscaling:AutoScalingGroupLaunchTemplate","description":"One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities."}},"type":"object","required":["launchTemplate"]},"aws-native:autoscaling:AutoScalingGroupNetworkBandwidthGbpsRequest":{"description":"``NetworkBandwidthGbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum network bandwidth for an instance type, in Gbps.\n  Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide for Linux Instances*.","properties":{"max":{"type":"number","description":"The maximum amount of network bandwidth, in gigabits per second (Gbps)."},"min":{"type":"number","description":"The minimum amount of network bandwidth, in gigabits per second (Gbps)."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupNetworkInterfaceCountRequest":{"description":"``NetworkInterfaceCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of network interfaces for an instance type.","properties":{"max":{"type":"integer","description":"The maximum number of network interfaces."},"min":{"type":"integer","description":"The minimum number of network interfaces."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupNotificationConfiguration":{"description":"A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\n For an example template snippet, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html).\n For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.","properties":{"notificationTypes":{"type":"array","items":{"type":"string"},"description":"A list of event types that send a notification. Event types can include any of the following types. \n *Allowed values*:\n  +   ``autoscaling:EC2_INSTANCE_LAUNCH`` \n  +   ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR`` \n  +   ``autoscaling:EC2_INSTANCE_TERMINATE`` \n  +   ``autoscaling:EC2_INSTANCE_TERMINATE_ERROR`` \n  +   ``autoscaling:TEST_NOTIFICATION``"},"topicArn":{"type":"array","items":{"type":"string"},"description":"The Amazon Resource Name (ARN) of the Amazon SNS topic."}},"type":"object","required":["topicArn"]},"aws-native:autoscaling:AutoScalingGroupPerformanceFactorReferenceRequest":{"description":"Specify an instance family to use as the baseline reference for CPU performance. All instance types that All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. \n  Currently only one instance family can be specified in the list.","properties":{"instanceFamily":{"type":"string","description":"The instance family to use as a baseline reference. \n  Make sure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance ``c6i.large``, the instance family is ``c6i``, not ``c6``. For more information, see [Amazon EC2 instance type naming conventions](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html) in *Amazon EC2 Instance Types*.\n  The following instance types are *not supported* for performance protection.\n  +   ``c1`` \n  +   ``g3| g3s`` \n  +   ``hpc7g`` \n  +   ``m1| m2`` \n  +   ``mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro`` \n  +   ``p3dn | p4d | p5`` \n  +   ``t1`` \n  +   ``u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb`` \n  \n If you performance protection by specifying a supported instance family, the returned instance types will exclude the preceding unsupported instance families.\n If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupRetentionTriggers":{"description":"Defines the specific triggers that cause instances to be retained in a Retained state rather than terminated. Each trigger corresponds to a different failure scenario during the instance lifecycle. This allows fine-grained control over when to preserve instances for manual intervention.","properties":{"terminateHookAbandon":{"type":"string","description":"Specifies the action when a termination lifecycle hook is abandoned due to failure, timeout, or explicit abandonment (calling CompleteLifecycleAction). \n  Set to ``retain`` to move instances to a retained state. Set to ``terminate`` for default termination behavior. \n  Retained instances don't count toward desired capacity and remain until you call ``TerminateInstanceInAutoScalingGroup``."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupTagProperty":{"description":"A structure that specifies a tag for the ``Tags`` property of [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.\n For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*. You can find a sample template snippet in the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.\n CloudFormation adds the following tags to all Auto Scaling groups and associated instances: \n  +  aws:cloudformation:stack-name\n  +  aws:cloudformation:stack-id\n  +  aws:cloudformation:logical-id","properties":{"key":{"type":"string","description":"The tag key."},"propagateAtLaunch":{"type":"boolean","description":"Set to ``true`` if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to ``false`` if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","propagateAtLaunch","value"]},"aws-native:autoscaling:AutoScalingGroupTotalLocalStorageGbRequest":{"description":"``TotalLocalStorageGBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total local storage size for an instance type, in GB.","properties":{"max":{"type":"number","description":"The storage maximum in GB."},"min":{"type":"number","description":"The storage minimum in GB."}},"type":"object"},"aws-native:autoscaling:AutoScalingGroupTrafficSourceIdentifier":{"description":"Identifying information for a traffic source.","properties":{"identifier":{"type":"string","description":"Identifies the traffic source.\n For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region.\n For example: \n  +  Application Load Balancer ARN: ``arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456``\n  +  Classic Load Balancer name: ``my-classic-load-balancer``\n  +  VPC Lattice ARN: ``arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456``\n  \n To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) and [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operations.\n To get the ARN of a target group for VPC Lattice, use the VPC Lattice [GetTargetGroup](https://docs.aws.amazon.com/vpc-lattice/latest/APIReference/API_GetTargetGroup.html) API operation."},"type":{"type":"string","description":"Provides additional context for the value of ``Identifier``.\n The following lists the valid values:\n  +  ``elb`` if ``Identifier`` is the name of a Classic Load Balancer.\n  +  ``elbv2`` if ``Identifier`` is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.\n  +  ``vpc-lattice`` if ``Identifier`` is the ARN of a VPC Lattice target group.\n  \n Required if the identifier is the name of a Classic Load Balancer."}},"type":"object","required":["identifier","type"]},"aws-native:autoscaling:AutoScalingGroupVCpuCountRequest":{"description":"``VCpuCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of vCPUs for an instance type.","properties":{"max":{"type":"integer","description":"The maximum number of vCPUs."},"min":{"type":"integer","description":"The minimum number of vCPUs."}},"type":"object"},"aws-native:autoscaling:LaunchConfigurationBlockDevice":{"description":"BlockDevice is a subproperty of BlockDeviceMapping that describes an Amazon EBS volume.","properties":{"deleteOnTermination":{"type":"boolean","description":"Indicates whether the volume is deleted on instance termination. "},"encrypted":{"type":"boolean","description":"Specifies whether the volume should be encrypted. "},"iops":{"type":"integer","description":"The number of input/output (I/O) operations per second (IOPS) to provision for the volume. "},"snapshotId":{"type":"string","description":"The snapshot ID of the volume to use."},"throughput":{"type":"integer","description":"The throughput (MiBps) to provision for a gp3 volume."},"volumeSize":{"type":"integer","description":"The volume size, in GiBs."},"volumeType":{"type":"string","description":"The volume type."}},"type":"object"},"aws-native:autoscaling:LaunchConfigurationBlockDeviceMapping":{"description":"BlockDeviceMapping is a property of AWS::AutoScaling::LaunchConfiguration that describes a block device mapping for an Auto Scaling group.","properties":{"deviceName":{"type":"string","description":"The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). "},"ebs":{"$ref":"#/types/aws-native:autoscaling:LaunchConfigurationBlockDevice","description":"Parameters used to automatically set up EBS volumes when an instance is launched."},"noDevice":{"type":"boolean","description":"Setting this value to true suppresses the specified device included in the block device mapping of the AMI."},"virtualName":{"type":"string","description":"The name of the virtual device."}},"type":"object","required":["deviceName"]},"aws-native:autoscaling:LaunchConfigurationMetadataOptions":{"description":"MetadataOptions is a property of AWS::AutoScaling::LaunchConfiguration that describes metadata options for the instances.","properties":{"httpEndpoint":{"type":"string","description":"This parameter enables or disables the HTTP metadata endpoint on your instances."},"httpPutResponseHopLimit":{"type":"integer","description":"The desired HTTP PUT response hop limit for instance metadata requests."},"httpTokens":{"type":"string","description":"The state of token usage for your instance metadata requests."}},"type":"object"},"aws-native:autoscaling:ScalingPolicyCustomizedMetricSpecification":{"properties":{"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyMetricDimension"},"description":"The dimensions of the metric.\n\nConditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy."},"metricName":{"type":"string","description":"The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) ."},"metrics":{"type":"array","items":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyTargetTrackingMetricDataQuery"},"description":"The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions."},"namespace":{"type":"string","description":"The namespace of the metric."},"period":{"type":"integer","description":"The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see [Create a target tracking policy using high-resolution metrics for faster response](https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html) ."},"statistic":{"type":"string","description":"The statistic of the metric."},"unit":{"type":"string","description":"The unit of the metric. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference* ."}},"type":"object"},"aws-native:autoscaling:ScalingPolicyMetric":{"properties":{"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyMetricDimension"},"description":"The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in [AWS services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide* .\n\nConditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy."},"metricName":{"type":"string","description":"The name of the metric."},"namespace":{"type":"string","description":"The namespace of the metric. For more information, see the table in [AWS services that publish CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) in the *Amazon CloudWatch User Guide* ."}},"type":"object","required":["metricName","namespace"]},"aws-native:autoscaling:ScalingPolicyMetricDataQuery":{"properties":{"expression":{"type":"string","description":"The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions.\n\nConditional: Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat` , but not both."},"id":{"type":"string","description":"A short name that identifies the object's results in the response. This name must be unique among all `MetricDataQuery` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter."},"label":{"type":"string","description":"A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents."},"metricStat":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyMetricStat","description":"Information about the metric data to return.\n\nConditional: Within each `MetricDataQuery` object, you must specify either `Expression` or `MetricStat` , but not both."},"returnData":{"type":"boolean","description":"Indicates whether to return the timestamps and raw data values of this metric.\n\nIf you use any math expressions, specify `true` for this value for only the final math expression that the metric specification is based on. You must specify `false` for `ReturnData` for all the other metrics and expressions used in the metric specification.\n\nIf you are only retrieving metrics and not performing any math expressions, do not specify anything for `ReturnData` . This sets it to its default ( `true` )."}},"type":"object","required":["id"]},"aws-native:autoscaling:ScalingPolicyMetricDimension":{"properties":{"name":{"type":"string","description":"The name of the dimension."},"value":{"type":"string","description":"The value of the dimension."}},"type":"object","required":["name","value"]},"aws-native:autoscaling:ScalingPolicyMetricStat":{"properties":{"metric":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyMetric","description":"The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) ."},"stat":{"type":"string","description":"The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide* .\n\nThe most commonly used metrics for predictive scaling are `Average` and `Sum` ."},"unit":{"type":"string","description":"The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference* ."}},"type":"object","required":["metric","stat"]},"aws-native:autoscaling:ScalingPolicyPredefinedMetricSpecification":{"properties":{"predefinedMetricType":{"type":"string","description":"The metric type. The following predefined metrics are available:\n\n- `ASGAverageCPUUtilization` - Average CPU utilization of the Auto Scaling group.\n- `ASGAverageNetworkIn` - Average number of bytes received on all network interfaces by the Auto Scaling group.\n- `ASGAverageNetworkOut` - Average number of bytes sent out on all network interfaces by the Auto Scaling group.\n- `ALBRequestCountPerTarget` - Average Application Load Balancer request count per target for your Auto Scaling group."},"resourceLabel":{"type":"string","description":"A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.\n\nYou create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:\n\n`app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff` .\n\nWhere:\n\n- app/\u003cload-balancer-name\u003e/\u003cload-balancer-id\u003e is the final portion of the load balancer ARN\n- targetgroup/\u003ctarget-group-name\u003e/\u003ctarget-group-id\u003e is the final portion of the target group ARN.\n\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation."}},"type":"object","required":["predefinedMetricType"]},"aws-native:autoscaling:ScalingPolicyPredictiveScalingConfiguration":{"properties":{"maxCapacityBreachBehavior":{"type":"string","description":"Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to `HonorMaxCapacity` if not specified.\n\nThe following are possible values:\n\n- `HonorMaxCapacity` - Amazon EC2 Auto Scaling can't increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity.\n- `IncreaseMaxCapacity` - Amazon EC2 Auto Scaling can increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for `MaxCapacityBuffer` .\n\n\u003e Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum."},"maxCapacityBuffer":{"type":"integer","description":"The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.\n\nIf set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.\n\nRequired if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise."},"metricSpecifications":{"type":"array","items":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyPredictiveScalingMetricSpecification"},"description":"This structure includes the metrics and target utilization to use for predictive scaling.\n\nThis is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric."},"mode":{"type":"string","description":"The predictive scaling mode. Defaults to `ForecastOnly` if not specified."},"schedulingBufferTime":{"type":"integer","description":"The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.\n\nThe value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified."}},"type":"object","required":["metricSpecifications"]},"aws-native:autoscaling:ScalingPolicyPredictiveScalingCustomizedCapacityMetric":{"properties":{"metricDataQueries":{"type":"array","items":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyMetricDataQuery"},"description":"One or more metric data queries to provide the data points for a capacity metric. Use multiple metric data queries only if you are performing a math expression on returned data."}},"type":"object","required":["metricDataQueries"]},"aws-native:autoscaling:ScalingPolicyPredictiveScalingCustomizedLoadMetric":{"properties":{"metricDataQueries":{"type":"array","items":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyMetricDataQuery"},"description":"One or more metric data queries to provide the data points for a load metric. Use multiple metric data queries only if you are performing a math expression on returned data."}},"type":"object","required":["metricDataQueries"]},"aws-native:autoscaling:ScalingPolicyPredictiveScalingCustomizedScalingMetric":{"properties":{"metricDataQueries":{"type":"array","items":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyMetricDataQuery"},"description":"One or more metric data queries to provide the data points for a scaling metric. Use multiple metric data queries only if you are performing a math expression on returned data."}},"type":"object","required":["metricDataQueries"]},"aws-native:autoscaling:ScalingPolicyPredictiveScalingMetricSpecification":{"properties":{"customizedCapacityMetricSpecification":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyPredictiveScalingCustomizedCapacityMetric","description":"The customized capacity metric specification."},"customizedLoadMetricSpecification":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyPredictiveScalingCustomizedLoadMetric","description":"The customized load metric specification."},"customizedScalingMetricSpecification":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyPredictiveScalingCustomizedScalingMetric","description":"The customized scaling metric specification."},"predefinedLoadMetricSpecification":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyPredictiveScalingPredefinedLoadMetric","description":"The predefined load metric specification."},"predefinedMetricPairSpecification":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyPredictiveScalingPredefinedMetricPair","description":"The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use."},"predefinedScalingMetricSpecification":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyPredictiveScalingPredefinedScalingMetric","description":"The predefined scaling metric specification."},"targetValue":{"type":"number","description":"Specifies the target utilization.\n\n\u003e Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval."}},"type":"object","required":["targetValue"]},"aws-native:autoscaling:ScalingPolicyPredictiveScalingPredefinedLoadMetric":{"properties":{"predefinedMetricType":{"type":"string","description":"The metric type."},"resourceLabel":{"type":"string","description":"A label that uniquely identifies a specific Application Load Balancer target group from which to determine the request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.\n\nYou create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:\n\n`app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff` .\n\nWhere:\n\n- app/\u003cload-balancer-name\u003e/\u003cload-balancer-id\u003e is the final portion of the load balancer ARN\n- targetgroup/\u003ctarget-group-name\u003e/\u003ctarget-group-id\u003e is the final portion of the target group ARN.\n\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation."}},"type":"object","required":["predefinedMetricType"]},"aws-native:autoscaling:ScalingPolicyPredictiveScalingPredefinedMetricPair":{"properties":{"predefinedMetricType":{"type":"string","description":"Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric. For example, if the metric type is `ASGCPUUtilization` , the Auto Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric."},"resourceLabel":{"type":"string","description":"A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.\n\nYou create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:\n\n`app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff` .\n\nWhere:\n\n- app/\u003cload-balancer-name\u003e/\u003cload-balancer-id\u003e is the final portion of the load balancer ARN\n- targetgroup/\u003ctarget-group-name\u003e/\u003ctarget-group-id\u003e is the final portion of the target group ARN.\n\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation."}},"type":"object","required":["predefinedMetricType"]},"aws-native:autoscaling:ScalingPolicyPredictiveScalingPredefinedScalingMetric":{"properties":{"predefinedMetricType":{"type":"string","description":"The metric type."},"resourceLabel":{"type":"string","description":"A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.\n\nYou create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:\n\n`app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff` .\n\nWhere:\n\n- app/\u003cload-balancer-name\u003e/\u003cload-balancer-id\u003e is the final portion of the load balancer ARN\n- targetgroup/\u003ctarget-group-name\u003e/\u003ctarget-group-id\u003e is the final portion of the target group ARN.\n\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation."}},"type":"object","required":["predefinedMetricType"]},"aws-native:autoscaling:ScalingPolicyStepAdjustment":{"properties":{"metricIntervalLowerBound":{"type":"number","description":"The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity."},"metricIntervalUpperBound":{"type":"number","description":"The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.\n\nThe upper bound must be greater than the lower bound."},"scalingAdjustment":{"type":"integer","description":"The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value."}},"type":"object","required":["scalingAdjustment"]},"aws-native:autoscaling:ScalingPolicyTargetTrackingConfiguration":{"properties":{"customizedMetricSpecification":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyCustomizedMetricSpecification","description":"A customized metric. You must specify either a predefined metric or a customized metric."},"disableScaleIn":{"type":"boolean","description":"Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is `false` ."},"predefinedMetricSpecification":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyPredefinedMetricSpecification","description":"A predefined metric. You must specify either a predefined metric or a customized metric."},"targetValue":{"type":"number","description":"The target value for the metric.\n\n\u003e Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval."}},"type":"object","required":["targetValue"]},"aws-native:autoscaling:ScalingPolicyTargetTrackingMetricDataQuery":{"properties":{"expression":{"type":"string","description":"The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions.\n\nConditional: Within each `TargetTrackingMetricDataQuery` object, you must specify either `Expression` or `MetricStat` , but not both."},"id":{"type":"string","description":"A short name that identifies the object's results in the response. This name must be unique among all `TargetTrackingMetricDataQuery` objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter."},"label":{"type":"string","description":"A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents."},"metricStat":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyTargetTrackingMetricStat","description":"Information about the metric data to return.\n\nConditional: Within each `TargetTrackingMetricDataQuery` object, you must specify either `Expression` or `MetricStat` , but not both."},"period":{"type":"integer","description":"The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see [Create a target tracking policy using high-resolution metrics for faster response](https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html) ."},"returnData":{"type":"boolean","description":"Indicates whether to return the timestamps and raw data values of this metric.\n\nIf you use any math expressions, specify `true` for this value for only the final math expression that the metric specification is based on. You must specify `false` for `ReturnData` for all the other metrics and expressions used in the metric specification.\n\nIf you are only retrieving metrics and not performing any math expressions, do not specify anything for `ReturnData` . This sets it to its default ( `true` )."}},"type":"object","required":["id"]},"aws-native:autoscaling:ScalingPolicyTargetTrackingMetricStat":{"properties":{"metric":{"$ref":"#/types/aws-native:autoscaling:ScalingPolicyMetric","description":"The metric to use."},"period":{"type":"integer","description":"The period of the metric in seconds. The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see [Create a target tracking policy using high-resolution metrics for faster response](https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html) ."},"stat":{"type":"string","description":"The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *Amazon CloudWatch User Guide* .\n\nThe most commonly used metric for scaling is `Average` ."},"unit":{"type":"string","description":"The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference* ."}},"type":"object","required":["metric","stat"]},"aws-native:autoscaling:WarmPoolInstanceReusePolicy":{"properties":{"reuseOnScaleIn":{"type":"boolean","description":"Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in."}},"type":"object"},"aws-native:b2bi:CapabilityConfiguration0Properties":{"properties":{"edi":{"$ref":"#/types/aws-native:b2bi:CapabilityEdiConfiguration"}},"type":"object","required":["edi"]},"aws-native:b2bi:CapabilityConfigurationProperties":{"properties":{"edi":{"$ref":"#/types/aws-native:b2bi:CapabilityEdiConfiguration"}},"type":"object","required":["edi"]},"aws-native:b2bi:CapabilityDirection":{"type":"string","enum":[{"name":"Inbound","value":"INBOUND"},{"name":"Outbound","value":"OUTBOUND"}]},"aws-native:b2bi:CapabilityEdiConfiguration":{"properties":{"capabilityDirection":{"$ref":"#/types/aws-native:b2bi:CapabilityDirection"},"inputLocation":{"$ref":"#/types/aws-native:b2bi:CapabilityS3Location"},"outputLocation":{"$ref":"#/types/aws-native:b2bi:CapabilityS3Location"},"transformerId":{"type":"string"},"type":{"$ref":"#/types/aws-native:b2bi:CapabilityEdiTypeProperties"}},"type":"object","required":["inputLocation","outputLocation","transformerId","type"]},"aws-native:b2bi:CapabilityEdiType0Properties":{"properties":{"x12Details":{"$ref":"#/types/aws-native:b2bi:CapabilityX12Details"}},"type":"object","required":["x12Details"]},"aws-native:b2bi:CapabilityEdiTypeProperties":{"properties":{"x12Details":{"$ref":"#/types/aws-native:b2bi:CapabilityX12Details"}},"type":"object","required":["x12Details"]},"aws-native:b2bi:CapabilityS3Location":{"properties":{"bucketName":{"type":"string"},"key":{"type":"string"}},"type":"object"},"aws-native:b2bi:CapabilityTag":{"properties":{"key":{"type":"string","description":"Specifies the name assigned to the tag that you create."},"value":{"type":"string","description":"Contains one or more values that you assigned to the key name that you create."}},"type":"object","required":["key","value"]},"aws-native:b2bi:CapabilityType":{"type":"string","enum":[{"name":"Edi","value":"edi"}]},"aws-native:b2bi:CapabilityX12Details":{"properties":{"transactionSet":{"$ref":"#/types/aws-native:b2bi:CapabilityX12TransactionSet"},"version":{"$ref":"#/types/aws-native:b2bi:CapabilityX12Version"}},"type":"object"},"aws-native:b2bi:CapabilityX12TransactionSet":{"type":"string","enum":[{"name":"X12100","value":"X12_100"},{"name":"X12101","value":"X12_101"},{"name":"X12102","value":"X12_102"},{"name":"X12103","value":"X12_103"},{"name":"X12104","value":"X12_104"},{"name":"X12105","value":"X12_105"},{"name":"X12106","value":"X12_106"},{"name":"X12107","value":"X12_107"},{"name":"X12108","value":"X12_108"},{"name":"X12109","value":"X12_109"},{"name":"X12110","value":"X12_110"},{"name":"X12111","value":"X12_111"},{"name":"X12112","value":"X12_112"},{"name":"X12113","value":"X12_113"},{"name":"X12120","value":"X12_120"},{"name":"X12121","value":"X12_121"},{"name":"X12124","value":"X12_124"},{"name":"X12125","value":"X12_125"},{"name":"X12126","value":"X12_126"},{"name":"X12127","value":"X12_127"},{"name":"X12128","value":"X12_128"},{"name":"X12129","value":"X12_129"},{"name":"X12130","value":"X12_130"},{"name":"X12131","value":"X12_131"},{"name":"X12132","value":"X12_132"},{"name":"X12133","value":"X12_133"},{"name":"X12135","value":"X12_135"},{"name":"X12138","value":"X12_138"},{"name":"X12139","value":"X12_139"},{"name":"X12140","value":"X12_140"},{"name":"X12141","value":"X12_141"},{"name":"X12142","value":"X12_142"},{"name":"X12143","value":"X12_143"},{"name":"X12144","value":"X12_144"},{"name":"X12146","value":"X12_146"},{"name":"X12147","value":"X12_147"},{"name":"X12148","value":"X12_148"},{"name":"X12149","value":"X12_149"},{"name":"X12150","value":"X12_150"},{"name":"X12151","value":"X12_151"},{"name":"X12152","value":"X12_152"},{"name":"X12153","value":"X12_153"},{"name":"X12154","value":"X12_154"},{"name":"X12155","value":"X12_155"},{"name":"X12157","value":"X12_157"},{"name":"X12158","value":"X12_158"},{"name":"X12159","value":"X12_159"},{"name":"X12160","value":"X12_160"},{"name":"X12161","value":"X12_161"},{"name":"X12163","value":"X12_163"},{"name":"X12170","value":"X12_170"},{"name":"X12175","value":"X12_175"},{"name":"X12176","value":"X12_176"},{"name":"X12179","value":"X12_179"},{"name":"X12180","value":"X12_180"},{"name":"X12185","value":"X12_185"},{"name":"X12186","value":"X12_186"},{"name":"X12187","value":"X12_187"},{"name":"X12188","value":"X12_188"},{"name":"X12189","value":"X12_189"},{"name":"X12190","value":"X12_190"},{"name":"X12191","value":"X12_191"},{"name":"X12194","value":"X12_194"},{"name":"X12195","value":"X12_195"},{"name":"X12196","value":"X12_196"},{"name":"X12197","value":"X12_197"},{"name":"X12198","value":"X12_198"},{"name":"X12199","value":"X12_199"},{"name":"X12200","value":"X12_200"},{"name":"X12201","value":"X12_201"},{"name":"X12202","value":"X12_202"},{"name":"X12203","value":"X12_203"},{"name":"X12204","value":"X12_204"},{"name":"X12205","value":"X12_205"},{"name":"X12206","value":"X12_206"},{"name":"X12210","value":"X12_210"},{"name":"X12211","value":"X12_211"},{"name":"X12212","value":"X12_212"},{"name":"X12213","value":"X12_213"},{"name":"X12214","value":"X12_214"},{"name":"X12215","value":"X12_215"},{"name":"X12216","value":"X12_216"},{"name":"X12217","value":"X12_217"},{"name":"X12218","value":"X12_218"},{"name":"X12219","value":"X12_219"},{"name":"X12220","value":"X12_220"},{"name":"X12222","value":"X12_222"},{"name":"X12223","value":"X12_223"},{"name":"X12224","value":"X12_224"},{"name":"X12225","value":"X12_225"},{"name":"X12227","value":"X12_227"},{"name":"X12228","value":"X12_228"},{"name":"X12240","value":"X12_240"},{"name":"X12242","value":"X12_242"},{"name":"X12244","value":"X12_244"},{"name":"X12245","value":"X12_245"},{"name":"X12248","value":"X12_248"},{"name":"X12249","value":"X12_249"},{"name":"X12250","value":"X12_250"},{"name":"X12251","value":"X12_251"},{"name":"X12252","value":"X12_252"},{"name":"X12255","value":"X12_255"},{"name":"X12256","value":"X12_256"},{"name":"X12259","value":"X12_259"},{"name":"X12260","value":"X12_260"},{"name":"X12261","value":"X12_261"},{"name":"X12262","value":"X12_262"},{"name":"X12263","value":"X12_263"},{"name":"X12264","value":"X12_264"},{"name":"X12265","value":"X12_265"},{"name":"X12266","value":"X12_266"},{"name":"X12267","value":"X12_267"},{"name":"X12268","value":"X12_268"},{"name":"X12269","value":"X12_269"},{"name":"X12270","value":"X12_270"},{"name":"X12271","value":"X12_271"},{"name":"X12272","value":"X12_272"},{"name":"X12273","value":"X12_273"},{"name":"X12274","value":"X12_274"},{"name":"X12275","value":"X12_275"},{"name":"X12276","value":"X12_276"},{"name":"X12277","value":"X12_277"},{"name":"X12278","value":"X12_278"},{"name":"X12280","value":"X12_280"},{"name":"X12283","value":"X12_283"},{"name":"X12284","value":"X12_284"},{"name":"X12285","value":"X12_285"},{"name":"X12286","value":"X12_286"},{"name":"X12288","value":"X12_288"},{"name":"X12290","value":"X12_290"},{"name":"X12300","value":"X12_300"},{"name":"X12301","value":"X12_301"},{"name":"X12303","value":"X12_303"},{"name":"X12304","value":"X12_304"},{"name":"X12309","value":"X12_309"},{"name":"X12310","value":"X12_310"},{"name":"X12311","value":"X12_311"},{"name":"X12312","value":"X12_312"},{"name":"X12313","value":"X12_313"},{"name":"X12315","value":"X12_315"},{"name":"X12317","value":"X12_317"},{"name":"X12319","value":"X12_319"},{"name":"X12322","value":"X12_322"},{"name":"X12323","value":"X12_323"},{"name":"X12324","value":"X12_324"},{"name":"X12325","value":"X12_325"},{"name":"X12326","value":"X12_326"},{"name":"X12350","value":"X12_350"},{"name":"X12352","value":"X12_352"},{"name":"X12353","value":"X12_353"},{"name":"X12354","value":"X12_354"},{"name":"X12355","value":"X12_355"},{"name":"X12356","value":"X12_356"},{"name":"X12357","value":"X12_357"},{"name":"X12358","value":"X12_358"},{"name":"X12361","value":"X12_361"},{"name":"X12362","value":"X12_362"},{"name":"X12404","value":"X12_404"},{"name":"X12410","value":"X12_410"},{"name":"X12412","value":"X12_412"},{"name":"X12414","value":"X12_414"},{"name":"X12417","value":"X12_417"},{"name":"X12418","value":"X12_418"},{"name":"X12419","value":"X12_419"},{"name":"X12420","value":"X12_420"},{"name":"X12421","value":"X12_421"},{"name":"X12422","value":"X12_422"},{"name":"X12423","value":"X12_423"},{"name":"X12424","value":"X12_424"},{"name":"X12425","value":"X12_425"},{"name":"X12426","value":"X12_426"},{"name":"X12429","value":"X12_429"},{"name":"X12431","value":"X12_431"},{"name":"X12432","value":"X12_432"},{"name":"X12433","value":"X12_433"},{"name":"X12434","value":"X12_434"},{"name":"X12435","value":"X12_435"},{"name":"X12436","value":"X12_436"},{"name":"X12437","value":"X12_437"},{"name":"X12440","value":"X12_440"},{"name":"X12451","value":"X12_451"},{"name":"X12452","value":"X12_452"},{"name":"X12453","value":"X12_453"},{"name":"X12455","value":"X12_455"},{"name":"X12456","value":"X12_456"},{"name":"X12460","value":"X12_460"},{"name":"X12463","value":"X12_463"},{"name":"X12466","value":"X12_466"},{"name":"X12468","value":"X12_468"},{"name":"X12470","value":"X12_470"},{"name":"X12475","value":"X12_475"},{"name":"X12485","value":"X12_485"},{"name":"X12486","value":"X12_486"},{"name":"X12490","value":"X12_490"},{"name":"X12492","value":"X12_492"},{"name":"X12494","value":"X12_494"},{"name":"X12500","value":"X12_500"},{"name":"X12501","value":"X12_501"},{"name":"X12503","value":"X12_503"},{"name":"X12504","value":"X12_504"},{"name":"X12511","value":"X12_511"},{"name":"X12517","value":"X12_517"},{"name":"X12521","value":"X12_521"},{"name":"X12527","value":"X12_527"},{"name":"X12536","value":"X12_536"},{"name":"X12540","value":"X12_540"},{"name":"X12561","value":"X12_561"},{"name":"X12567","value":"X12_567"},{"name":"X12568","value":"X12_568"},{"name":"X12601","value":"X12_601"},{"name":"X12602","value":"X12_602"},{"name":"X12620","value":"X12_620"},{"name":"X12625","value":"X12_625"},{"name":"X12650","value":"X12_650"},{"name":"X12715","value":"X12_715"},{"name":"X12753","value":"X12_753"},{"name":"X12754","value":"X12_754"},{"name":"X12805","value":"X12_805"},{"name":"X12806","value":"X12_806"},{"name":"X12810","value":"X12_810"},{"name":"X12811","value":"X12_811"},{"name":"X12812","value":"X12_812"},{"name":"X12813","value":"X12_813"},{"name":"X12814","value":"X12_814"},{"name":"X12815","value":"X12_815"},{"name":"X12816","value":"X12_816"},{"name":"X12818","value":"X12_818"},{"name":"X12819","value":"X12_819"},{"name":"X12820","value":"X12_820"},{"name":"X12821","value":"X12_821"},{"name":"X12822","value":"X12_822"},{"name":"X12823","value":"X12_823"},{"name":"X12824","value":"X12_824"},{"name":"X12826","value":"X12_826"},{"name":"X12827","value":"X12_827"},{"name":"X12828","value":"X12_828"},{"name":"X12829","value":"X12_829"},{"name":"X12830","value":"X12_830"},{"name":"X12831","value":"X12_831"},{"name":"X12832","value":"X12_832"},{"name":"X12833","value":"X12_833"},{"name":"X12834","value":"X12_834"},{"name":"X12835","value":"X12_835"},{"name":"X12836","value":"X12_836"},{"name":"X12837","value":"X12_837"},{"name":"X12838","value":"X12_838"},{"name":"X12839","value":"X12_839"},{"name":"X12840","value":"X12_840"},{"name":"X12841","value":"X12_841"},{"name":"X12842","value":"X12_842"},{"name":"X12843","value":"X12_843"},{"name":"X12844","value":"X12_844"},{"name":"X12845","value":"X12_845"},{"name":"X12846","value":"X12_846"},{"name":"X12847","value":"X12_847"},{"name":"X12848","value":"X12_848"},{"name":"X12849","value":"X12_849"},{"name":"X12850","value":"X12_850"},{"name":"X12851","value":"X12_851"},{"name":"X12852","value":"X12_852"},{"name":"X12853","value":"X12_853"},{"name":"X12854","value":"X12_854"},{"name":"X12855","value":"X12_855"},{"name":"X12856","value":"X12_856"},{"name":"X12857","value":"X12_857"},{"name":"X12858","value":"X12_858"},{"name":"X12859","value":"X12_859"},{"name":"X12860","value":"X12_860"},{"name":"X12861","value":"X12_861"},{"name":"X12862","value":"X12_862"},{"name":"X12863","value":"X12_863"},{"name":"X12864","value":"X12_864"},{"name":"X12865","value":"X12_865"},{"name":"X12866","value":"X12_866"},{"name":"X12867","value":"X12_867"},{"name":"X12868","value":"X12_868"},{"name":"X12869","value":"X12_869"},{"name":"X12870","value":"X12_870"},{"name":"X12871","value":"X12_871"},{"name":"X12872","value":"X12_872"},{"name":"X12873","value":"X12_873"},{"name":"X12874","value":"X12_874"},{"name":"X12875","value":"X12_875"},{"name":"X12876","value":"X12_876"},{"name":"X12877","value":"X12_877"},{"name":"X12878","value":"X12_878"},{"name":"X12879","value":"X12_879"},{"name":"X12880","value":"X12_880"},{"name":"X12881","value":"X12_881"},{"name":"X12882","value":"X12_882"},{"name":"X12883","value":"X12_883"},{"name":"X12884","value":"X12_884"},{"name":"X12885","value":"X12_885"},{"name":"X12886","value":"X12_886"},{"name":"X12887","value":"X12_887"},{"name":"X12888","value":"X12_888"},{"name":"X12889","value":"X12_889"},{"name":"X12891","value":"X12_891"},{"name":"X12893","value":"X12_893"},{"name":"X12894","value":"X12_894"},{"name":"X12895","value":"X12_895"},{"name":"X12896","value":"X12_896"},{"name":"X12920","value":"X12_920"},{"name":"X12924","value":"X12_924"},{"name":"X12925","value":"X12_925"},{"name":"X12926","value":"X12_926"},{"name":"X12928","value":"X12_928"},{"name":"X12940","value":"X12_940"},{"name":"X12943","value":"X12_943"},{"name":"X12944","value":"X12_944"},{"name":"X12945","value":"X12_945"},{"name":"X12947","value":"X12_947"},{"name":"X12980","value":"X12_980"},{"name":"X12990","value":"X12_990"},{"name":"X12993","value":"X12_993"},{"name":"X12996","value":"X12_996"},{"name":"X12997","value":"X12_997"},{"name":"X12998","value":"X12_998"},{"name":"X12999","value":"X12_999"},{"name":"X12270x279","value":"X12_270_X279"},{"name":"X12271x279","value":"X12_271_X279"},{"name":"X12275x210","value":"X12_275_X210"},{"name":"X12275x211","value":"X12_275_X211"},{"name":"X12276x212","value":"X12_276_X212"},{"name":"X12277x212","value":"X12_277_X212"},{"name":"X12277x214","value":"X12_277_X214"},{"name":"X12277x364","value":"X12_277_X364"},{"name":"X12278x217","value":"X12_278_X217"},{"name":"X12820x218","value":"X12_820_X218"},{"name":"X12820x306","value":"X12_820_X306"},{"name":"X12824x186","value":"X12_824_X186"},{"name":"X12834x220","value":"X12_834_X220"},{"name":"X12834x307","value":"X12_834_X307"},{"name":"X12834x318","value":"X12_834_X318"},{"name":"X12835x221","value":"X12_835_X221"},{"name":"X12837x222","value":"X12_837_X222"},{"name":"X12837x223","value":"X12_837_X223"},{"name":"X12837x224","value":"X12_837_X224"},{"name":"X12837x291","value":"X12_837_X291"},{"name":"X12837x292","value":"X12_837_X292"},{"name":"X12837x298","value":"X12_837_X298"},{"name":"X12999x231","value":"X12_999_X231"}]},"aws-native:b2bi:CapabilityX12Version":{"type":"string","enum":[{"name":"Version4010","value":"VERSION_4010"},{"name":"Version4030","value":"VERSION_4030"},{"name":"Version4050","value":"VERSION_4050"},{"name":"Version4060","value":"VERSION_4060"},{"name":"Version5010","value":"VERSION_5010"},{"name":"Version5010Hipaa","value":"VERSION_5010_HIPAA"}]},"aws-native:b2bi:PartnershipCapabilityOptions":{"properties":{"inboundEdi":{"$ref":"#/types/aws-native:b2bi:PartnershipInboundEdiOptions","description":"A structure that contains the inbound EDI options for the capability."},"outboundEdi":{"$ref":"#/types/aws-native:b2bi:PartnershipOutboundEdiOptionsProperties","description":"A structure that contains the outbound EDI options."}},"type":"object"},"aws-native:b2bi:PartnershipInboundEdiOptions":{"properties":{"x12":{"$ref":"#/types/aws-native:b2bi:PartnershipX12InboundEdiOptions","description":"A structure that contains X12-specific options for processing inbound X12 EDI files."}},"type":"object"},"aws-native:b2bi:PartnershipLineTerminator":{"type":"string","enum":[{"name":"Crlf","value":"CRLF"},{"name":"Lf","value":"LF"},{"name":"Cr","value":"CR"}]},"aws-native:b2bi:PartnershipOutboundEdiOptions0Properties":{"properties":{"x12":{"$ref":"#/types/aws-native:b2bi:PartnershipX12Envelope"}},"type":"object","required":["x12"]},"aws-native:b2bi:PartnershipOutboundEdiOptionsProperties":{"properties":{"x12":{"$ref":"#/types/aws-native:b2bi:PartnershipX12Envelope"}},"type":"object","required":["x12"]},"aws-native:b2bi:PartnershipTag":{"properties":{"key":{"type":"string","description":"Specifies the name assigned to the tag that you create."},"value":{"type":"string","description":"Contains one or more values that you assigned to the key name that you create."}},"type":"object","required":["key","value"]},"aws-native:b2bi:PartnershipWrapFormat":{"type":"string","enum":[{"name":"Segment","value":"SEGMENT"},{"name":"OneLine","value":"ONE_LINE"},{"name":"LineLength","value":"LINE_LENGTH"}]},"aws-native:b2bi:PartnershipWrapOptions":{"properties":{"lineLength":{"type":"number"},"lineTerminator":{"$ref":"#/types/aws-native:b2bi:PartnershipLineTerminator"},"wrapBy":{"$ref":"#/types/aws-native:b2bi:PartnershipWrapFormat"}},"type":"object"},"aws-native:b2bi:PartnershipX12AcknowledgmentOptions":{"properties":{"functionalAcknowledgment":{"$ref":"#/types/aws-native:b2bi:PartnershipX12FunctionalAcknowledgment","description":"Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions. Valid values are `DO_NOT_GENERATE` , `GENERATE_ALL_SEGMENTS` and `GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP` .\n\nIf you choose `GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP` , AWS B2B Data Interchange skips the AK2_Loop when generating an acknowledgment document."},"technicalAcknowledgment":{"$ref":"#/types/aws-native:b2bi:PartnershipX12TechnicalAcknowledgment","description":"Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges. Valid values are `DO_NOT_GENERATE` and `GENERATE_ALL_SEGMENTS` and."}},"type":"object","required":["functionalAcknowledgment","technicalAcknowledgment"]},"aws-native:b2bi:PartnershipX12ControlNumbers":{"properties":{"startingFunctionalGroupControlNumber":{"type":"number"},"startingInterchangeControlNumber":{"type":"number"},"startingTransactionSetControlNumber":{"type":"number"}},"type":"object"},"aws-native:b2bi:PartnershipX12Delimiters":{"properties":{"componentSeparator":{"type":"string"},"dataElementSeparator":{"type":"string"},"segmentTerminator":{"type":"string"}},"type":"object"},"aws-native:b2bi:PartnershipX12Envelope":{"properties":{"common":{"$ref":"#/types/aws-native:b2bi:PartnershipX12OutboundEdiHeaders"},"wrapOptions":{"$ref":"#/types/aws-native:b2bi:PartnershipWrapOptions"}},"type":"object"},"aws-native:b2bi:PartnershipX12FunctionalAcknowledgment":{"type":"string","enum":[{"name":"DoNotGenerate","value":"DO_NOT_GENERATE"},{"name":"GenerateAllSegments","value":"GENERATE_ALL_SEGMENTS"},{"name":"GenerateWithoutTransactionSetResponseLoop","value":"GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP"}]},"aws-native:b2bi:PartnershipX12FunctionalGroupHeaders":{"properties":{"applicationReceiverCode":{"type":"string"},"applicationSenderCode":{"type":"string"},"responsibleAgencyCode":{"type":"string"}},"type":"object"},"aws-native:b2bi:PartnershipX12InboundEdiOptions":{"properties":{"acknowledgmentOptions":{"$ref":"#/types/aws-native:b2bi:PartnershipX12AcknowledgmentOptions","description":"Specifies acknowledgment options for inbound X12 EDI files. These options control how functional and technical acknowledgments are handled."}},"type":"object"},"aws-native:b2bi:PartnershipX12InterchangeControlHeaders":{"properties":{"acknowledgmentRequestedCode":{"type":"string"},"receiverId":{"type":"string"},"receiverIdQualifier":{"type":"string"},"repetitionSeparator":{"type":"string"},"senderId":{"type":"string"},"senderIdQualifier":{"type":"string"},"usageIndicatorCode":{"type":"string"}},"type":"object"},"aws-native:b2bi:PartnershipX12OutboundEdiHeaders":{"properties":{"controlNumbers":{"$ref":"#/types/aws-native:b2bi:PartnershipX12ControlNumbers"},"delimiters":{"$ref":"#/types/aws-native:b2bi:PartnershipX12Delimiters"},"functionalGroupHeaders":{"$ref":"#/types/aws-native:b2bi:PartnershipX12FunctionalGroupHeaders"},"gs05TimeFormat":{"$ref":"#/types/aws-native:b2bi:PartnershipX12gs05TimeFormat"},"interchangeControlHeaders":{"$ref":"#/types/aws-native:b2bi:PartnershipX12InterchangeControlHeaders"},"validateEdi":{"type":"boolean"}},"type":"object"},"aws-native:b2bi:PartnershipX12TechnicalAcknowledgment":{"type":"string","enum":[{"name":"DoNotGenerate","value":"DO_NOT_GENERATE"},{"name":"GenerateAllSegments","value":"GENERATE_ALL_SEGMENTS"}]},"aws-native:b2bi:PartnershipX12gs05TimeFormat":{"type":"string","enum":[{"name":"Hhmm","value":"HHMM"},{"name":"Hhmmss","value":"HHMMSS"},{"name":"Hhmmssdd","value":"HHMMSSDD"}]},"aws-native:b2bi:ProfileLogging":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:b2bi:ProfileTag":{"properties":{"key":{"type":"string","description":"Specifies the name assigned to the tag that you create."},"value":{"type":"string","description":"Contains one or more values that you assigned to the key name that you create."}},"type":"object","required":["key","value"]},"aws-native:b2bi:TransformerAdvancedOptions":{"properties":{"x12":{"$ref":"#/types/aws-native:b2bi:TransformerX12AdvancedOptions","description":"A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files."}},"type":"object"},"aws-native:b2bi:TransformerEdiType0Properties":{"properties":{"x12Details":{"$ref":"#/types/aws-native:b2bi:TransformerX12Details"}},"type":"object","required":["x12Details"]},"aws-native:b2bi:TransformerEdiTypeProperties":{"properties":{"x12Details":{"$ref":"#/types/aws-native:b2bi:TransformerX12Details"}},"type":"object","required":["x12Details"]},"aws-native:b2bi:TransformerElementRequirement":{"type":"string","enum":[{"name":"Optional","value":"OPTIONAL"},{"name":"Mandatory","value":"MANDATORY"}]},"aws-native:b2bi:TransformerFileFormat":{"type":"string","enum":[{"name":"Xml","value":"XML"},{"name":"Json","value":"JSON"},{"name":"NotUsed","value":"NOT_USED"}]},"aws-native:b2bi:TransformerFormatOptions0Properties":{"properties":{"x12":{"$ref":"#/types/aws-native:b2bi:TransformerX12Details"}},"type":"object","required":["x12"]},"aws-native:b2bi:TransformerFormatOptionsProperties":{"properties":{"x12":{"$ref":"#/types/aws-native:b2bi:TransformerX12Details"}},"type":"object","required":["x12"]},"aws-native:b2bi:TransformerFromFormat":{"type":"string","enum":[{"name":"X12","value":"X12"}]},"aws-native:b2bi:TransformerInputConversion":{"properties":{"advancedOptions":{"$ref":"#/types/aws-native:b2bi:TransformerAdvancedOptions","description":"Specifies advanced options for the input conversion process. These options provide additional control over how EDI files are processed during transformation."},"formatOptions":{"$ref":"#/types/aws-native:b2bi:TransformerFormatOptionsProperties","description":"A structure that contains the formatting options for an inbound transformer."},"fromFormat":{"$ref":"#/types/aws-native:b2bi:TransformerFromFormat","description":"The format for the transformer input: currently on `X12` is supported."}},"type":"object","required":["fromFormat"]},"aws-native:b2bi:TransformerMapping":{"properties":{"template":{"type":"string","description":"A string that represents the mapping template, in the transformation language specified in `templateLanguage` ."},"templateLanguage":{"$ref":"#/types/aws-native:b2bi:TransformerMappingTemplateLanguage","description":"The transformation language for the template, either XSLT or JSONATA."}},"type":"object","required":["templateLanguage"]},"aws-native:b2bi:TransformerMappingTemplateLanguage":{"type":"string","enum":[{"name":"Xslt","value":"XSLT"},{"name":"Jsonata","value":"JSONATA"}]},"aws-native:b2bi:TransformerOutputConversion":{"properties":{"advancedOptions":{"$ref":"#/types/aws-native:b2bi:TransformerAdvancedOptions"},"formatOptions":{"$ref":"#/types/aws-native:b2bi:TransformerFormatOptionsProperties","description":"A structure that contains the X12 transaction set and version for the transformer output."},"toFormat":{"$ref":"#/types/aws-native:b2bi:TransformerToFormat","description":"The format for the output from an outbound transformer: only X12 is currently supported."}},"type":"object","required":["toFormat"]},"aws-native:b2bi:TransformerSampleDocumentKeys":{"properties":{"input":{"type":"string","description":"An array of keys for your input sample documents."},"output":{"type":"string","description":"An array of keys for your output sample documents."}},"type":"object"},"aws-native:b2bi:TransformerSampleDocuments":{"properties":{"bucketName":{"type":"string","description":"Contains the Amazon S3 bucket that is used to hold your sample documents."},"keys":{"type":"array","items":{"$ref":"#/types/aws-native:b2bi:TransformerSampleDocumentKeys"},"description":"Contains an array of the Amazon S3 keys used to identify the location for your sample documents."}},"type":"object","required":["bucketName","keys"]},"aws-native:b2bi:TransformerStatus":{"type":"string","enum":[{"name":"Active","value":"active"},{"name":"Inactive","value":"inactive"}]},"aws-native:b2bi:TransformerTag":{"properties":{"key":{"type":"string","description":"Specifies the name assigned to the tag that you create."},"value":{"type":"string","description":"Contains one or more values that you assigned to the key name that you create."}},"type":"object","required":["key","value"]},"aws-native:b2bi:TransformerToFormat":{"type":"string","enum":[{"name":"X12","value":"X12"}]},"aws-native:b2bi:TransformerX12AdvancedOptions":{"properties":{"splitOptions":{"$ref":"#/types/aws-native:b2bi:TransformerX12SplitOptions","description":"Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units."},"validationOptions":{"$ref":"#/types/aws-native:b2bi:TransformerX12ValidationOptions","description":"Specifies validation options for X12 EDI processing. These options control how validation rules are applied during EDI document processing, including custom validation rules for element length constraints, code list validations, and element requirement checks."}},"type":"object"},"aws-native:b2bi:TransformerX12CodeListValidationRule":{"properties":{"codesToAdd":{"type":"array","items":{"type":"string"}},"codesToRemove":{"type":"array","items":{"type":"string"}},"elementId":{"type":"string"}},"type":"object","required":["elementId"]},"aws-native:b2bi:TransformerX12Details":{"properties":{"transactionSet":{"$ref":"#/types/aws-native:b2bi:TransformerX12TransactionSet"},"version":{"$ref":"#/types/aws-native:b2bi:TransformerX12Version"}},"type":"object"},"aws-native:b2bi:TransformerX12ElementLengthValidationRule":{"properties":{"elementId":{"type":"string"},"maxLength":{"type":"number"},"minLength":{"type":"number"}},"type":"object","required":["elementId","maxLength","minLength"]},"aws-native:b2bi:TransformerX12ElementRequirementValidationRule":{"properties":{"elementPosition":{"type":"string"},"requirement":{"$ref":"#/types/aws-native:b2bi:TransformerElementRequirement"}},"type":"object","required":["elementPosition","requirement"]},"aws-native:b2bi:TransformerX12SplitBy":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Transaction","value":"TRANSACTION"}]},"aws-native:b2bi:TransformerX12SplitOptions":{"properties":{"splitBy":{"$ref":"#/types/aws-native:b2bi:TransformerX12SplitBy","description":"Specifies the method used to split X12 EDI files. Valid values include `TRANSACTION` (split by individual transaction sets), or `NONE` (no splitting)."}},"type":"object"},"aws-native:b2bi:TransformerX12TransactionSet":{"type":"string","enum":[{"name":"X12100","value":"X12_100"},{"name":"X12101","value":"X12_101"},{"name":"X12102","value":"X12_102"},{"name":"X12103","value":"X12_103"},{"name":"X12104","value":"X12_104"},{"name":"X12105","value":"X12_105"},{"name":"X12106","value":"X12_106"},{"name":"X12107","value":"X12_107"},{"name":"X12108","value":"X12_108"},{"name":"X12109","value":"X12_109"},{"name":"X12110","value":"X12_110"},{"name":"X12111","value":"X12_111"},{"name":"X12112","value":"X12_112"},{"name":"X12113","value":"X12_113"},{"name":"X12120","value":"X12_120"},{"name":"X12121","value":"X12_121"},{"name":"X12124","value":"X12_124"},{"name":"X12125","value":"X12_125"},{"name":"X12126","value":"X12_126"},{"name":"X12127","value":"X12_127"},{"name":"X12128","value":"X12_128"},{"name":"X12129","value":"X12_129"},{"name":"X12130","value":"X12_130"},{"name":"X12131","value":"X12_131"},{"name":"X12132","value":"X12_132"},{"name":"X12133","value":"X12_133"},{"name":"X12135","value":"X12_135"},{"name":"X12138","value":"X12_138"},{"name":"X12139","value":"X12_139"},{"name":"X12140","value":"X12_140"},{"name":"X12141","value":"X12_141"},{"name":"X12142","value":"X12_142"},{"name":"X12143","value":"X12_143"},{"name":"X12144","value":"X12_144"},{"name":"X12146","value":"X12_146"},{"name":"X12147","value":"X12_147"},{"name":"X12148","value":"X12_148"},{"name":"X12149","value":"X12_149"},{"name":"X12150","value":"X12_150"},{"name":"X12151","value":"X12_151"},{"name":"X12152","value":"X12_152"},{"name":"X12153","value":"X12_153"},{"name":"X12154","value":"X12_154"},{"name":"X12155","value":"X12_155"},{"name":"X12157","value":"X12_157"},{"name":"X12158","value":"X12_158"},{"name":"X12159","value":"X12_159"},{"name":"X12160","value":"X12_160"},{"name":"X12161","value":"X12_161"},{"name":"X12163","value":"X12_163"},{"name":"X12170","value":"X12_170"},{"name":"X12175","value":"X12_175"},{"name":"X12176","value":"X12_176"},{"name":"X12179","value":"X12_179"},{"name":"X12180","value":"X12_180"},{"name":"X12185","value":"X12_185"},{"name":"X12186","value":"X12_186"},{"name":"X12187","value":"X12_187"},{"name":"X12188","value":"X12_188"},{"name":"X12189","value":"X12_189"},{"name":"X12190","value":"X12_190"},{"name":"X12191","value":"X12_191"},{"name":"X12194","value":"X12_194"},{"name":"X12195","value":"X12_195"},{"name":"X12196","value":"X12_196"},{"name":"X12197","value":"X12_197"},{"name":"X12198","value":"X12_198"},{"name":"X12199","value":"X12_199"},{"name":"X12200","value":"X12_200"},{"name":"X12201","value":"X12_201"},{"name":"X12202","value":"X12_202"},{"name":"X12203","value":"X12_203"},{"name":"X12204","value":"X12_204"},{"name":"X12205","value":"X12_205"},{"name":"X12206","value":"X12_206"},{"name":"X12210","value":"X12_210"},{"name":"X12211","value":"X12_211"},{"name":"X12212","value":"X12_212"},{"name":"X12213","value":"X12_213"},{"name":"X12214","value":"X12_214"},{"name":"X12215","value":"X12_215"},{"name":"X12216","value":"X12_216"},{"name":"X12217","value":"X12_217"},{"name":"X12218","value":"X12_218"},{"name":"X12219","value":"X12_219"},{"name":"X12220","value":"X12_220"},{"name":"X12222","value":"X12_222"},{"name":"X12223","value":"X12_223"},{"name":"X12224","value":"X12_224"},{"name":"X12225","value":"X12_225"},{"name":"X12227","value":"X12_227"},{"name":"X12228","value":"X12_228"},{"name":"X12240","value":"X12_240"},{"name":"X12242","value":"X12_242"},{"name":"X12244","value":"X12_244"},{"name":"X12245","value":"X12_245"},{"name":"X12248","value":"X12_248"},{"name":"X12249","value":"X12_249"},{"name":"X12250","value":"X12_250"},{"name":"X12251","value":"X12_251"},{"name":"X12252","value":"X12_252"},{"name":"X12255","value":"X12_255"},{"name":"X12256","value":"X12_256"},{"name":"X12259","value":"X12_259"},{"name":"X12260","value":"X12_260"},{"name":"X12261","value":"X12_261"},{"name":"X12262","value":"X12_262"},{"name":"X12263","value":"X12_263"},{"name":"X12264","value":"X12_264"},{"name":"X12265","value":"X12_265"},{"name":"X12266","value":"X12_266"},{"name":"X12267","value":"X12_267"},{"name":"X12268","value":"X12_268"},{"name":"X12269","value":"X12_269"},{"name":"X12270","value":"X12_270"},{"name":"X12271","value":"X12_271"},{"name":"X12272","value":"X12_272"},{"name":"X12273","value":"X12_273"},{"name":"X12274","value":"X12_274"},{"name":"X12275","value":"X12_275"},{"name":"X12276","value":"X12_276"},{"name":"X12277","value":"X12_277"},{"name":"X12278","value":"X12_278"},{"name":"X12280","value":"X12_280"},{"name":"X12283","value":"X12_283"},{"name":"X12284","value":"X12_284"},{"name":"X12285","value":"X12_285"},{"name":"X12286","value":"X12_286"},{"name":"X12288","value":"X12_288"},{"name":"X12290","value":"X12_290"},{"name":"X12300","value":"X12_300"},{"name":"X12301","value":"X12_301"},{"name":"X12303","value":"X12_303"},{"name":"X12304","value":"X12_304"},{"name":"X12309","value":"X12_309"},{"name":"X12310","value":"X12_310"},{"name":"X12311","value":"X12_311"},{"name":"X12312","value":"X12_312"},{"name":"X12313","value":"X12_313"},{"name":"X12315","value":"X12_315"},{"name":"X12317","value":"X12_317"},{"name":"X12319","value":"X12_319"},{"name":"X12322","value":"X12_322"},{"name":"X12323","value":"X12_323"},{"name":"X12324","value":"X12_324"},{"name":"X12325","value":"X12_325"},{"name":"X12326","value":"X12_326"},{"name":"X12350","value":"X12_350"},{"name":"X12352","value":"X12_352"},{"name":"X12353","value":"X12_353"},{"name":"X12354","value":"X12_354"},{"name":"X12355","value":"X12_355"},{"name":"X12356","value":"X12_356"},{"name":"X12357","value":"X12_357"},{"name":"X12358","value":"X12_358"},{"name":"X12361","value":"X12_361"},{"name":"X12362","value":"X12_362"},{"name":"X12404","value":"X12_404"},{"name":"X12410","value":"X12_410"},{"name":"X12412","value":"X12_412"},{"name":"X12414","value":"X12_414"},{"name":"X12417","value":"X12_417"},{"name":"X12418","value":"X12_418"},{"name":"X12419","value":"X12_419"},{"name":"X12420","value":"X12_420"},{"name":"X12421","value":"X12_421"},{"name":"X12422","value":"X12_422"},{"name":"X12423","value":"X12_423"},{"name":"X12424","value":"X12_424"},{"name":"X12425","value":"X12_425"},{"name":"X12426","value":"X12_426"},{"name":"X12429","value":"X12_429"},{"name":"X12431","value":"X12_431"},{"name":"X12432","value":"X12_432"},{"name":"X12433","value":"X12_433"},{"name":"X12434","value":"X12_434"},{"name":"X12435","value":"X12_435"},{"name":"X12436","value":"X12_436"},{"name":"X12437","value":"X12_437"},{"name":"X12440","value":"X12_440"},{"name":"X12451","value":"X12_451"},{"name":"X12452","value":"X12_452"},{"name":"X12453","value":"X12_453"},{"name":"X12455","value":"X12_455"},{"name":"X12456","value":"X12_456"},{"name":"X12460","value":"X12_460"},{"name":"X12463","value":"X12_463"},{"name":"X12466","value":"X12_466"},{"name":"X12468","value":"X12_468"},{"name":"X12470","value":"X12_470"},{"name":"X12475","value":"X12_475"},{"name":"X12485","value":"X12_485"},{"name":"X12486","value":"X12_486"},{"name":"X12490","value":"X12_490"},{"name":"X12492","value":"X12_492"},{"name":"X12494","value":"X12_494"},{"name":"X12500","value":"X12_500"},{"name":"X12501","value":"X12_501"},{"name":"X12503","value":"X12_503"},{"name":"X12504","value":"X12_504"},{"name":"X12511","value":"X12_511"},{"name":"X12517","value":"X12_517"},{"name":"X12521","value":"X12_521"},{"name":"X12527","value":"X12_527"},{"name":"X12536","value":"X12_536"},{"name":"X12540","value":"X12_540"},{"name":"X12561","value":"X12_561"},{"name":"X12567","value":"X12_567"},{"name":"X12568","value":"X12_568"},{"name":"X12601","value":"X12_601"},{"name":"X12602","value":"X12_602"},{"name":"X12620","value":"X12_620"},{"name":"X12625","value":"X12_625"},{"name":"X12650","value":"X12_650"},{"name":"X12715","value":"X12_715"},{"name":"X12753","value":"X12_753"},{"name":"X12754","value":"X12_754"},{"name":"X12805","value":"X12_805"},{"name":"X12806","value":"X12_806"},{"name":"X12810","value":"X12_810"},{"name":"X12811","value":"X12_811"},{"name":"X12812","value":"X12_812"},{"name":"X12813","value":"X12_813"},{"name":"X12814","value":"X12_814"},{"name":"X12815","value":"X12_815"},{"name":"X12816","value":"X12_816"},{"name":"X12818","value":"X12_818"},{"name":"X12819","value":"X12_819"},{"name":"X12820","value":"X12_820"},{"name":"X12821","value":"X12_821"},{"name":"X12822","value":"X12_822"},{"name":"X12823","value":"X12_823"},{"name":"X12824","value":"X12_824"},{"name":"X12826","value":"X12_826"},{"name":"X12827","value":"X12_827"},{"name":"X12828","value":"X12_828"},{"name":"X12829","value":"X12_829"},{"name":"X12830","value":"X12_830"},{"name":"X12831","value":"X12_831"},{"name":"X12832","value":"X12_832"},{"name":"X12833","value":"X12_833"},{"name":"X12834","value":"X12_834"},{"name":"X12835","value":"X12_835"},{"name":"X12836","value":"X12_836"},{"name":"X12837","value":"X12_837"},{"name":"X12838","value":"X12_838"},{"name":"X12839","value":"X12_839"},{"name":"X12840","value":"X12_840"},{"name":"X12841","value":"X12_841"},{"name":"X12842","value":"X12_842"},{"name":"X12843","value":"X12_843"},{"name":"X12844","value":"X12_844"},{"name":"X12845","value":"X12_845"},{"name":"X12846","value":"X12_846"},{"name":"X12847","value":"X12_847"},{"name":"X12848","value":"X12_848"},{"name":"X12849","value":"X12_849"},{"name":"X12850","value":"X12_850"},{"name":"X12851","value":"X12_851"},{"name":"X12852","value":"X12_852"},{"name":"X12853","value":"X12_853"},{"name":"X12854","value":"X12_854"},{"name":"X12855","value":"X12_855"},{"name":"X12856","value":"X12_856"},{"name":"X12857","value":"X12_857"},{"name":"X12858","value":"X12_858"},{"name":"X12859","value":"X12_859"},{"name":"X12860","value":"X12_860"},{"name":"X12861","value":"X12_861"},{"name":"X12862","value":"X12_862"},{"name":"X12863","value":"X12_863"},{"name":"X12864","value":"X12_864"},{"name":"X12865","value":"X12_865"},{"name":"X12866","value":"X12_866"},{"name":"X12867","value":"X12_867"},{"name":"X12868","value":"X12_868"},{"name":"X12869","value":"X12_869"},{"name":"X12870","value":"X12_870"},{"name":"X12871","value":"X12_871"},{"name":"X12872","value":"X12_872"},{"name":"X12873","value":"X12_873"},{"name":"X12874","value":"X12_874"},{"name":"X12875","value":"X12_875"},{"name":"X12876","value":"X12_876"},{"name":"X12877","value":"X12_877"},{"name":"X12878","value":"X12_878"},{"name":"X12879","value":"X12_879"},{"name":"X12880","value":"X12_880"},{"name":"X12881","value":"X12_881"},{"name":"X12882","value":"X12_882"},{"name":"X12883","value":"X12_883"},{"name":"X12884","value":"X12_884"},{"name":"X12885","value":"X12_885"},{"name":"X12886","value":"X12_886"},{"name":"X12887","value":"X12_887"},{"name":"X12888","value":"X12_888"},{"name":"X12889","value":"X12_889"},{"name":"X12891","value":"X12_891"},{"name":"X12893","value":"X12_893"},{"name":"X12894","value":"X12_894"},{"name":"X12895","value":"X12_895"},{"name":"X12896","value":"X12_896"},{"name":"X12920","value":"X12_920"},{"name":"X12924","value":"X12_924"},{"name":"X12925","value":"X12_925"},{"name":"X12926","value":"X12_926"},{"name":"X12928","value":"X12_928"},{"name":"X12940","value":"X12_940"},{"name":"X12943","value":"X12_943"},{"name":"X12944","value":"X12_944"},{"name":"X12945","value":"X12_945"},{"name":"X12947","value":"X12_947"},{"name":"X12980","value":"X12_980"},{"name":"X12990","value":"X12_990"},{"name":"X12993","value":"X12_993"},{"name":"X12996","value":"X12_996"},{"name":"X12997","value":"X12_997"},{"name":"X12998","value":"X12_998"},{"name":"X12999","value":"X12_999"},{"name":"X12270x279","value":"X12_270_X279"},{"name":"X12271x279","value":"X12_271_X279"},{"name":"X12275x210","value":"X12_275_X210"},{"name":"X12275x211","value":"X12_275_X211"},{"name":"X12276x212","value":"X12_276_X212"},{"name":"X12277x212","value":"X12_277_X212"},{"name":"X12277x214","value":"X12_277_X214"},{"name":"X12277x364","value":"X12_277_X364"},{"name":"X12278x217","value":"X12_278_X217"},{"name":"X12820x218","value":"X12_820_X218"},{"name":"X12820x306","value":"X12_820_X306"},{"name":"X12824x186","value":"X12_824_X186"},{"name":"X12834x220","value":"X12_834_X220"},{"name":"X12834x307","value":"X12_834_X307"},{"name":"X12834x318","value":"X12_834_X318"},{"name":"X12835x221","value":"X12_835_X221"},{"name":"X12837x222","value":"X12_837_X222"},{"name":"X12837x223","value":"X12_837_X223"},{"name":"X12837x224","value":"X12_837_X224"},{"name":"X12837x291","value":"X12_837_X291"},{"name":"X12837x292","value":"X12_837_X292"},{"name":"X12837x298","value":"X12_837_X298"},{"name":"X12999x231","value":"X12_999_X231"}]},"aws-native:b2bi:TransformerX12ValidationOptions":{"properties":{"validationRules":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:b2bi:TransformerX12ValidationRule0Properties"},{"$ref":"#/types/aws-native:b2bi:TransformerX12ValidationRule1Properties"},{"$ref":"#/types/aws-native:b2bi:TransformerX12ValidationRule2Properties"}]},"description":"Specifies a list of validation rules to apply during EDI document processing. These rules can include code list modifications, element length constraints, and element requirement changes."}},"type":"object"},"aws-native:b2bi:TransformerX12ValidationRule0Properties":{"properties":{"codeListValidationRule":{"$ref":"#/types/aws-native:b2bi:TransformerX12CodeListValidationRule"}},"type":"object","required":["codeListValidationRule"]},"aws-native:b2bi:TransformerX12ValidationRule1Properties":{"properties":{"elementLengthValidationRule":{"$ref":"#/types/aws-native:b2bi:TransformerX12ElementLengthValidationRule"}},"type":"object","required":["elementLengthValidationRule"]},"aws-native:b2bi:TransformerX12ValidationRule2Properties":{"properties":{"elementRequirementValidationRule":{"$ref":"#/types/aws-native:b2bi:TransformerX12ElementRequirementValidationRule"}},"type":"object","required":["elementRequirementValidationRule"]},"aws-native:b2bi:TransformerX12Version":{"type":"string","enum":[{"name":"Version4010","value":"VERSION_4010"},{"name":"Version4030","value":"VERSION_4030"},{"name":"Version4050","value":"VERSION_4050"},{"name":"Version4060","value":"VERSION_4060"},{"name":"Version5010","value":"VERSION_5010"},{"name":"Version5010Hipaa","value":"VERSION_5010_HIPAA"}]},"aws-native:backup:BackupPlanAdvancedBackupSettingResourceType":{"properties":{"backupOptions":{"$ref":"pulumi.json#/Any","description":"The backup option for the resource. Each option is a key-value pair. This option is only available for Windows VSS backup jobs.\n\nValid values:\n\nSet to `\"WindowsVSS\":\"enabled\"` to enable the `WindowsVSS` backup option and create a Windows VSS backup.\n\nSet to `\"WindowsVSS\":\"disabled\"` to create a regular backup. The `WindowsVSS` option is not enabled by default.\n\nIf you specify an invalid option, you get an `InvalidParameterValueException` exception.\n\nFor more information about Windows VSS backups, see [Creating a VSS-Enabled Windows Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html) ."},"resourceType":{"type":"string","description":"The name of a resource type. The only supported resource type is EC2."}},"type":"object","required":["backupOptions","resourceType"]},"aws-native:backup:BackupPlanBackupRuleResourceType":{"properties":{"completionWindowMinutes":{"type":"number","description":"A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup ."},"copyActions":{"type":"array","items":{"$ref":"#/types/aws-native:backup:BackupPlanCopyActionResourceType"},"description":"An array of CopyAction objects, which contains the details of the copy operation."},"enableContinuousBackup":{"type":"boolean","description":"Enables continuous backup and point-in-time restores (PITR)."},"indexActions":{"type":"array","items":{"$ref":"#/types/aws-native:backup:BackupPlanIndexActionsResourceType"},"description":"There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.\n\nWithin the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values:\n\n- `EBS` for Amazon Elastic Block Store\n- `S3` for Amazon Simple Storage Service (Amazon S3)"},"lifecycle":{"$ref":"#/types/aws-native:backup:BackupPlanLifecycleResourceType","description":"The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define."},"recoveryPointTags":{"type":"object","additionalProperties":{"type":"string"},"description":"The tags to assign to the resources."},"ruleName":{"type":"string","description":"A display name for a backup rule."},"scanActions":{"type":"array","items":{"$ref":"#/types/aws-native:backup:BackupPlanScanActionResourceType"}},"scheduleExpression":{"type":"string","description":"A CRON expression specifying when AWS Backup initiates a backup job."},"scheduleExpressionTimezone":{"type":"string","description":"This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone."},"startWindowMinutes":{"type":"number","description":"An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.\n\nIf this value is included, it must be at least 60 minutes to avoid errors."},"targetBackupVault":{"type":"string","description":"The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of letters, numbers, and hyphens."},"targetLogicallyAirGappedBackupVaultArn":{"type":"string","description":"The ARN of a logically air-gapped vault. ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault."}},"type":"object","required":["ruleName","targetBackupVault"]},"aws-native:backup:BackupPlanCopyActionResourceType":{"properties":{"destinationBackupVaultArn":{"type":"string","description":"An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.`"},"lifecycle":{"$ref":"#/types/aws-native:backup:BackupPlanLifecycleResourceType","description":"Defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, AWS Backup applies the lifecycle policy of the source backup to the destination backup.\n\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90 days."}},"type":"object","required":["destinationBackupVaultArn"]},"aws-native:backup:BackupPlanIndexActionsResourceType":{"properties":{"resourceTypes":{"type":"array","items":{"type":"string"},"description":"0 or 1 index action will be accepted for each BackupRule.\n\nValid values:\n\n- `EBS` for Amazon Elastic Block Store\n- `S3` for Amazon Simple Storage Service (Amazon S3)"}},"type":"object"},"aws-native:backup:BackupPlanLifecycleResourceType":{"properties":{"deleteAfterDays":{"type":"number","description":"The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in `MoveToColdStorageAfterDays` ."},"moveToColdStorageAfterDays":{"type":"number","description":"The number of days after creation that a recovery point is moved to cold storage."},"optInToArchiveForSupportedResources":{"type":"boolean","description":"If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings."}},"type":"object"},"aws-native:backup:BackupPlanMalwareScanner":{"type":"string","enum":[{"name":"Guardduty","value":"GUARDDUTY"}]},"aws-native:backup:BackupPlanResourceType":{"properties":{"advancedBackupSettings":{"type":"array","items":{"$ref":"#/types/aws-native:backup:BackupPlanAdvancedBackupSettingResourceType"},"description":"A list of backup options for each resource type."},"backupPlanName":{"type":"string","description":"The display name of a backup plan."},"backupPlanRule":{"type":"array","items":{"$ref":"#/types/aws-native:backup:BackupPlanBackupRuleResourceType"},"description":"An array of `BackupRule` objects, each of which specifies a scheduled task that is used to back up a selection of resources."},"scanSettings":{"type":"array","items":{"$ref":"#/types/aws-native:backup:BackupPlanScanSettingResourceType"}}},"type":"object","required":["backupPlanName","backupPlanRule"]},"aws-native:backup:BackupPlanScanActionResourceType":{"properties":{"malwareScanner":{"$ref":"#/types/aws-native:backup:BackupPlanMalwareScanner"},"scanMode":{"$ref":"#/types/aws-native:backup:BackupPlanScanMode"}},"type":"object"},"aws-native:backup:BackupPlanScanMode":{"type":"string","enum":[{"name":"FullScan","value":"FULL_SCAN"},{"name":"IncrementalScan","value":"INCREMENTAL_SCAN"}]},"aws-native:backup:BackupPlanScanSettingResourceType":{"properties":{"malwareScanner":{"$ref":"#/types/aws-native:backup:BackupPlanMalwareScanner"},"resourceTypes":{"type":"array","items":{"type":"string"}},"scannerRoleArn":{"type":"string"}},"type":"object"},"aws-native:backup:BackupSelectionConditionParameter":{"properties":{"conditionKey":{"type":"string","description":"The key in a key-value pair. For example, in the tag `Department: Accounting` , `Department` is the key."},"conditionValue":{"type":"string","description":"The value in a key-value pair. For example, in the tag `Department: Accounting` , `Accounting` is the value."}},"type":"object"},"aws-native:backup:BackupSelectionConditionResourceType":{"properties":{"conditionKey":{"type":"string","description":"The key in a key-value pair. For example, in `\"Department\": \"accounting\"` , `\"Department\"` is the key."},"conditionType":{"type":"string","description":"An operation, such as `STRINGEQUALS` , that is applied to a key-value pair used to filter resources in a selection."},"conditionValue":{"type":"string","description":"The value in a key-value pair. For example, in `\"Department\": \"accounting\"` , `\"accounting\"` is the value."}},"type":"object","required":["conditionKey","conditionType","conditionValue"]},"aws-native:backup:BackupSelectionResourceType":{"properties":{"conditions":{"$ref":"#/types/aws-native:backup:BackupSelectionResourceTypeConditionsProperties","description":"A list of conditions that you define to assign resources to your backup plans using tags. For example, `\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\", \"ConditionValue\": \"true\" },` . Condition operators are case sensitive.\n\n`Conditions` differs from `ListOfTags` as follows:\n\n- When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).\n- `Conditions` supports `StringEquals` , `StringLike` , `StringNotEquals` , and `StringNotLike` . `ListOfTags` only supports `StringEquals` ."},"iamRoleArn":{"type":"string","description":"The ARN of the IAM role that AWS Backup uses to authenticate when backing up the target resource; for example, `arn:aws:iam::123456789012:role/S3Access` ."},"listOfTags":{"type":"array","items":{"$ref":"#/types/aws-native:backup:BackupSelectionConditionResourceType"},"description":"A list of conditions that you define to assign resources to your backup plans using tags. For example, `\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\", \"ConditionValue\": \"true\" },` . Condition operators are case sensitive.\n\n`ListOfTags` differs from `Conditions` as follows:\n\n- When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).\n- `ListOfTags` only supports `StringEquals` . `Conditions` supports `StringEquals` , `StringLike` , `StringNotEquals` , and `StringNotLike` ."},"notResources":{"type":"array","items":{"type":"string"},"description":"A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.\n\nIf you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags."},"resources":{"type":"array","items":{"type":"string"},"description":"An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan."},"selectionName":{"type":"string","description":"The display name of a resource selection document."}},"type":"object","required":["iamRoleArn","selectionName"]},"aws-native:backup:BackupSelectionResourceTypeConditionsProperties":{"description":"A list of conditions that you define to assign resources to your backup plans using tags. For example, `\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\", \"ConditionValue\": \"true\" },` . Condition operators are case sensitive.\n\n`Conditions` differs from `ListOfTags` as follows:\n\n- When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).\n- `Conditions` supports `StringEquals` , `StringLike` , `StringNotEquals` , and `StringNotLike` . `ListOfTags` only supports `StringEquals` .","properties":{"stringEquals":{"type":"array","items":{"$ref":"#/types/aws-native:backup:BackupSelectionConditionParameter"}},"stringLike":{"type":"array","items":{"$ref":"#/types/aws-native:backup:BackupSelectionConditionParameter"}},"stringNotEquals":{"type":"array","items":{"$ref":"#/types/aws-native:backup:BackupSelectionConditionParameter"}},"stringNotLike":{"type":"array","items":{"$ref":"#/types/aws-native:backup:BackupSelectionConditionParameter"}}},"type":"object"},"aws-native:backup:BackupVaultLockConfigurationType":{"properties":{"changeableForDays":{"type":"integer","description":"The AWS Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting `ChangeableForDays` to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.\n\nAWS Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you must set `ChangeableForDays` to 3 or greater.\n\nBefore the lock date, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration` . On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.\n\nIf this parameter is not specified, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration` at any time."},"maxRetentionDays":{"type":"integer","description":"The AWS Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).\n\nIf this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.\n\nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already saved in the vault prior to Vault Lock are not affected."},"minRetentionDays":{"type":"integer","description":"The AWS Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).\n\nIf this parameter is not specified, Vault Lock will not enforce a minimum retention period.\n\nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already saved in the vault prior to Vault Lock are not affected."}},"type":"object","required":["minRetentionDays"]},"aws-native:backup:BackupVaultNotificationObjectType":{"properties":{"backupVaultEvents":{"type":"array","items":{"type":"string"},"description":"An array of events that indicate the status of jobs to back up resources to the backup vault. For valid events, see [BackupVaultEvents](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_PutBackupVaultNotifications.html#API_PutBackupVaultNotifications_RequestSyntax) in the *AWS Backup API Guide* ."},"snsTopicArn":{"type":"string","description":"An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, `arn:aws:sns:us-west-2:111122223333:MyTopic` ."}},"type":"object","required":["backupVaultEvents","snsTopicArn"]},"aws-native:backup:FrameworkControl":{"properties":{"controlInputParameters":{"type":"array","items":{"$ref":"#/types/aws-native:backup:FrameworkControlInputParameter"},"description":"A list of ParameterName and ParameterValue pairs."},"controlName":{"type":"string","description":"The name of a control. This name is between 1 and 256 characters."},"controlScope":{"$ref":"#/types/aws-native:backup:FrameworkControlControlScopeProperties","description":"The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans."}},"type":"object","required":["controlName"]},"aws-native:backup:FrameworkControlControlScopeProperties":{"description":"The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.","properties":{"complianceResourceIds":{"type":"array","items":{"type":"string"},"description":"The ID of the only AWS resource that you want your control scope to contain."},"complianceResourceTypes":{"type":"array","items":{"type":"string"},"description":"Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:backup:FrameworkTag"},"description":"Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair."}},"type":"object"},"aws-native:backup:FrameworkControlInputParameter":{"properties":{"parameterName":{"type":"string","description":"The name of a parameter, for example, `BackupPlanFrequency` ."},"parameterValue":{"type":"string","description":"The value of parameter, for example, `hourly` ."}},"type":"object","required":["parameterName","parameterValue"]},"aws-native:backup:FrameworkTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object"},"aws-native:backup:LogicallyAirGappedBackupVaultNotificationObjectType":{"properties":{"backupVaultEvents":{"type":"array","items":{"type":"string"},"description":"An array of events that indicate the status of jobs to back up resources to the backup vault."},"snsTopicArn":{"type":"string","description":"The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, `arn:aws:sns:us-west-2:111122223333:MyVaultTopic` ."}},"type":"object","required":["backupVaultEvents","snsTopicArn"]},"aws-native:backup:ReportDeliveryChannelProperties":{"description":"A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.","properties":{"formats":{"type":"array","items":{"type":"string"},"description":"A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV."},"s3BucketName":{"type":"string","description":"The unique name of the S3 bucket that receives your reports."},"s3KeyPrefix":{"type":"string","description":"The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix."}},"type":"object","required":["s3BucketName"]},"aws-native:backup:ReportPlanTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object"},"aws-native:backup:ReportSettingProperties":{"description":"Identifies the report template for the report. Reports are built using a report template.","properties":{"accounts":{"type":"array","items":{"type":"string"},"description":"The list of AWS accounts that a report covers."},"frameworkArns":{"type":"array","items":{"type":"string"},"description":"The Amazon Resource Names (ARNs) of the frameworks a report covers."},"organizationUnits":{"type":"array","items":{"type":"string"},"description":"The list of AWS organization units that a report covers."},"regions":{"type":"array","items":{"type":"string"},"description":"The list of AWS regions that a report covers."},"reportTemplate":{"type":"string","description":"Identifies the report template for the report. Reports are built using a report template. The report templates are: `BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`"}},"type":"object","required":["reportTemplate"]},"aws-native:backup:RestoreTestingPlanRestoreTestingRecoveryPointSelection":{"properties":{"algorithm":{"$ref":"#/types/aws-native:backup:RestoreTestingPlanRestoreTestingRecoveryPointSelectionAlgorithm","description":"Acceptable values include \"LATEST_WITHIN_WINDOW\" or \"RANDOM_WITHIN_WINDOW\""},"excludeVaults":{"type":"array","items":{"type":"string"},"description":"Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed."},"includeVaults":{"type":"array","items":{"type":"string"},"description":"Accepted values include wildcard [\"*\"] or by specific ARNs or ARN wilcard replacement [\"arn:aws:backup:us-west-2:123456789012:backup-vault:asdf\", ...] [\"arn:aws:backup:*:*:backup-vault:asdf-*\", ...]"},"recoveryPointTypes":{"type":"array","items":{"$ref":"#/types/aws-native:backup:RestoreTestingPlanRestoreTestingRecoveryPointType"},"description":"These are the types of recovery points.\n\nInclude `SNAPSHOT` to restore only snapshot recovery points; include `CONTINUOUS` to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for `Algorithm` ."},"selectionWindowDays":{"type":"integer","description":"Accepted values are integers from 1 to 365."}},"type":"object","required":["algorithm","includeVaults","recoveryPointTypes"]},"aws-native:backup:RestoreTestingPlanRestoreTestingRecoveryPointSelectionAlgorithm":{"type":"string","enum":[{"name":"LatestWithinWindow","value":"LATEST_WITHIN_WINDOW"},{"name":"RandomWithinWindow","value":"RANDOM_WITHIN_WINDOW"}]},"aws-native:backup:RestoreTestingPlanRestoreTestingRecoveryPointType":{"type":"string","enum":[{"name":"Snapshot","value":"SNAPSHOT"},{"name":"Continuous","value":"CONTINUOUS"}]},"aws-native:backup:RestoreTestingPlanTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:backup:RestoreTestingSelectionKeyValue":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:backup:RestoreTestingSelectionProtectedResourceConditions":{"properties":{"stringEquals":{"type":"array","items":{"$ref":"#/types/aws-native:backup:RestoreTestingSelectionKeyValue"},"description":"Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called \"exact matching.\""},"stringNotEquals":{"type":"array","items":{"$ref":"#/types/aws-native:backup:RestoreTestingSelectionKeyValue"},"description":"Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called \"negated matching.\""}},"type":"object"},"aws-native:backup:TieringConfigurationResourceSelection":{"properties":{"resourceType":{"type":"string"},"resources":{"type":"array","items":{"type":"string"}},"tieringDownSettingsInDays":{"type":"integer"}},"type":"object","required":["resourceType","resources","tieringDownSettingsInDays"]},"aws-native:backupgateway:HypervisorTag":{"properties":{"key":{"type":"string","description":"The key part of a tag's key-value pair. The key can't start with `aws:` ."},"value":{"type":"string","description":"The value part of a tag's key-value pair."}},"type":"object","required":["key","value"]},"aws-native:batch:ComputeEnvironmentComputeResources":{"properties":{"allocationStrategy":{"type":"string","description":"The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or [Amazon EC2 service limits](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) . For more information, see [Allocation strategies](https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html) in the *AWS Batch User Guide* .\n\nWhen updating a compute environment, changing the allocation strategy requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* . `BEST_FIT` is not supported when updating a compute environment.\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified. \n\n- **BEST_FIT (default)** - AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS Batch waits for the additional instances to be available. If there aren't enough instances available, or if the user is reaching [Amazon EC2 service limits](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with `BEST_FIT` then the Spot Fleet IAM role must be specified.\n- **BEST_FIT_PROGRESSIVE** - AWS Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.\n- **SPOT_CAPACITY_OPTIMIZED** - AWS Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.\n- **SPOT_PRICE_CAPACITY_OPTIMIZED** - The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. This allocation strategy is only available for Spot Instance compute resources.\n\n\u003e We recommend that you use `SPOT_PRICE_CAPACITY_OPTIMIZED` rather than `SPOT_CAPACITY_OPTIMIZED` in most instances.\n\nWith `BEST_FIT_PROGRESSIVE` , `SPOT_CAPACITY_OPTIMIZED` , and `SPOT_PRICE_CAPACITY_OPTIMIZED` allocation strategies using On-Demand or Spot Instances, and the `BEST_FIT` strategy using Spot Instances, AWS Batch might need to go above `maxvCpus` to meet your capacity requirements. In this event, AWS Batch never exceeds `maxvCpus` by more than a single instance."},"bidPercentage":{"type":"integer","description":"The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. For most use cases, we recommend leaving this field empty.\n\nWhen updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it."},"desiredvCpus":{"type":"integer","description":"The desired number of vCPUS in the compute environment. AWS Batch modifies this value between the minimum and maximum values based on job queue demand.\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. \u003e AWS Batch doesn't support changing the desired number of vCPUs of an existing compute environment. Don't specify this parameter for compute environments using Amazon EKS clusters. \u003e When you update the `desiredvCpus` setting, the value must be between the `minvCpus` and `maxvCpus` values.\n\u003e \n\u003e Additionally, the updated `desiredvCpus` value must be greater than or equal to the current `desiredvCpus` value. For more information, see [Troubleshooting AWS Batch](https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#error-desired-vcpus-update) in the *AWS Batch User Guide* ."},"ec2Configuration":{"type":"array","items":{"$ref":"#/types/aws-native:batch:ComputeEnvironmentEc2ConfigurationObject"},"description":"Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If `Ec2Configuration` isn't specified, the default is `ECS_AL2` .\n\nWhen updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* . To remove the Amazon EC2 configuration and any custom AMI ID specified in `imageIdOverride` , set this value to an empty string.\n\nOne or two values can be provided.\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it."},"ec2KeyPair":{"type":"string","description":"The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.\n\nWhen updating a compute environment, changing the Amazon EC2 key pair requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it."},"imageId":{"type":"string","description":"The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the `imageIdOverride` member of the `Ec2Configuration` structure. To remove the custom AMI ID and use the default AMI ID, set this value to an empty string.\n\nWhen updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. \u003e The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see [Amazon ECS-optimized Amazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) in the *Amazon Elastic Container Service Developer Guide* ."},"instanceRole":{"type":"string","description":"The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. Required for Amazon EC2 instances. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, `*ecsInstanceRole*` or `arn:aws:iam:: *\u003caws_account_id\u003e* :instance-profile/ *ecsInstanceRole*` . For more information, see [Amazon ECS instance role](https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) in the *AWS Batch User Guide* .\n\nWhen updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, `c5` or `p3` ), or you can specify specific sizes within a family (such as `c5.8xlarge` ).\n\nAWS Batch can select the instance type for you if you choose one of the following:\n\n- `optimal` to select instance types (from the `c4` , `m4` , `r4` , `c5` , `m5` , and `r5` instance families) that match the demand of your job queues.\n- `default_x86_64` to choose x86 based instance types (from the `m6i` , `c6i` , `r6i` , and `c7i` instance families) that matches the resource demands of the job queue.\n- `default_arm64` to choose x86 based instance types (from the `m6g` , `c6g` , `r6g` , and `c7g` instance families) that matches the resource demands of the job queue.\n\n\u003e Starting on 11/01/2025 the behavior of `optimal` is going to be changed to match `default_x86_64` . During the change your instance families could be updated to a newer generation. You do not need to perform any actions for the upgrade to happen. For more information about change, see [Optimal instance type configuration to receive automatic instance family updates](https://docs.aws.amazon.com/batch/latest/userguide/optimal-default-instance-troubleshooting.html) . \u003e Instance family availability varies by AWS Region . For example, some AWS Region s may not have any fourth generation instance families but have fifth and sixth generation instance families.\n\u003e \n\u003e When using `default_x86_64` or `default_arm64` instance bundles, AWS Batch selects instance families based on a balance of cost-effectiveness and performance. While newer generation instances often provide better price-performance, AWS Batch may choose an earlier generation instance family if it provides the optimal combination of availability, cost, and performance for your workload. For example, in an AWS Region where both c6i and c7i instances are available, AWS Batch might select c6i instances if they offer better cost-effectiveness for your specific job requirements. For more information on AWS Batch instance types and AWS Region availability, see [Instance type compute table](https://docs.aws.amazon.com/batch/latest/userguide/instance-type-compute-table.html) in the *AWS Batch User Guide* .\n\u003e \n\u003e AWS Batch periodically updates your instances in default bundles to newer, more cost-effective options. Updates happen automatically without requiring any action from you. Your workloads continue running during updates with no interruption \u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. \u003e When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment."},"launchTemplate":{"$ref":"#/types/aws-native:batch:ComputeEnvironmentLaunchTemplateSpecification","description":"The launch template to use for your compute resources. Any other compute resource parameters that you specify in a [CreateComputeEnvironment](https://docs.aws.amazon.com/batch/latest/APIReference/API_CreateComputeEnvironment.html) API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see [Launch Template Support](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html) in the ** . Removing the launch template from a compute environment will not remove the AMI specified in the launch template. In order to update the AMI specified in a launch template, the `updateToLatestImageVersion` parameter must be set to `true` .\n\nWhen updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the ** .\n\n\u003e This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified."},"maxvCpus":{"type":"integer","description":"The maximum number of Amazon EC2 vCPUs that an environment can reach.\n\n\u003e With `BEST_FIT_PROGRESSIVE` , `SPOT_CAPACITY_OPTIMIZED` and `SPOT_PRICE_CAPACITY_OPTIMIZED` (recommended) strategies using On-Demand or Spot Instances, and the `BEST_FIT` strategy using Spot Instances, AWS Batch might need to exceed `maxvCpus` to meet your capacity requirements. In this event, AWS Batch never exceeds `maxvCpus` by more than a single instance."},"minvCpus":{"type":"integer","description":"The minimum number of vCPUs that an environment should maintain (even if the compute environment is `DISABLED` ).\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it."},"placementGroup":{"type":"string","description":"The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances* .\n\nWhen updating a compute environment, changing the placement group requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it."},"scalingPolicy":{"$ref":"#/types/aws-native:batch:ComputeEnvironmentComputeScalingPolicy"},"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The Amazon EC2 security groups that are associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For Amazon EC2 compute resources, providing an empty list removes the security groups from the compute resource.\n\nWhen updating a compute environment, changing the Amazon EC2 security groups requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* ."},"spotIamFleetRole":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a `SPOT` compute environment. This role is required if the allocation strategy set to `BEST_FIT` or if the allocation strategy isn't specified. For more information, see [Amazon EC2 spot fleet role](https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) in the *AWS Batch User Guide* .\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. \u003e To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer *AmazonEC2SpotFleetTaggingRole* managed policy. The previously recommended *AmazonEC2SpotFleetRole* managed policy doesn't have the required permissions to tag Spot Instances. For more information, see [Spot instances not tagged on creation](https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#spot-instance-no-tag) in the *AWS Batch User Guide* .","replaceOnChanges":true},"subnets":{"type":"array","items":{"type":"string"},"description":"The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16 subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn't specified and no change is made. For Amazon EC2 compute resources, providing an empty list removes the VPC subnets from the compute resource. For more information, see [VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) in the *Amazon VPC User Guide* .\n\nWhen updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\n\u003e AWS Batch on Amazon EC2 and AWS Batch on Amazon EKS support Local Zones. For more information, see [Local Zones](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones) in the *Amazon EC2 User Guide for Linux Instances* , [Amazon EKS and AWS Local Zones](https://docs.aws.amazon.com/eks/latest/userguide/local-zones.html) in the *Amazon EKS User Guide* and [Amazon ECS clusters in Local Zones, Wavelength Zones, and AWS Outposts](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-regions-zones.html#clusters-local-zones) in the *Amazon ECS Developer Guide* .\n\u003e \n\u003e AWS Batch on Fargate doesn't currently support Local Zones."},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"A key-value pair to associate with a resource."},"type":{"type":"string","description":"The type of compute environment: `EC2` , `SPOT` , `FARGATE` , or `FARGATE_SPOT` . For more information, see [Compute environments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) in the *AWS Batch User Guide* .\n\nIf you choose `SPOT` , you must also specify an Amazon EC2 Spot Fleet role with the `spotIamFleetRole` parameter. For more information, see [Amazon EC2 spot fleet role](https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html) in the *AWS Batch User Guide* .\n\nWhen updating compute environment, changing the type of a compute environment requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* .\n\nWhen updating the type of a compute environment, changing between `EC2` and `SPOT` or between `FARGATE` and `FARGATE_SPOT` will initiate an infrastructure update, but if you switch between `EC2` and `FARGATE` , CloudFormation will create a new compute environment."},"updateToLatestImageVersion":{"type":"boolean","description":"Specifies whether the AMI ID is updated to the latest one that's supported by AWS Batch when the compute environment has an infrastructure update. The default value is `false` .\n\n\u003e An AMI ID can either be specified in the `imageId` or `imageIdOverride` parameters or be determined by the launch template that's specified in the `launchTemplate` parameter. If an AMI ID is specified any of these ways, this parameter is ignored. For more information about to update AMI IDs during an infrastructure update, see [Updating the AMI ID](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html#updating-compute-environments-ami) in the *AWS Batch User Guide* . \n\nWhen updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* ."}},"type":"object","required":["maxvCpus","subnets","type"]},"aws-native:batch:ComputeEnvironmentComputeScalingPolicy":{"properties":{"minScaleDownDelayMinutes":{"type":"integer"}},"type":"object"},"aws-native:batch:ComputeEnvironmentEc2ConfigurationObject":{"properties":{"imageIdOverride":{"type":"string","description":"The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the `imageId` set in the `computeResource` object.\n\n\u003e The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see [Amazon ECS-optimized Amazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) in the *Amazon Elastic Container Service Developer Guide* ."},"imageKubernetesVersion":{"type":"string","description":"The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used."},"imageType":{"type":"string","description":"The image type to match with the instance type to select an AMI. The supported values are different for `ECS` and `EKS` resources.\n\n- **ECS** - If the `imageIdOverride` parameter isn't specified, then a recent [Amazon ECS-optimized Amazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) ( `ECS_AL2` ) is used. If a new image type is specified in an update, but neither an `imageId` nor a `imageIdOverride` parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by AWS Batch is used.\n\n\u003e AWS will end support for Amazon ECS optimized AL2-optimized and AL2-accelerated AMIs. Starting in January 2026, AWS Batch will change the default AMI for new Amazon ECS compute environments from Amazon Linux 2 to Amazon Linux 2023. We recommend migrating AWS Batch Amazon ECS compute environments to Amazon Linux 2023 to maintain optimal performance and security. For more information on upgrading from AL2 to AL2023, see [How to migrate from ECS AL2 to ECS AL2023](https://docs.aws.amazon.com/batch/latest/userguide/ecs-migration-2023.html) in the *AWS Batch User Guide* . \n\n- **ECS_AL2** - [Amazon Linux 2](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) : Default for all non-GPU instance families.\n- **ECS_AL2_NVIDIA** - [Amazon Linux 2 (GPU)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami) : Default for all GPU instance families (for example `P4` and `G4` ) and can be used for all non AWS Graviton-based instance types.\n- **ECS_AL2023** - [Amazon Linux 2023](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) : AWS Batch supports Amazon Linux 2023.\n\n\u003e Amazon Linux 2023 does not support `A1` instances.\n- **ECS_AL2023_NVIDIA** - [Amazon Linux 2023 (GPU)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami) : For all GPU instance families and can be used for all non AWS Graviton-based instance types.\n\n\u003e ECS_AL2023_NVIDIA doesn't support `p3` and `g3` instance types.\n- **EKS** - If the `imageIdOverride` parameter isn't specified, then a recent [Amazon EKS-optimized Amazon Linux 2023 AMI](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) ( `EKS_AL2023` ) is used. If a new image type is specified in an update, but neither an `imageId` nor a `imageIdOverride` parameter is specified, then the latest Amazon EKS optimized AMI for that image type that AWS Batch supports is used.\n\n\u003e Amazon Linux 2023 AMIs are the default on AWS Batch for Amazon EKS.\n\u003e \n\u003e AWS will end support for Amazon EKS AL2-optimized and AL2-accelerated AMIs, starting 11/26/25. You can continue using AWS Batch -provided Amazon EKS optimized Amazon Linux 2 AMIs on your Amazon EKS compute environments beyond the 11/26/25 end-of-support date, these compute environments will no longer receive any new software updates, security patches, or bug fixes from AWS . For more information on upgrading from AL2 to AL2023, see [How to upgrade from EKS AL2 to EKS AL2023](https://docs.aws.amazon.com/batch/latest/userguide/eks-migration-2023.html) in the *AWS Batch User Guide* . \n\n- **EKS_AL2** - [Amazon Linux 2](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) : Used for non-GPU instance families.\n- **EKS_AL2_NVIDIA** - [Amazon Linux 2 (accelerated)](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) : Used for GPU instance families (for example, `P4` and `G4` ) and can be used for all non AWS Graviton-based instance types.\n- **EKS_AL2023** - [Amazon Linux 2023](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) : Default for non-GPU instance families.\n\n\u003e Amazon Linux 2023 does not support `A1` instances.\n- **EKS_AL2023_NVIDIA** - [Amazon Linux 2023 (accelerated)](https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html) : Default for GPU instance families and can be used for all non AWS Graviton-based instance types."}},"type":"object","required":["imageType"]},"aws-native:batch:ComputeEnvironmentEksConfiguration":{"properties":{"eksClusterArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is `arn: *aws* :eks: *us-east-1* : *123456789012* :cluster/ *ClusterForBatch*` ."},"kubernetesNamespace":{"type":"string","description":"The namespace of the Amazon EKS cluster. AWS Batch manages pods in this namespace. The value can't left empty or null. It must be fewer than 64 characters long, can't be set to `default` , can't start with \" `kube-` ,\" and must match this regular expression: `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$` . For more information, see [Namespaces](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) in the Kubernetes documentation."}},"type":"object","required":["eksClusterArn","kubernetesNamespace"]},"aws-native:batch:ComputeEnvironmentLaunchTemplateSpecification":{"properties":{"launchTemplateId":{"type":"string","description":"The ID of the launch template."},"launchTemplateName":{"type":"string","description":"The name of the launch template."},"overrides":{"type":"array","items":{"$ref":"#/types/aws-native:batch:ComputeEnvironmentLaunchTemplateSpecificationOverride"},"description":"A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.\n\nYou can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.\n\n\u003e To unset all override templates for a compute environment, you can pass an empty array to the [UpdateComputeEnvironment.overrides](https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html) parameter, or not include the `overrides` parameter when submitting the `UpdateComputeEnvironment` API operation."},"userdataType":{"$ref":"#/types/aws-native:batch:ComputeEnvironmentLaunchTemplateSpecificationUserdataType","description":"The EKS node initialization process to use. You only need to specify this value if you are using a custom AMI. The default value is `EKS_BOOTSTRAP_SH` . If *imageType* is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you must choose `EKS_NODEADM` ."},"version":{"type":"string","description":"The version number of the launch template, `$Default` , or `$Latest` .\n\nIf the value is `$Default` , the default version of the launch template is used. If the value is `$Latest` , the latest version of the launch template is used.\n\n\u003e If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the `updateToLatestImageVersion` parameter for the compute environment is set to `true` . During an infrastructure update, if either `$Default` or `$Latest` is specified, AWS Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn't specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* . \n\nDefault: `$Default`\n\nLatest: `$Latest`"}},"type":"object"},"aws-native:batch:ComputeEnvironmentLaunchTemplateSpecificationOverride":{"properties":{"launchTemplateId":{"type":"string","description":"The ID of the launch template.\n\n*Note:* If you specify the `launchTemplateId` you can't specify the `launchTemplateName` as well."},"launchTemplateName":{"type":"string","description":"The name of the launch template.\n\n*Note:* If you specify the `launchTemplateName` you can't specify the `launchTemplateId` as well."},"targetInstanceTypes":{"type":"array","items":{"type":"string"},"description":"The instance type or family that this override launch template should be applied to.\n\nThis parameter is required when defining a launch template override.\n\nInformation included in this parameter must meet the following requirements:\n\n- Must be a valid Amazon EC2 instance type or family.\n- The following AWS Batch `InstanceTypes` are not allowed: `optimal` , `default_x86_64` , and `default_arm64` .\n- `targetInstanceTypes` can target only instance types and families that are included within the [`ComputeResource.instanceTypes`](https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource-instanceTypes) set. `targetInstanceTypes` doesn't need to include all of the instances from the `instanceType` set, but at least a subset. For example, if `ComputeResource.instanceTypes` includes `[m5, g5]` , `targetInstanceTypes` can include `[m5.2xlarge]` and `[m5.large]` but not `[c5.large]` .\n- `targetInstanceTypes` included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family."},"userdataType":{"$ref":"#/types/aws-native:batch:ComputeEnvironmentLaunchTemplateSpecificationOverrideUserdataType","description":"The EKS node initialization process to use. You only need to specify this value if you are using a custom AMI. The default value is `EKS_BOOTSTRAP_SH` . If *imageType* is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you must choose `EKS_NODEADM` ."},"version":{"type":"string","description":"The version number of the launch template, `$Default` , or `$Latest` .\n\nIf the value is `$Default` , the default version of the launch template is used. If the value is `$Latest` , the latest version of the launch template is used.\n\n\u003e If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the `updateToLatestImageVersion` parameter for the compute environment is set to `true` . During an infrastructure update, if either `$Default` or `$Latest` is specified, AWS Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn't specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the *AWS Batch User Guide* . \n\nDefault: `$Default`\n\nLatest: `$Latest`"}},"type":"object"},"aws-native:batch:ComputeEnvironmentLaunchTemplateSpecificationOverrideUserdataType":{"description":"The EKS node initialization process to use. You only need to specify this value if you are using a custom AMI. The default value is `EKS_BOOTSTRAP_SH` . If *imageType* is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you must choose `EKS_NODEADM` .","type":"string","enum":[{"name":"EksBootstrapSh","value":"EKS_BOOTSTRAP_SH"},{"name":"EksNodeadm","value":"EKS_NODEADM"}]},"aws-native:batch:ComputeEnvironmentLaunchTemplateSpecificationUserdataType":{"description":"The EKS node initialization process to use. You only need to specify this value if you are using a custom AMI. The default value is `EKS_BOOTSTRAP_SH` . If *imageType* is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you must choose `EKS_NODEADM` .","type":"string","enum":[{"name":"EksBootstrapSh","value":"EKS_BOOTSTRAP_SH"},{"name":"EksNodeadm","value":"EKS_NODEADM"}]},"aws-native:batch:ComputeEnvironmentUpdatePolicy":{"properties":{"jobExecutionTimeoutMinutes":{"type":"integer","description":"Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value is 30."},"terminateJobsOnUpdate":{"type":"boolean","description":"Specifies whether jobs are automatically terminated when the compute environment infrastructure is updated. The default value is `false` ."}},"type":"object"},"aws-native:batch:ConsumableResourceResourceType":{"description":"Type of Consumable Resource.","type":"string","enum":[{"name":"Replenishable","value":"REPLENISHABLE"},{"name":"NonReplenishable","value":"NON_REPLENISHABLE"}]},"aws-native:batch:JobDefinitionConsumableResourceProperties":{"properties":{"consumableResourceList":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionConsumableResourceRequirement"},"description":"The list of consumable resources required by a job."}},"type":"object","required":["consumableResourceList"]},"aws-native:batch:JobDefinitionConsumableResourceRequirement":{"properties":{"consumableResource":{"type":"string","description":"The ARN of the consumable resource the job definition should consume."},"quantity":{"type":"integer","description":"The quantity of the consumable resource that is needed."}},"type":"object","required":["consumableResource","quantity"]},"aws-native:batch:JobDefinitionContainerProperties":{"properties":{"command":{"type":"array","items":{"type":"string"},"description":"The command that's passed to the container. This parameter maps to `Cmd` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `COMMAND` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd) ."},"enableExecuteCommand":{"type":"boolean","description":"Determines whether execute command functionality is turned on for this task. If `true` , execute command functionality is turned on all the containers in the task."},"environment":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionEnvironment"},"description":"The environment variables to pass to a container. This parameter maps to `Env` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--env` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n\u003e We don't recommend using plaintext environment variables for sensitive information, such as credential data. \u003e Environment variables cannot start with \" `AWS_BATCH` \". This naming convention is reserved for variables that AWS Batch sets."},"ephemeralStorage":{"$ref":"#/types/aws-native:batch:JobDefinitionEphemeralStorage","description":"The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate ."},"executionRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see [AWS Batch execution IAM role](https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html) in the *AWS Batch User Guide* ."},"fargatePlatformConfiguration":{"$ref":"#/types/aws-native:batch:JobDefinitionContainerPropertiesFargatePlatformConfigurationProperties","description":"The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter."},"image":{"type":"string","description":"Required. The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with `*repository-url* / *image* : *tag*` . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to `Image` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `IMAGE` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n\u003e Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources. \n\n- Images in Amazon ECR Public repositories use the full `registry/repository[:tag]` or `registry/repository[@digest]` naming conventions. For example, `public.ecr.aws/ *registry_alias* / *my-web-app* : *latest*` .\n- Images in Amazon ECR repositories use the full registry and repository URI (for example, `123456789012.dkr.ecr.\u003cregion-name\u003e.amazonaws.com/\u003crepository-name\u003e` ).\n- Images in official repositories on Docker Hub use a single name (for example, `ubuntu` or `mongo` ).\n- Images in other repositories on Docker Hub are qualified with an organization name (for example, `amazon/amazon-ecs-agent` ).\n- Images in other online repositories are qualified further by a domain name (for example, `quay.io/assemblyline/ubuntu` )."},"jobRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see [IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide* ."},"linuxParameters":{"$ref":"#/types/aws-native:batch:JobDefinitionLinuxParameters","description":"Linux-specific modifications that are applied to the container, such as details for device mappings."},"logConfiguration":{"$ref":"#/types/aws-native:batch:JobDefinitionLogConfiguration","description":"The log configuration specification for the container.\n\nThis parameter maps to `LogConfig` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--log-driver` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n\n\u003e AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html) data type). \n\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version | grep \"Server API version\"`\n\n\u003e The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide* ."},"memory":{"type":"integer","description":"This parameter is deprecated, use `resourceRequirements` to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once."},"mountPoints":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionMountPoint"},"description":"The mount points for data volumes in your container. This parameter maps to `Volumes` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--volume` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) ."},"networkConfiguration":{"$ref":"#/types/aws-native:batch:JobDefinitionNetworkConfiguration","description":"The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter."},"privileged":{"type":"boolean","description":"When this parameter is true, the container is given elevated permissions on the host container instance (similar to the `root` user). This parameter maps to `Privileged` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--privileged` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . The default value is false.\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false."},"readonlyRootFilesystem":{"type":"boolean","description":"When this parameter is true, the container is given read-only access to its root file system. This parameter maps to `ReadonlyRootfs` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--read-only` option to `docker run` ."},"repositoryCredentials":{"$ref":"#/types/aws-native:batch:JobDefinitionRepositoryCredentials","description":"The private repository authentication credentials to use."},"resourceRequirements":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionResourceRequirement"},"description":"The type and amount of resources to assign to a container. The supported resources include `GPU` , `MEMORY` , and `VCPU` ."},"runtimePlatform":{"$ref":"#/types/aws-native:batch:JobDefinitionRuntimePlatform","description":"An object that represents the compute environment architecture for AWS Batch jobs on Fargate."},"secrets":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionSecret"},"description":"The secrets for the container. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the *AWS Batch User Guide* ."},"ulimits":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionUlimit"},"description":"A list of `ulimits` to set in the container. This parameter maps to `Ulimits` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--ulimit` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided."},"user":{"type":"string","description":"The user name to use inside the container. This parameter maps to `User` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--user` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) ."},"vcpus":{"type":"integer","description":"This parameter is deprecated, use `resourceRequirements` to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the job.\n\nEach vCPU is equivalent to 1,024 CPU shares. This parameter maps to `CpuShares` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--cpu-shares` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node."},"volumes":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionVolume"},"description":"A list of data volumes used in a job."}},"type":"object","required":["image"]},"aws-native:batch:JobDefinitionContainerPropertiesFargatePlatformConfigurationProperties":{"description":"The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.","properties":{"platformVersion":{"type":"string"}},"type":"object"},"aws-native:batch:JobDefinitionDevice":{"properties":{"containerPath":{"type":"string","description":"The path inside the container that's used to expose the host device. By default, the `hostPath` value is used."},"hostPath":{"type":"string","description":"The path for the device on the host container instance."},"permissions":{"type":"array","items":{"type":"string"},"description":"The explicit permissions to provide to the container for the device. By default, the container has permissions for `read` , `write` , and `mknod` for the device."}},"type":"object"},"aws-native:batch:JobDefinitionEcsProperties":{"properties":{"taskProperties":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionEcsTaskProperties"},"description":"An object that contains the properties for the Amazon ECS task definition of a job.\n\n\u003e This object is currently limited to one task element. However, the task element can run up to 10 containers."}},"type":"object","required":["taskProperties"]},"aws-native:batch:JobDefinitionEcsTaskProperties":{"properties":{"containers":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionTaskContainerProperties"},"description":"This object is a list of containers."},"enableExecuteCommand":{"type":"boolean","description":"Determines whether execute command functionality is turned on for this task. If `true` , execute command functionality is turned on all the containers in the task."},"ephemeralStorage":{"$ref":"#/types/aws-native:batch:JobDefinitionEphemeralStorage","description":"The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate ."},"executionRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see [AWS Batch execution IAM role](https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html) in the *AWS Batch User Guide* ."},"ipcMode":{"type":"string","description":"The IPC resource namespace to use for the containers in the task. The valid values are `host` , `task` , or `none` .\n\nIf `host` is specified, all containers within the tasks that specified the `host` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.\n\nIf `task` is specified, all containers within the specified `task` share the same IPC resources.\n\nIf `none` is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.\n\nIf no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the Docker run reference."},"networkConfiguration":{"$ref":"#/types/aws-native:batch:JobDefinitionNetworkConfiguration","description":"The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter."},"pidMode":{"type":"string","description":"The process namespace to use for the containers in the task. The valid values are `host` or `task` . For example, monitoring sidecars might need `pidMode` to access information about other containers running in the same task.\n\nIf `host` is specified, all containers within the tasks that specified the `host` PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.\n\nIf `task` is specified, all containers within the specified task share the same process namespace.\n\nIf no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the Docker run reference."},"platformVersion":{"type":"string","description":"The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the `LATEST` platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see [AWS Fargate platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* ."},"runtimePlatform":{"$ref":"#/types/aws-native:batch:JobDefinitionRuntimePlatform","description":"An object that represents the compute environment architecture for AWS Batch jobs on Fargate."},"taskRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.\n\n\u003e This is object is comparable to [ContainerProperties:jobRoleArn](https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html) ."},"volumes":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionVolume"},"description":"A list of volumes that are associated with the job."}},"type":"object"},"aws-native:batch:JobDefinitionEfsAuthorizationConfig":{"properties":{"accessPointId":{"type":"string","description":"The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the `EFSVolumeConfiguration` must either be omitted or set to `/` which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the `EFSVolumeConfiguration` . For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide* ."},"iam":{"type":"string","description":"Whether or not to use the AWS Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the `EFSVolumeConfiguration` . If this parameter is omitted, the default value of `DISABLED` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints) in the *AWS Batch User Guide* . EFS IAM authorization requires that `TransitEncryption` be `ENABLED` and that a `JobRoleArn` is specified."}},"type":"object"},"aws-native:batch:JobDefinitionEfsVolumeConfiguration":{"properties":{"authorizationConfig":{"$ref":"#/types/aws-native:batch:JobDefinitionEfsAuthorizationConfig","description":"The authorization configuration details for the Amazon EFS file system."},"fileSystemId":{"type":"string","description":"The Amazon EFS file system ID to use."},"rootDirectory":{"type":"string","description":"The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying `/` has the same effect as omitting this parameter. The maximum length is 4,096 characters.\n\n\u003e If an EFS access point is specified in the `authorizationConfig` , the root directory parameter must either be omitted or set to `/` , which enforces the path set on the Amazon EFS access point."},"transitEncryption":{"type":"string","description":"Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of `DISABLED` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide* ."},"transitEncryptionPort":{"type":"integer","description":"The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide* ."}},"type":"object","required":["fileSystemId"]},"aws-native:batch:JobDefinitionEksContainer":{"properties":{"args":{"type":"array","items":{"type":"string"},"description":"An array of arguments to the entrypoint. If this isn't specified, the `CMD` of the container image is used. This corresponds to the `args` member in the [Entrypoint](https://docs.aws.amazon.com/https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) portion of the [Pod](https://docs.aws.amazon.com/https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/) in Kubernetes. Environment variable references are expanded using the container's environment.\n\nIf the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to \" `$(NAME1)` \" and the `NAME1` environment variable doesn't exist, the command string will remain \" `$(NAME1)` .\" `$$` is replaced with `$` , and the resulting string isn't expanded. For example, `$$(VAR_NAME)` is passed as `$(VAR_NAME)` whether or not the `VAR_NAME` environment variable exists. For more information, see [Dockerfile reference: CMD](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd) and [Define a command and arguments for a pod](https://docs.aws.amazon.com/https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) in the *Kubernetes documentation* ."},"command":{"type":"array","items":{"type":"string"},"description":"The entrypoint for the container. This isn't run within a shell. If this isn't specified, the `ENTRYPOINT` of the container image is used. Environment variable references are expanded using the container's environment.\n\nIf the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to \" `$(NAME1)` \" and the `NAME1` environment variable doesn't exist, the command string will remain \" `$(NAME1)` .\" `$$` is replaced with `$` and the resulting string isn't expanded. For example, `$$(VAR_NAME)` will be passed as `$(VAR_NAME)` whether or not the `VAR_NAME` environment variable exists. The entrypoint can't be updated. For more information, see [ENTRYPOINT](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#entrypoint) in the *Dockerfile reference* and [Define a command and arguments for a container](https://docs.aws.amazon.com/https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) and [Entrypoint](https://docs.aws.amazon.com/https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint) in the *Kubernetes documentation* ."},"env":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionEksContainerEnvironmentVariable"},"description":"The environment variables to pass to a container.\n\n\u003e Environment variables cannot start with \" `AWS_BATCH` \". This naming convention is reserved for variables that AWS Batch sets."},"image":{"type":"string","description":"The Docker image used to start the container."},"imagePullPolicy":{"type":"string","description":"The image pull policy for the container. Supported values are `Always` , `IfNotPresent` , and `Never` . This parameter defaults to `IfNotPresent` . However, if the `:latest` tag is specified, it defaults to `Always` . For more information, see [Updating images](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/containers/images/#updating-images) in the *Kubernetes documentation* ."},"name":{"type":"string","description":"The name of the container. If the name isn't specified, the default name \" `Default` \" is used. Each container in a pod must have a unique name."},"resources":{"$ref":"#/types/aws-native:batch:JobDefinitionEksContainerResourceRequirements","description":"The type and amount of resources to assign to a container. The supported resources include `memory` , `cpu` , and `nvidia.com/gpu` . For more information, see [Resource management for pods and containers](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) in the *Kubernetes documentation* ."},"securityContext":{"$ref":"#/types/aws-native:batch:JobDefinitionEksContainerSecurityContext","description":"The security context for a job. For more information, see [Configure a security context for a pod or container](https://docs.aws.amazon.com/https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) in the *Kubernetes documentation* ."},"volumeMounts":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionEksContainerVolumeMount"},"description":"The volume mounts for the container. AWS Batch supports `emptyDir` , `hostPath` , and `secret` volume types. For more information about volumes and volume mounts in Kubernetes, see [Volumes](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/storage/volumes/) in the *Kubernetes documentation* ."}},"type":"object","required":["image"]},"aws-native:batch:JobDefinitionEksContainerEnvironmentVariable":{"properties":{"name":{"type":"string","description":"The name of the environment variable."},"value":{"type":"string","description":"The value of the environment variable."}},"type":"object","required":["name"]},"aws-native:batch:JobDefinitionEksContainerResourceRequirements":{"properties":{"limits":{"type":"object","additionalProperties":{"type":"string"},"description":"The type and quantity of the resources to reserve for the container. The values vary based on the `name` that's specified. Resources can be requested using either the `limits` or the `requests` objects.\n\n- **memory** - The memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. `memory` can be specified in `limits` , `requests` , or both. If `memory` is specified in both places, then the value that's specified in `limits` must be equal to the value that's specified in `requests` .\n\n\u003e To maximize your resource utilization, provide your jobs with as much memory as possible for the specific instance type that you are using. To learn how, see [Memory management](https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the *AWS Batch User Guide* .\n- **cpu** - The number of CPUs that's reserved for the container. Values must be an even multiple of `0.25` . `cpu` can be specified in `limits` , `requests` , or both. If `cpu` is specified in both places, then the value that's specified in `limits` must be at least as large as the value that's specified in `requests` .\n- **nvidia.com/gpu** - The number of GPUs that's reserved for the container. Values must be a whole integer. `memory` can be specified in `limits` , `requests` , or both. If `memory` is specified in both places, then the value that's specified in `limits` must be equal to the value that's specified in `requests` ."},"requests":{"type":"object","additionalProperties":{"type":"string"},"description":"The type and quantity of the resources to request for the container. The values vary based on the `name` that's specified. Resources can be requested by using either the `limits` or the `requests` objects.\n\n- **memory** - The memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. `memory` can be specified in `limits` , `requests` , or both. If `memory` is specified in both, then the value that's specified in `limits` must be equal to the value that's specified in `requests` .\n\n\u003e If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see [Memory management](https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the *AWS Batch User Guide* .\n- **cpu** - The number of CPUs that are reserved for the container. Values must be an even multiple of `0.25` . `cpu` can be specified in `limits` , `requests` , or both. If `cpu` is specified in both, then the value that's specified in `limits` must be at least as large as the value that's specified in `requests` .\n- **nvidia.com/gpu** - The number of GPUs that are reserved for the container. Values must be a whole integer. `nvidia.com/gpu` can be specified in `limits` , `requests` , or both. If `nvidia.com/gpu` is specified in both, then the value that's specified in `limits` must be equal to the value that's specified in `requests` ."}},"type":"object"},"aws-native:batch:JobDefinitionEksContainerSecurityContext":{"properties":{"allowPrivilegeEscalation":{"type":"boolean","description":"Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent process. The default value is `false` ."},"privileged":{"type":"boolean","description":"When this parameter is `true` , the container is given elevated permissions on the host container instance. The level of permissions are similar to the `root` user permissions. The default value is `false` . This parameter maps to `privileged` policy in the [Privileged pod security policies](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/security/pod-security-policy/#privileged) in the *Kubernetes documentation* ."},"readOnlyRootFilesystem":{"type":"boolean","description":"When this parameter is `true` , the container is given read-only access to its root file system. The default value is `false` . This parameter maps to `ReadOnlyRootFilesystem` policy in the [Volumes and file systems pod security policies](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/security/pod-security-policy/#volumes-and-file-systems) in the *Kubernetes documentation* ."},"runAsGroup":{"type":"integer","description":"When this parameter is specified, the container is run as the specified group ID ( `gid` ). If this parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to `RunAsGroup` and `MustRunAs` policy in the [Users and groups pod security policies](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) in the *Kubernetes documentation* ."},"runAsNonRoot":{"type":"boolean","description":"When this parameter is specified, the container is run as a user with a `uid` other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to `RunAsUser` and `MustRunAsNonRoot` policy in the [Users and groups pod security policies](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) in the *Kubernetes documentation* ."},"runAsUser":{"type":"integer","description":"When this parameter is specified, the container is run as the specified user ID ( `uid` ). If this parameter isn't specified, the default is the user that's specified in the image metadata. This parameter maps to `RunAsUser` and `MustRanAs` policy in the [Users and groups pod security policies](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups) in the *Kubernetes documentation* ."}},"type":"object"},"aws-native:batch:JobDefinitionEksContainerVolumeMount":{"properties":{"mountPath":{"type":"string","description":"The path on the container where the volume is mounted."},"name":{"type":"string","description":"The name the volume mount. This must match the name of one of the volumes in the pod."},"readOnly":{"type":"boolean","description":"If this value is `true` , the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is `false` ."},"subPath":{"type":"string","description":"A sub-path inside the referenced volume instead of its root."}},"type":"object"},"aws-native:batch:JobDefinitionEksEmptyDir":{"properties":{"medium":{"type":"string","description":"The medium to store the volume. The default value is an empty string, which uses the storage of the node.\n\n- **\"\"** - *(Default)* Use the disk storage of the node.\n- **\"Memory\"** - Use the `tmpfs` volume that's backed by the RAM of the node. Contents of the volume are lost when the node reboots, and any storage on the volume counts against the container's memory limit."},"sizeLimit":{"type":"string","description":"The maximum size of the volume. By default, there's no maximum size defined."}},"type":"object"},"aws-native:batch:JobDefinitionEksHostPath":{"properties":{"path":{"type":"string","description":"The path of the file or directory on the host to mount into containers on the pod."}},"type":"object"},"aws-native:batch:JobDefinitionEksMetadata":{"properties":{"annotations":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs used to attach arbitrary, non-identifying metadata to Kubernetes objects. Valid annotation keys have two segments: an optional prefix and a name, separated by a slash (/).\n\n- The prefix is optional and must be 253 characters or less. If specified, the prefix must be a DNS subdomain− a series of DNS labels separated by dots (.), and it must end with a slash (/).\n- The name segment is required and must be 63 characters or less. It can include alphanumeric characters ([a-z0-9A-Z]), dashes (-), underscores (_), and dots (.), but must begin and end with an alphanumeric character.\n\n\u003e Annotation values must be 255 characters or less. \n\nAnnotations can be added or modified at any time. Each resource can have multiple annotations."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs used to identify, sort, and organize cube resources. Can contain up to 63 uppercase letters, lowercase letters, numbers, hyphens (-), and underscores (_). Labels can be added or modified at any time. Each resource can have multiple labels, but each key must be unique for a given object."},"namespace":{"type":"string","description":"The namespace of the Amazon EKS cluster. In Kubernetes, namespaces provide a mechanism for isolating groups of resources within a single cluster. Names of resources need to be unique within a namespace, but not across namespaces. AWS Batch places Batch Job pods in this namespace. If this field is provided, the value can't be empty or null. It must meet the following requirements:\n\n- 1-63 characters long\n- Can't be set to default\n- Can't start with `kube`\n- Must match the following regular expression: `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`\n\nFor more information, see [Namespaces](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) in the *Kubernetes documentation* . This namespace can be different from the `kubernetesNamespace` set in the compute environment's `EksConfiguration` , but must have identical role-based access control (RBAC) roles as the compute environment's `kubernetesNamespace` . For multi-node parallel jobs, the same value must be provided across all the node ranges."}},"type":"object"},"aws-native:batch:JobDefinitionEksPersistentVolumeClaim":{"properties":{"claimName":{"type":"string","description":"The name of the `persistentVolumeClaim` bounded to a `persistentVolume` . For more information, see [Persistent Volume Claims](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) in the *Kubernetes documentation* ."},"readOnly":{"type":"boolean","description":"An optional boolean value indicating if the mount is read only. Default is false. For more information, see [Read Only Mounts](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/storage/volumes/#read-only-mounts) in the *Kubernetes documentation* ."}},"type":"object","required":["claimName"]},"aws-native:batch:JobDefinitionEksPodProperties":{"properties":{"containers":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionEksContainer"},"description":"The properties of the container that's used on the Amazon EKS pod.\n\n\u003e This object is limited to 10 elements."},"dnsPolicy":{"type":"string","description":"The DNS policy for the pod. The default value is `ClusterFirst` . If the `hostNetwork` parameter is not specified, the default is `ClusterFirstWithHostNet` . `ClusterFirst` indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see [Pod's DNS policy](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy) in the *Kubernetes documentation* .\n\nValid values: `Default` | `ClusterFirst` | `ClusterFirstWithHostNet`"},"hostNetwork":{"type":"boolean","description":"Indicates if the pod uses the hosts' network IP address. The default value is `true` . Setting this to `false` enables the Kubernetes pod networking model. Most AWS Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see [Host namespaces](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces) and [Pod networking](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/workloads/pods/#pod-networking) in the *Kubernetes documentation* ."},"imagePullSecrets":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionImagePullSecret"},"description":"References a Kubernetes secret resource. It holds a list of secrets. These secrets help to gain access to pull an images from a private registry.\n\n`ImagePullSecret$name` is required when this object is used."},"initContainers":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionEksContainer"},"description":"These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see [Init Containers](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) in the *Kubernetes documentation* .\n\n\u003e This object is limited to 10 elements."},"metadata":{"$ref":"#/types/aws-native:batch:JobDefinitionEksMetadata","description":"Metadata about the Kubernetes pod. For more information, see [Understanding Kubernetes Objects](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) in the *Kubernetes documentation* ."},"serviceAccountName":{"type":"string","description":"The name of the service account that's used to run the pod. For more information, see [Kubernetes service accounts](https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html) and [Configure a Kubernetes service account to assume an IAM role](https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html) in the *Amazon EKS User Guide* and [Configure service accounts for pods](https://docs.aws.amazon.com/https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) in the *Kubernetes documentation* ."},"shareProcessNamespace":{"type":"boolean","description":"Indicates if the processes in a container are shared, or visible, to other containers in the same pod. For more information, see [Share Process Namespace between Containers in a Pod](https://docs.aws.amazon.com/https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/) ."},"volumes":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionEksVolume"},"description":"Specifies the volumes for a job definition that uses Amazon EKS resources."}},"type":"object"},"aws-native:batch:JobDefinitionEksProperties":{"properties":{"podProperties":{"$ref":"#/types/aws-native:batch:JobDefinitionEksPodProperties","description":"The properties for the Kubernetes pod resources of a job."}},"type":"object"},"aws-native:batch:JobDefinitionEksSecret":{"properties":{"optional":{"type":"boolean","description":"Specifies whether the secret or the secret's keys must be defined."},"secretName":{"type":"string","description":"The name of the secret. The name must be allowed as a DNS subdomain name. For more information, see [DNS subdomain names](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) in the *Kubernetes documentation* ."}},"type":"object","required":["secretName"]},"aws-native:batch:JobDefinitionEksVolume":{"properties":{"emptyDir":{"$ref":"#/types/aws-native:batch:JobDefinitionEksEmptyDir","description":"Specifies the configuration of a Kubernetes `emptyDir` volume. For more information, see [emptyDir](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) in the *Kubernetes documentation* ."},"hostPath":{"$ref":"#/types/aws-native:batch:JobDefinitionEksHostPath","description":"Specifies the configuration of a Kubernetes `hostPath` volume. For more information, see [hostPath](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) in the *Kubernetes documentation* ."},"name":{"type":"string","description":"The name of the volume. The name must be allowed as a DNS subdomain name. For more information, see [DNS subdomain names](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) in the *Kubernetes documentation* ."},"persistentVolumeClaim":{"$ref":"#/types/aws-native:batch:JobDefinitionEksPersistentVolumeClaim","description":"Specifies the configuration of a Kubernetes `persistentVolumeClaim` bounded to a `persistentVolume` . For more information, see [Persistent Volume Claims](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) in the *Kubernetes documentation* ."},"secret":{"$ref":"#/types/aws-native:batch:JobDefinitionEksSecret","description":"Specifies the configuration of a Kubernetes `secret` volume. For more information, see [secret](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/storage/volumes/#secret) in the *Kubernetes documentation* ."}},"type":"object","required":["name"]},"aws-native:batch:JobDefinitionEnvironment":{"properties":{"name":{"type":"string","description":"The name of the environment variable."},"value":{"type":"string","description":"The value of the environment variable."}},"type":"object"},"aws-native:batch:JobDefinitionEphemeralStorage":{"properties":{"sizeInGiB":{"type":"integer","description":"The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is `21` GiB and the maximum supported value is `200` GiB."}},"type":"object","required":["sizeInGiB"]},"aws-native:batch:JobDefinitionEvaluateOnExit":{"properties":{"action":{"type":"string","description":"Specifies the action to take if all of the specified conditions ( `onStatusReason` , `onReason` , and `onExitCode` ) are met. The values aren't case sensitive."},"onExitCode":{"type":"string","description":"Contains a glob pattern to match against the decimal representation of the `ExitCode` returned for a job. The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so that only the start of the string needs to be an exact match.\n\nThe string can contain up to 512 characters."},"onReason":{"type":"string","description":"Contains a glob pattern to match against the `Reason` returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match."},"onStatusReason":{"type":"string","description":"Contains a glob pattern to match against the `StatusReason` returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white spaces (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match."}},"type":"object","required":["action"]},"aws-native:batch:JobDefinitionHost":{"properties":{"sourcePath":{"type":"string","description":"The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.\n\n\u003e This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these jobs."}},"type":"object"},"aws-native:batch:JobDefinitionImagePullSecret":{"properties":{"name":{"type":"string","description":"Provides a unique identifier for the `ImagePullSecret` . This object is required when `EksPodProperties$imagePullSecrets` is used."}},"type":"object"},"aws-native:batch:JobDefinitionJobTimeout":{"properties":{"attemptDurationSeconds":{"type":"integer","description":"The job timeout time (in seconds) that's measured from the job attempt's `startedAt` timestamp. After this time passes, AWS Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60 seconds.\n\nFor array jobs, the timeout applies to the child jobs, not to the parent array job.\n\nFor multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the individual nodes."}},"type":"object"},"aws-native:batch:JobDefinitionLinuxParameters":{"properties":{"devices":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionDevice"},"description":"Any of the host devices to expose to the container. This parameter maps to `Devices` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--device` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs."},"initProcessEnabled":{"type":"boolean","description":"If true, run an `init` process inside the container that forwards signals and reaps processes. This parameter maps to the `--init` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version | grep \"Server API version\"`"},"maxSwap":{"type":"integer","description":"The total amount of swap memory (in MiB) a container can use. This parameter is translated to the `--memory-swap` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) where the value is the sum of the container memory plus the `maxSwap` value. For more information, see [`--memory-swap` details](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details) in the Docker documentation.\n\nIf a `maxSwap` value of `0` is specified, the container doesn't use swap. Accepted values are `0` or any positive integer. If the `maxSwap` parameter is omitted, the container doesn't use the swap configuration for the container instance on which it runs. A `maxSwap` value must be set for the `swappiness` parameter to be used.\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs."},"sharedMemorySize":{"type":"integer","description":"The value for the size (in MiB) of the `/dev/shm` volume. This parameter maps to the `--shm-size` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs."},"swappiness":{"type":"integer","description":"You can use this parameter to tune a container's memory swappiness behavior. A `swappiness` value of `0` causes swapping to not occur unless absolutely necessary. A `swappiness` value of `100` causes pages to be swapped aggressively. Valid values are whole numbers between `0` and `100` . If the `swappiness` parameter isn't specified, a default value of `60` is used. If a value isn't specified for `maxSwap` , then this parameter is ignored. If `maxSwap` is set to 0, the container doesn't use swap. This parameter maps to the `--memory-swappiness` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\nConsider the following when you use a per-container swap configuration.\n\n- Swap space must be enabled and allocated on the container instance for the containers to use.\n\n\u003e By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see [Instance store swap volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html) in the *Amazon EC2 User Guide for Linux Instances* or [How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?](https://docs.aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/)\n- The swap space parameters are only supported for job definitions using EC2 resources.\n- If the `maxSwap` and `swappiness` parameters are omitted from a job definition, each container has a default `swappiness` value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs."},"tmpfs":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionTmpfs"},"description":"The container path, mount options, and size (in MiB) of the `tmpfs` mount. This parameter maps to the `--tmpfs` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type."}},"type":"object"},"aws-native:batch:JobDefinitionLogConfiguration":{"properties":{"logDriver":{"type":"string","description":"The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.\n\nThe supported log drivers are `awsfirelens` , `awslogs` , `fluentd` , `gelf` , `json-file` , `journald` , `logentries` , `syslog` , and `splunk` .\n\n\u003e Jobs that are running on Fargate resources are restricted to the `awslogs` and `splunk` log drivers. \n\n- **awsfirelens** - Specifies the firelens logging driver. For more information on configuring Firelens, see [Send Amazon ECS logs to an AWS service or AWS Partner](https://docs.aws.amazon.com//AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide* .\n- **awslogs** - Specifies the Amazon CloudWatch Logs logging driver. For more information, see [Using the awslogs log driver](https://docs.aws.amazon.com/batch/latest/userguide/using_awslogs.html) in the *AWS Batch User Guide* and [Amazon CloudWatch Logs logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/awslogs/) in the Docker documentation.\n- **fluentd** - Specifies the Fluentd logging driver. For more information including usage and options, see [Fluentd logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/fluentd/) in the *Docker documentation* .\n- **gelf** - Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see [Graylog Extended Format logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/gelf/) in the *Docker documentation* .\n- **journald** - Specifies the journald logging driver. For more information including usage and options, see [Journald logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/journald/) in the *Docker documentation* .\n- **json-file** - Specifies the JSON file logging driver. For more information including usage and options, see [JSON File logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/json-file/) in the *Docker documentation* .\n- **splunk** - Specifies the Splunk logging driver. For more information including usage and options, see [Splunk logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/splunk/) in the *Docker documentation* .\n- **syslog** - Specifies the syslog logging driver. For more information including usage and options, see [Syslog logging driver](https://docs.aws.amazon.com/https://docs.docker.com/config/containers/logging/syslog/) in the *Docker documentation* .\n\n\u003e If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software. \n\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version | grep \"Server API version\"`"},"options":{"type":"object","additionalProperties":{"type":"string"},"description":"The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version | grep \"Server API version\"`"},"secretOptions":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionSecret"},"description":"The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the *AWS Batch User Guide* ."}},"type":"object","required":["logDriver"]},"aws-native:batch:JobDefinitionMountPoint":{"properties":{"containerPath":{"type":"string","description":"The path on the container where the host volume is mounted."},"readOnly":{"type":"boolean","description":"If this value is `true` , the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is `false` ."},"sourceVolume":{"type":"string","description":"The name of the volume to mount."}},"type":"object"},"aws-native:batch:JobDefinitionMultiNodeContainerProperties":{"properties":{"command":{"type":"array","items":{"type":"string"},"description":"The command that's passed to the container. This parameter maps to `Cmd` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `COMMAND` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd) ."},"enableExecuteCommand":{"type":"boolean","description":"Determines whether execute command functionality is turned on for this task. If `true` , execute command functionality is turned on all the containers in the task."},"environment":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionEnvironment"},"description":"The environment variables to pass to a container. This parameter maps to `Env` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--env` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n\u003e We don't recommend using plaintext environment variables for sensitive information, such as credential data. \u003e Environment variables cannot start with \" `AWS_BATCH` \". This naming convention is reserved for variables that AWS Batch sets."},"ephemeralStorage":{"$ref":"#/types/aws-native:batch:JobDefinitionEphemeralStorage","description":"The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate ."},"executionRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see [AWS Batch execution IAM role](https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html) in the *AWS Batch User Guide* ."},"image":{"type":"string","description":"Required. The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with `*repository-url* / *image* : *tag*` . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to `Image` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `IMAGE` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n\u003e Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources. \n\n- Images in Amazon ECR Public repositories use the full `registry/repository[:tag]` or `registry/repository[@digest]` naming conventions. For example, `public.ecr.aws/ *registry_alias* / *my-web-app* : *latest*` .\n- Images in Amazon ECR repositories use the full registry and repository URI (for example, `123456789012.dkr.ecr.\u003cregion-name\u003e.amazonaws.com/\u003crepository-name\u003e` ).\n- Images in official repositories on Docker Hub use a single name (for example, `ubuntu` or `mongo` ).\n- Images in other repositories on Docker Hub are qualified with an organization name (for example, `amazon/amazon-ecs-agent` ).\n- Images in other online repositories are qualified further by a domain name (for example, `quay.io/assemblyline/ubuntu` )."},"instanceType":{"type":"string","description":"The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.\n\n\u003e This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided."},"jobRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see [IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide* ."},"linuxParameters":{"$ref":"#/types/aws-native:batch:JobDefinitionLinuxParameters","description":"Linux-specific modifications that are applied to the container, such as details for device mappings."},"logConfiguration":{"$ref":"#/types/aws-native:batch:JobDefinitionLogConfiguration","description":"The log configuration specification for the container.\n\nThis parameter maps to `LogConfig` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--log-driver` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n\n\u003e AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html) data type). \n\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version | grep \"Server API version\"`\n\n\u003e The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide* ."},"memory":{"type":"integer","description":"This parameter is deprecated, use `resourceRequirements` to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once."},"mountPoints":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionMountPoint"},"description":"The mount points for data volumes in your container.\n\nThis parameter maps to `Volumes` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the [--volume](https://docs.aws.amazon.com/) option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\nWindows containers can mount whole directories on the same drive as `$env:ProgramData` . Windows containers can't mount directories on a different drive, and mount point can't be across drives."},"privileged":{"type":"boolean","description":"When this parameter is true, the container is given elevated permissions on the host container instance (similar to the `root` user). This parameter maps to `Privileged` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--privileged` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . The default value is false.\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false."},"readonlyRootFilesystem":{"type":"boolean","description":"When this parameter is true, the container is given read-only access to its root file system. This parameter maps to `ReadonlyRootfs` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--read-only` option to `docker run` ."},"repositoryCredentials":{"$ref":"#/types/aws-native:batch:JobDefinitionRepositoryCredentials","description":"The private repository authentication credentials to use."},"resourceRequirements":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionResourceRequirement"},"description":"The type and amount of resources to assign to a container. The supported resources include `GPU` , `MEMORY` , and `VCPU` ."},"runtimePlatform":{"$ref":"#/types/aws-native:batch:JobDefinitionRuntimePlatform","description":"An object that represents the compute environment architecture for AWS Batch jobs on Fargate."},"secrets":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionSecret"},"description":"The secrets for the container. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the *AWS Batch User Guide* ."},"ulimits":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionUlimit"},"description":"A list of `ulimits` to set in the container. This parameter maps to `Ulimits` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--ulimit` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided."},"user":{"type":"string","description":"The user name to use inside the container. This parameter maps to `User` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--user` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) ."},"vcpus":{"type":"integer","description":"This parameter is deprecated, use `resourceRequirements` to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the job.\n\nEach vCPU is equivalent to 1,024 CPU shares. This parameter maps to `CpuShares` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--cpu-shares` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node."},"volumes":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionVolume"},"description":"A list of data volumes used in a job."}},"type":"object","required":["image"]},"aws-native:batch:JobDefinitionMultiNodeEcsProperties":{"properties":{"taskProperties":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionMultiNodeEcsTaskProperties"},"description":"An object that contains the properties for the Amazon ECS task definition of a job.\n\n\u003e This object is currently limited to one task element. However, the task element can run up to 10 containers."}},"type":"object","required":["taskProperties"]},"aws-native:batch:JobDefinitionMultiNodeEcsTaskProperties":{"properties":{"containers":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionTaskContainerProperties"},"description":"This object is a list of containers."},"enableExecuteCommand":{"type":"boolean","description":"Determines whether execute command functionality is turned on for this task. If `true` , execute command functionality is turned on all the containers in the task."},"executionRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see [AWS Batch execution IAM role](https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html) in the *AWS Batch User Guide* ."},"ipcMode":{"type":"string","description":"The IPC resource namespace to use for the containers in the task. The valid values are `host` , `task` , or `none` .\n\nIf `host` is specified, all containers within the tasks that specified the `host` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.\n\nIf `task` is specified, all containers within the specified `task` share the same IPC resources.\n\nIf `none` is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.\n\nIf no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the Docker run reference."},"pidMode":{"type":"string","description":"The process namespace to use for the containers in the task. The valid values are `host` or `task` . For example, monitoring sidecars might need `pidMode` to access information about other containers running in the same task.\n\nIf `host` is specified, all containers within the tasks that specified the `host` PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.\n\nIf `task` is specified, all containers within the specified task share the same process namespace.\n\nIf no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the Docker run reference."},"taskRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.\n\n\u003e This is object is comparable to [ContainerProperties:jobRoleArn](https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html) ."},"volumes":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionVolume"},"description":"A list of volumes that are associated with the job."}},"type":"object"},"aws-native:batch:JobDefinitionNetworkConfiguration":{"properties":{"assignPublicIp":{"type":"string","description":"Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see [Amazon ECS task networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide* . The default value is \" `DISABLED` \"."}},"type":"object"},"aws-native:batch:JobDefinitionNodeProperties":{"properties":{"mainNode":{"type":"integer","description":"Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes."},"nodeRangeProperties":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionNodeRangeProperty"},"description":"A list of node ranges and their properties that are associated with a multi-node parallel job."},"numNodes":{"type":"integer","description":"The number of nodes that are associated with a multi-node parallel job."}},"type":"object","required":["mainNode","nodeRangeProperties","numNodes"]},"aws-native:batch:JobDefinitionNodeRangeProperty":{"properties":{"consumableResourceProperties":{"$ref":"#/types/aws-native:batch:JobDefinitionConsumableResourceProperties","description":"Contains a list of consumable resources required by a job."},"container":{"$ref":"#/types/aws-native:batch:JobDefinitionMultiNodeContainerProperties","description":"The container details for the node range."},"ecsProperties":{"$ref":"#/types/aws-native:batch:JobDefinitionMultiNodeEcsProperties","description":"This is an object that represents the properties of the node range for a multi-node parallel job."},"eksProperties":{"$ref":"#/types/aws-native:batch:JobDefinitionEksProperties","description":"This is an object that represents the properties of the node range for a multi-node parallel job."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"The instance types of the underlying host infrastructure of a multi-node parallel job.\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources.\n\u003e \n\u003e In addition, this list object is currently limited to one element."},"targetNodes":{"type":"string","description":"The range of nodes, using node index values. A range of `0:3` indicates nodes with index values of `0` through `3` . If the starting range value is omitted ( `:n` ), then `0` is used to start the range. If the ending range value is omitted ( `n:` ), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes ( `0:n` ). You can nest node ranges (for example, `0:10` and `4:5` ). In this case, the `4:5` range properties override the `0:10` properties."}},"type":"object","required":["targetNodes"]},"aws-native:batch:JobDefinitionRepositoryCredentials":{"properties":{"credentialsParameter":{"type":"string","description":"The Amazon Resource Name (ARN) of the secret containing the private repository credentials."}},"type":"object","required":["credentialsParameter"]},"aws-native:batch:JobDefinitionResourceRequirement":{"properties":{"type":{"type":"string","description":"The type of resource to assign to a container. The supported resources include `GPU` , `MEMORY` , and `VCPU` ."},"value":{"type":"string","description":"The quantity of the specified resource to reserve for the container. The values vary based on the `type` specified.\n\n- **type=\"GPU\"** - The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.\n\n\u003e GPUs aren't available for jobs that are running on Fargate resources.\n- **type=\"MEMORY\"** - The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on Amazon EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to `Memory` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to `Memory` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n\u003e If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see [Memory management](https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the *AWS Batch User Guide* . \n\nFor jobs that are running on Fargate resources, then `value` is the hard limit (in MiB), and must match one of the supported values and the `VCPU` values must be one of the values supported for that memory value.\n\n- **value = 512** - `VCPU` = 0.25\n- **value = 1024** - `VCPU` = 0.25 or 0.5\n- **value = 2048** - `VCPU` = 0.25, 0.5, or 1\n- **value = 3072** - `VCPU` = 0.5, or 1\n- **value = 4096** - `VCPU` = 0.5, 1, or 2\n- **value = 5120, 6144, or 7168** - `VCPU` = 1 or 2\n- **value = 8192** - `VCPU` = 1, 2, or 4\n- **value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360** - `VCPU` = 2 or 4\n- **value = 16384** - `VCPU` = 2, 4, or 8\n- **value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720** - `VCPU` = 4\n- **value = 20480, 24576, or 28672** - `VCPU` = 4 or 8\n- **value = 36864, 45056, 53248, or 61440** - `VCPU` = 8\n- **value = 32768, 40960, 49152, or 57344** - `VCPU` = 8 or 16\n- **value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880** - `VCPU` = 16\n- **type=\"VCPU\"** - The number of vCPUs reserved for the container. This parameter maps to `CpuShares` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--cpu-shares` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . Each vCPU is equivalent to 1,024 CPU shares. For Amazon EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.\n\nThe default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see [AWS Fargate quotas](https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate) in the *AWS General Reference* .\n\nFor jobs that are running on Fargate resources, then `value` must match one of the supported values and the `MEMORY` values must be one of the values supported for that `VCPU` value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16\n\n- **value = 0.25** - `MEMORY` = 512, 1024, or 2048\n- **value = 0.5** - `MEMORY` = 1024, 2048, 3072, or 4096\n- **value = 1** - `MEMORY` = 2048, 3072, 4096, 5120, 6144, 7168, or 8192\n- **value = 2** - `MEMORY` = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384\n- **value = 4** - `MEMORY` = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720\n- **value = 8** - `MEMORY` = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440\n- **value = 16** - `MEMORY` = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880"}},"type":"object"},"aws-native:batch:JobDefinitionResourceRetentionPolicy":{"properties":{"skipDeregisterOnUpdate":{"type":"boolean","description":"Specifies whether the previous revision of the job definition is retained in an active status after UPDATE events for the resource. The default value is `false` . When the property is set to `false` , the previous revision of the job definition is de-registered after a new revision is created. When the property is set to `true` , the previous revision of the job definition is not de-registered."}},"type":"object"},"aws-native:batch:JobDefinitionRetryStrategy":{"properties":{"attempts":{"type":"integer","description":"The number of times to move a job to the `RUNNABLE` status. You can specify between 1 and 10 attempts. If the value of `attempts` is greater than one, the job is retried on failure the same number of attempts as the value."},"evaluateOnExit":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionEvaluateOnExit"},"description":"Array of up to 5 objects that specify the conditions where jobs are retried or failed. If this parameter is specified, then the `attempts` parameter must also be specified. If none of the listed conditions match, then the job is retried."}},"type":"object"},"aws-native:batch:JobDefinitionRuntimePlatform":{"properties":{"cpuArchitecture":{"type":"string","description":"The vCPU architecture. The default value is `X86_64` . Valid values are `X86_64` and `ARM64` .\n\n\u003e This parameter must be set to `X86_64` for Windows containers. \u003e Fargate Spot is not supported on Windows-based containers on Fargate. A job queue will be blocked if a Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both `FARGATE` and `FARGATE_SPOT` compute environments to the same job queue."},"operatingSystemFamily":{"type":"string","description":"The operating system for the compute environment. Valid values are: `LINUX` (default), `WINDOWS_SERVER_2019_CORE` , `WINDOWS_SERVER_2019_FULL` , `WINDOWS_SERVER_2022_CORE` , and `WINDOWS_SERVER_2022_FULL` .\n\n\u003e The following parameters can’t be set for Windows containers: `linuxParameters` , `privileged` , `user` , `ulimits` , `readonlyRootFilesystem` , and `efsVolumeConfiguration` . \u003e The AWS Batch Scheduler checks the compute environments that are attached to the job queue before registering a task definition with Fargate. In this scenario, the job queue is where the job is submitted. If the job requires a Windows container and the first compute environment is `LINUX` , the compute environment is skipped and the next compute environment is checked until a Windows-based compute environment is found. \u003e Fargate Spot is not supported on Windows-based containers on Fargate. A job queue will be blocked if a Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both `FARGATE` and `FARGATE_SPOT` compute environments to the same job queue."}},"type":"object"},"aws-native:batch:JobDefinitionSecret":{"properties":{"name":{"type":"string","description":"The name of the secret."},"valueFrom":{"type":"string","description":"The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.\n\n\u003e If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified."}},"type":"object","required":["name","valueFrom"]},"aws-native:batch:JobDefinitionTaskContainerDependency":{"properties":{"condition":{"type":"string","description":"The dependency condition of the container. The following are the available conditions and their behavior:\n\n- `START` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.\n- `COMPLETE` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.\n- `SUCCESS` - This condition is the same as `COMPLETE` , but it also requires that the container exits with a zero status. This condition can't be set on an essential container."},"containerName":{"type":"string","description":"A unique identifier for the container."}},"type":"object","required":["condition","containerName"]},"aws-native:batch:JobDefinitionTaskContainerProperties":{"properties":{"command":{"type":"array","items":{"type":"string"},"description":"The command that's passed to the container. This parameter maps to `Cmd` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `COMMAND` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . For more information, see [Dockerfile reference: CMD](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd) ."},"dependsOn":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionTaskContainerDependency"},"description":"A list of containers that this container depends on."},"environment":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionEnvironment"},"description":"The environment variables to pass to a container. This parameter maps to Env in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--env` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n\u003e We don't recommend using plaintext environment variables for sensitive information, such as credential data. \u003e Environment variables cannot start with `AWS_BATCH` . This naming convention is reserved for variables that AWS Batch sets."},"essential":{"type":"boolean","description":"If the essential parameter of a container is marked as `true` , and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the `essential` parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.\n\nAll jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide* ."},"firelensConfiguration":{"$ref":"#/types/aws-native:batch:JobDefinitionTaskContainerPropertiesFirelensConfigurationProperties","description":"The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) routing in the *Amazon Elastic Container Service Developer Guide* ."},"image":{"type":"string","description":"The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either `repository-url/image:tag` or `repository-url/image@digest` . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to `Image` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `IMAGE` parameter of the [*docker run*](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) ."},"linuxParameters":{"$ref":"#/types/aws-native:batch:JobDefinitionLinuxParameters","description":"Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information, see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html) ."},"logConfiguration":{"$ref":"#/types/aws-native:batch:JobDefinitionLogConfiguration","description":"The log configuration specification for the container.\n\nThis parameter maps to `LogConfig` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--log-driver` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\nBy default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the *Docker documentation* .\n\n\u003e Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the `LogConfiguration` data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. \n\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version `--format '{{.Server.APIVersion}}'`\n\n\u003e The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide* ."},"mountPoints":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionMountPoint"},"description":"The mount points for data volumes in your container.\n\nThis parameter maps to `Volumes` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the [--volume](https://docs.aws.amazon.com/) option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\nWindows containers can mount whole directories on the same drive as `$env:ProgramData` . Windows containers can't mount directories on a different drive, and mount point can't be across drives."},"name":{"type":"string","description":"The name of a container. The name can be used as a unique identifier to target your `dependsOn` and `Overrides` objects."},"privileged":{"type":"boolean","description":"When this parameter is `true` , the container is given elevated privileges on the host container instance (similar to the `root` user). This parameter maps to `Privileged` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--privileged` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n\u003e This parameter is not supported for Windows containers or tasks run on Fargate."},"readonlyRootFilesystem":{"type":"boolean","description":"When this parameter is true, the container is given read-only access to its root file system. This parameter maps to `ReadonlyRootfs` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--read-only` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\n\u003e This parameter is not supported for Windows containers."},"repositoryCredentials":{"$ref":"#/types/aws-native:batch:JobDefinitionRepositoryCredentials","description":"The private repository authentication credentials to use."},"resourceRequirements":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionResourceRequirement"},"description":"The type and amount of a resource to assign to a container. The only supported resource is a GPU."},"secrets":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionSecret"},"description":"The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the Amazon Elastic Container Service Developer Guide."},"ulimits":{"type":"array","items":{"$ref":"#/types/aws-native:batch:JobDefinitionUlimit"},"description":"A list of `ulimits` to set in the container. If a `ulimit` value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to `Ulimits` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the `--ulimit` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) .\n\nAmazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The `nofile` resource limit sets a restriction on the number of open files that a container can use. The default `nofile` soft limit is `1024` and the default hard limit is `65535` .\n\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version `--format '{{.Server.APIVersion}}'`\n\n\u003e This parameter is not supported for Windows containers."},"user":{"type":"string","description":"The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.\n\n\u003e When running tasks using the `host` network mode, don't run containers using the `root user (UID 0)` . We recommend using a non-root user for better security. \n\nYou can specify the `user` using the following formats. If specifying a UID or GID, you must specify it as a positive integer.\n\n- `user`\n- `user:group`\n- `uid`\n- `uid:gid`\n- `user:gi`\n- `uid:group`\n\n\u003e This parameter is not supported for Windows containers."}},"type":"object","required":["image"]},"aws-native:batch:JobDefinitionTaskContainerPropertiesFirelensConfigurationProperties":{"description":"The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) routing in the *Amazon Elastic Container Service Developer Guide* .","properties":{"options":{"type":"object","additionalProperties":{"type":"string"}},"type":{"type":"string"}},"type":"object","required":["type"]},"aws-native:batch:JobDefinitionTmpfs":{"properties":{"containerPath":{"type":"string","description":"The absolute file path in the container where the `tmpfs` volume is mounted."},"mountOptions":{"type":"array","items":{"type":"string"},"description":"The list of `tmpfs` volume mount options.\n\nValid values: \" `defaults` \" | \" `ro` \" | \" `rw` \" | \" `suid` \" | \" `nosuid` \" | \" `dev` \" | \" `nodev` \" | \" `exec` \" | \" `noexec` \" | \" `sync` \" | \" `async` \" | \" `dirsync` \" | \" `remount` \" | \" `mand` \" | \" `nomand` \" | \" `atime` \" | \" `noatime` \" | \" `diratime` \" | \" `nodiratime` \" | \" `bind` \" | \" `rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime` \" | \" `norelatime` \" | \" `strictatime` \" | \" `nostrictatime` \" | \" `mode` \" | \" `uid` \" | \" `gid` \" | \" `nr_inodes` \" | \" `nr_blocks` \" | \" `mpol` \""},"size":{"type":"integer","description":"The size (in MiB) of the `tmpfs` volume."}},"type":"object","required":["containerPath","size"]},"aws-native:batch:JobDefinitionUlimit":{"properties":{"hardLimit":{"type":"integer","description":"The hard limit for the `ulimit` type."},"name":{"type":"string","description":"The `type` of the `ulimit` . Valid values are: `core` | `cpu` | `data` | `fsize` | `locks` | `memlock` | `msgqueue` | `nice` | `nofile` | `nproc` | `rss` | `rtprio` | `rttime` | `sigpending` | `stack` ."},"softLimit":{"type":"integer","description":"The soft limit for the `ulimit` type."}},"type":"object","required":["hardLimit","name","softLimit"]},"aws-native:batch:JobDefinitionVolume":{"properties":{"efsVolumeConfiguration":{"$ref":"#/types/aws-native:batch:JobDefinitionEfsVolumeConfiguration","description":"This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a `platformVersion` of at least `1.4.0` ."},"host":{"$ref":"#/types/aws-native:batch:JobDefinitionHost","description":"The contents of the `host` parameter determine whether your data volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.\n\n\u003e This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided."},"name":{"type":"string","description":"The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the `sourceVolume` parameter of container definition `mountPoints` ."}},"type":"object"},"aws-native:batch:JobQueueComputeEnvironmentOrder":{"properties":{"computeEnvironment":{"type":"string","description":"The Amazon Resource Name (ARN) of the compute environment."},"order":{"type":"integer","description":"The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower `order` integer value is tried for job placement first."}},"type":"object","required":["computeEnvironment","order"]},"aws-native:batch:JobQueueJobStateTimeLimitAction":{"properties":{"action":{"$ref":"#/types/aws-native:batch:JobQueueJobStateTimeLimitActionAction","description":"The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is `CANCEL` , which will cancel the job."},"maxTimeSeconds":{"type":"integer","description":"The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours)."},"reason":{"type":"string","description":"The reason to log for the action being taken."},"state":{"$ref":"#/types/aws-native:batch:JobQueueJobStateTimeLimitActionState","description":"The state of the job needed to trigger the action. The only supported value is `RUNNABLE` ."}},"type":"object","required":["action","maxTimeSeconds","reason","state"]},"aws-native:batch:JobQueueJobStateTimeLimitActionAction":{"description":"The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is `CANCEL` , which will cancel the job.","type":"string","enum":[{"name":"Cancel","value":"CANCEL"},{"name":"Terminate","value":"TERMINATE"}]},"aws-native:batch:JobQueueJobStateTimeLimitActionState":{"description":"The state of the job needed to trigger the action. The only supported value is `RUNNABLE` .","type":"string","enum":[{"name":"Runnable","value":"RUNNABLE"}]},"aws-native:batch:JobQueueServiceEnvironmentOrder":{"properties":{"order":{"type":"integer","description":"The order of the service environment. Job queues with a higher priority are evaluated first when associated with the same service environment."},"serviceEnvironment":{"type":"string","description":"The name or ARN of the service environment."}},"type":"object","required":["order","serviceEnvironment"]},"aws-native:batch:JobQueueState":{"description":"The state of the job queue. If the job queue state is `ENABLED` , it is able to accept jobs. If the job queue state is `DISABLED` , new jobs can't be added to the queue, but jobs already in the queue can finish.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:batch:SchedulingPolicyFairsharePolicy":{"description":"Fair Share Policy for the Job Queue.","properties":{"computeReservation":{"type":"number","description":"A value used to reserve some of the available maximum vCPU for share identifiers that aren't already used.\n\nThe reserved ratio is `( *computeReservation* /100)^ *ActiveFairShares*` where `*ActiveFairShares*` is the number of active share identifiers.\n\nFor example, a `computeReservation` value of 50 indicates that AWS Batch reserves 50% of the maximum available vCPU if there's only one share identifier. It reserves 25% if there are two share identifiers. It reserves 12.5% if there are three share identifiers. A `computeReservation` value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there's only one share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three share identifiers.\n\nThe minimum value is 0 and the maximum value is 99."},"shareDecaySeconds":{"type":"number","description":"The amount of time (in seconds) to use to calculate a fair-share percentage for each share identifier in use. A value of zero (0) indicates the default minimum time window (600 seconds). The maximum supported value is 604800 (1 week).\n\nThe decay allows for more recently run jobs to have more weight than jobs that ran earlier. Consider adjusting this number if you have jobs that (on average) run longer than ten minutes, or a large difference in job count or job run times between share identifiers, and the allocation of resources doesn't meet your needs."},"shareDistribution":{"type":"array","items":{"$ref":"#/types/aws-native:batch:SchedulingPolicyShareAttributes"},"description":"List of Share Attributes"}},"type":"object"},"aws-native:batch:SchedulingPolicyShareAttributes":{"properties":{"shareIdentifier":{"type":"string","description":"A share identifier or share identifier prefix. If the string ends with an asterisk (*), this entry specifies the weight factor to use for share identifiers that start with that prefix. The list of share identifiers in a fair-share policy can't overlap. For example, you can't have one that specifies a `shareIdentifier` of `UserA*` and another that specifies a `shareIdentifier` of `UserA1` .\n\nThere can be no more than 500 share identifiers active in a job queue.\n\nThe string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*)."},"weightFactor":{"type":"number","description":"The weight factor for the share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share identifier with a weight factor of 1.\n\nThe smallest supported value is 0.0001, and the largest supported value is 999.9999."}},"type":"object"},"aws-native:batch:ServiceEnvironmentCapacityLimit":{"properties":{"capacityUnit":{"type":"string"},"maxCapacity":{"type":"integer"}},"type":"object"},"aws-native:bedrock:AgentActionGroup":{"description":"Contains the information of an Agent Action Group","properties":{"actionGroupExecutor":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:AgentActionGroupExecutor0Properties"},{"$ref":"#/types/aws-native:bedrock:AgentActionGroupExecutor1Properties"}],"description":"The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user."},"actionGroupName":{"type":"string","description":"Name of the action group"},"actionGroupState":{"$ref":"#/types/aws-native:bedrock:AgentActionGroupState","description":"Specifies whether the action group is available for the agent to invoke or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request."},"apiSchema":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:AgentApiSchema0Properties"},{"$ref":"#/types/aws-native:bedrock:AgentApiSchema1Properties"}],"description":"Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see [Action group OpenAPI schemas](https://docs.aws.amazon.com//bedrock/latest/userguide/agents-api-schema.html) ."},"description":{"type":"string","description":"Description of action group"},"functionSchema":{"$ref":"#/types/aws-native:bedrock:AgentFunctionSchema","description":"Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema."},"parentActionGroupSignature":{"$ref":"#/types/aws-native:bedrock:AgentActionGroupSignature","description":"If this field is set as `AMAZON.UserInput` , the agent can request the user for additional information when trying to complete a task. The `description` , `apiSchema` , and `actionGroupExecutor` fields must be blank for this action group.\n\nDuring orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an [Observation](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) reprompting the user for more information."},"skipResourceInUseCheckOnDelete":{"type":"boolean","description":"Specifies whether to allow deleting action group while it is in use."}},"type":"object","required":["actionGroupName"]},"aws-native:bedrock:AgentActionGroupExecutor0Properties":{"description":"Type of Executors for an Action Group","properties":{"lambda":{"type":"string","description":"ARN of a Lambda."}},"type":"object","required":["lambda"]},"aws-native:bedrock:AgentActionGroupExecutor1Properties":{"description":"Type of Executors for an Action Group","properties":{"customControl":{"$ref":"#/types/aws-native:bedrock:AgentCustomControlMethod"}},"type":"object","required":["customControl"]},"aws-native:bedrock:AgentActionGroupSignature":{"description":"Action Group Signature for a BuiltIn Action","type":"string","enum":[{"name":"AmazonUserInput","value":"AMAZON.UserInput"},{"name":"AmazonCodeInterpreter","value":"AMAZON.CodeInterpreter"}]},"aws-native:bedrock:AgentActionGroupState":{"description":"State of the action group","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:bedrock:AgentAdditionalModelRequestFields":{"description":"Additional Model Request Fields for Prompt Configuration","type":"object"},"aws-native:bedrock:AgentAliasHistoryEvent":{"description":"History event for an alias for an Agent.","properties":{"endDate":{"type":"string","description":"Time Stamp."},"routingConfiguration":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:AgentAliasRoutingConfigurationListItem"},"description":"Routing configuration for an Agent alias."},"startDate":{"type":"string","description":"Time Stamp."}},"type":"object"},"aws-native:bedrock:AgentAliasRoutingConfigurationListItem":{"description":"Details about the routing configuration for an Agent alias.","properties":{"agentVersion":{"type":"string","description":"Agent Version."}},"type":"object","required":["agentVersion"]},"aws-native:bedrock:AgentAliasStatus":{"description":"The statuses an Agent Alias can be in.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Prepared","value":"PREPARED"},{"name":"Failed","value":"FAILED"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"}]},"aws-native:bedrock:AgentApiSchema0Properties":{"description":"Contains information about the API Schema for the Action Group","properties":{"s3":{"$ref":"#/types/aws-native:bedrock:AgentS3Identifier"}},"type":"object","required":["s3"]},"aws-native:bedrock:AgentApiSchema1Properties":{"description":"Contains information about the API Schema for the Action Group","properties":{"payload":{"type":"string","description":"String OpenAPI Payload"}},"type":"object","required":["payload"]},"aws-native:bedrock:AgentCollaboration":{"description":"Agent collaboration state","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Supervisor","value":"SUPERVISOR"},{"name":"SupervisorRouter","value":"SUPERVISOR_ROUTER"}]},"aws-native:bedrock:AgentCollaborator":{"description":"Agent Collaborator","properties":{"agentDescriptor":{"$ref":"#/types/aws-native:bedrock:AgentCollaboratorAgentDescriptorProperties","description":"Agent descriptor for agent collaborator"},"collaborationInstruction":{"type":"string","description":"Agent collaborator instruction"},"collaboratorName":{"type":"string","description":"Agent collaborator name"},"relayConversationHistory":{"$ref":"#/types/aws-native:bedrock:AgentRelayConversationHistory","description":"The collaborator's relay conversation history."}},"type":"object","required":["agentDescriptor","collaborationInstruction","collaboratorName"]},"aws-native:bedrock:AgentCollaboratorAgentDescriptorProperties":{"description":"Agent descriptor for agent collaborator","properties":{"aliasArn":{"type":"string","description":"Alias ARN for agent descriptor"}},"type":"object"},"aws-native:bedrock:AgentCreationMode":{"description":"Creation Mode for Prompt Configuration.","type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"Overridden","value":"OVERRIDDEN"}]},"aws-native:bedrock:AgentCustomControlMethod":{"description":"Custom control of action execution","type":"string","enum":[{"name":"ReturnControl","value":"RETURN_CONTROL"}]},"aws-native:bedrock:AgentCustomOrchestration":{"description":"Structure for custom orchestration","properties":{"executor":{"$ref":"#/types/aws-native:bedrock:AgentOrchestrationExecutor","description":"The structure of the executor invoking the actions in custom orchestration."}},"type":"object"},"aws-native:bedrock:AgentFunction":{"description":"Function definition","properties":{"description":{"type":"string","description":"Description of function"},"name":{"type":"string","description":"Name for a resource."},"parameters":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:bedrock:AgentParameterDetail"},"description":"The parameters that the agent elicits from the user to fulfill the function."},"requireConfirmation":{"$ref":"#/types/aws-native:bedrock:AgentRequireConfirmation","description":"Contains information if user confirmation is required to invoke the function."}},"type":"object","required":["name"]},"aws-native:bedrock:AgentFunctionSchema":{"description":"Schema of Functions","properties":{"functions":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:AgentFunction"},"description":"List of Function definitions"}},"type":"object","required":["functions"]},"aws-native:bedrock:AgentGuardrailConfiguration":{"description":"Configuration for a guardrail.","properties":{"guardrailIdentifier":{"type":"string","description":"Identifier for the guardrail, could be the id or the arn"},"guardrailVersion":{"type":"string","description":"Version of the guardrail"}},"type":"object"},"aws-native:bedrock:AgentInferenceConfiguration":{"description":"Configuration for inference in prompt configuration","properties":{"maximumLength":{"type":"number","description":"Maximum length of output"},"stopSequences":{"type":"array","items":{"type":"string"},"description":"List of stop sequences"},"temperature":{"type":"number","description":"Controls randomness, higher values increase diversity"},"topK":{"type":"number","description":"Sample from the k most likely next tokens"},"topP":{"type":"number","description":"Cumulative probability cutoff for token selection"}},"type":"object"},"aws-native:bedrock:AgentKnowledgeBase":{"description":"Agent Knowledge Base","properties":{"description":{"type":"string","description":"Description of the Resource."},"knowledgeBaseId":{"type":"string","description":"Identifier for a resource."},"knowledgeBaseState":{"$ref":"#/types/aws-native:bedrock:AgentKnowledgeBaseState","description":"Specifies whether to use the knowledge base or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request."}},"type":"object","required":["description","knowledgeBaseId"]},"aws-native:bedrock:AgentKnowledgeBaseState":{"description":"State of the knowledge base; whether it is enabled or disabled","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:bedrock:AgentMemoryConfiguration":{"description":"Configuration for memory storage","properties":{"enabledMemoryTypes":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:AgentMemoryType"},"description":"The type of memory that is stored."},"sessionSummaryConfiguration":{"$ref":"#/types/aws-native:bedrock:AgentSessionSummaryConfiguration","description":"Contains the configuration for SESSION_SUMMARY memory type enabled for the agent."},"storageDays":{"type":"number","description":"Maximum number of days to store session details"}},"type":"object"},"aws-native:bedrock:AgentMemoryType":{"description":"Memory type","type":"string","enum":[{"name":"SessionSummary","value":"SESSION_SUMMARY"}]},"aws-native:bedrock:AgentOrchestrationExecutor":{"description":"Types of executors for custom orchestration strategy","properties":{"lambda":{"type":"string","description":"ARN of a Lambda."}},"type":"object","required":["lambda"]},"aws-native:bedrock:AgentOrchestrationType":{"description":"Types of orchestration strategy for agents","type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"CustomOrchestration","value":"CUSTOM_ORCHESTRATION"}]},"aws-native:bedrock:AgentParameterDetail":{"description":"Parameter detail","properties":{"description":{"type":"string","description":"Description of function parameter."},"required":{"type":"boolean","description":"Information about if a parameter is required for function call. Default to false."},"type":{"$ref":"#/types/aws-native:bedrock:AgentType","description":"The data type of the parameter."}},"type":"object","required":["type"]},"aws-native:bedrock:AgentPromptConfiguration":{"description":"BasePromptConfiguration per Prompt Type.","properties":{"additionalModelRequestFields":{"$ref":"#/types/aws-native:bedrock:AgentAdditionalModelRequestFields","description":"If the Converse or ConverseStream operations support the model, `additionalModelRequestFields` contains additional inference parameters, beyond the base set of inference parameters in the `inferenceConfiguration` field.\n\nFor more information, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) ."},"basePromptTemplate":{"type":"string","description":"Base Prompt Template."},"foundationModel":{"type":"string","description":"The agent's foundation model."},"inferenceConfiguration":{"$ref":"#/types/aws-native:bedrock:AgentInferenceConfiguration","description":"Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the `promptType` . For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) ."},"parserMode":{"$ref":"#/types/aws-native:bedrock:AgentCreationMode","description":"Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the `promptType` . If you set the field as `OVERRIDDEN` , the `overrideLambda` field in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) must be specified with the ARN of a Lambda function."},"promptCreationMode":{"$ref":"#/types/aws-native:bedrock:AgentCreationMode","description":"Specifies whether to override the default prompt template for this `promptType` . Set this value to `OVERRIDDEN` to use the prompt that you provide in the `basePromptTemplate` . If you leave it as `DEFAULT` , the agent uses a default prompt template."},"promptState":{"$ref":"#/types/aws-native:bedrock:AgentPromptState","description":"Specifies whether to allow the inline agent to carry out the step specified in the `promptType` . If you set this value to `DISABLED` , the agent skips that step. The default state for each `promptType` is as follows.\n\n- `PRE_PROCESSING` – `ENABLED`\n- `ORCHESTRATION` – `ENABLED`\n- `KNOWLEDGE_BASE_RESPONSE_GENERATION` – `ENABLED`\n- `POST_PROCESSING` – `DISABLED`"},"promptType":{"$ref":"#/types/aws-native:bedrock:AgentPromptType","description":"The step in the agent sequence that this prompt configuration applies to."}},"type":"object"},"aws-native:bedrock:AgentPromptOverrideConfiguration":{"description":"Configuration for prompt override.","properties":{"overrideLambda":{"type":"string","description":"ARN of a Lambda."},"promptConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:AgentPromptConfiguration"},"description":"List of BasePromptConfiguration"}},"type":"object","required":["promptConfigurations"]},"aws-native:bedrock:AgentPromptState":{"description":"Prompt State.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:bedrock:AgentPromptType":{"description":"Prompt Type.","type":"string","enum":[{"name":"PreProcessing","value":"PRE_PROCESSING"},{"name":"Orchestration","value":"ORCHESTRATION"},{"name":"PostProcessing","value":"POST_PROCESSING"},{"name":"RoutingClassifier","value":"ROUTING_CLASSIFIER"},{"name":"MemorySummarization","value":"MEMORY_SUMMARIZATION"},{"name":"KnowledgeBaseResponseGeneration","value":"KNOWLEDGE_BASE_RESPONSE_GENERATION"}]},"aws-native:bedrock:AgentRelayConversationHistory":{"description":"Relay conversation history state","type":"string","enum":[{"name":"ToCollaborator","value":"TO_COLLABORATOR"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:bedrock:AgentRequireConfirmation":{"description":"ENUM to check if action requires user confirmation","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:bedrock:AgentS3Identifier":{"description":"The identifier for the S3 resource.","properties":{"s3BucketName":{"type":"string","description":"A bucket in S3."},"s3ObjectKey":{"type":"string","description":"A object key in S3."}},"type":"object"},"aws-native:bedrock:AgentSessionSummaryConfiguration":{"description":"Configuration for Session Summarization","properties":{"maxRecentSessions":{"type":"number","description":"Maximum number of Sessions to Summarize"}},"type":"object"},"aws-native:bedrock:AgentStatus":{"description":"Schema Type for Action APIs.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Preparing","value":"PREPARING"},{"name":"Prepared","value":"PREPARED"},{"name":"NotPrepared","value":"NOT_PREPARED"},{"name":"Deleting","value":"DELETING"},{"name":"Failed","value":"FAILED"},{"name":"Versioning","value":"VERSIONING"},{"name":"Updating","value":"UPDATING"}]},"aws-native:bedrock:AgentType":{"description":"Parameter Type","type":"string","enum":[{"name":"String","value":"string"},{"name":"Number","value":"number"},{"name":"Integer","value":"integer"},{"name":"Boolean","value":"boolean"},{"name":"Array","value":"array"}]},"aws-native:bedrock:ApplicationInferenceProfileInferenceProfileModel":{"description":"Model configuration","properties":{"modelArn":{"type":"string","description":"ARN for Foundation Models in Bedrock. These models can be used as base models for model customization jobs"}},"type":"object"},"aws-native:bedrock:ApplicationInferenceProfileInferenceProfileModelSource0Properties":{"description":"Various ways to encode a list of models in a CreateInferenceProfile request","properties":{"copyFrom":{"type":"string","description":"Source arns for a custom inference profile to copy its regional load balancing config from. This\ncan either be a foundation model or predefined inference profile ARN."}},"type":"object","required":["copyFrom"]},"aws-native:bedrock:ApplicationInferenceProfileInferenceProfileModelSourceProperties":{"description":"Various ways to encode a list of models in a CreateInferenceProfile request","properties":{"copyFrom":{"type":"string","description":"Source arns for a custom inference profile to copy its regional load balancing config from. This\ncan either be a foundation model or predefined inference profile ARN."}},"type":"object","required":["copyFrom"]},"aws-native:bedrock:ApplicationInferenceProfileInferenceProfileStatus":{"description":"Status of the Inference Profile","type":"string","enum":[{"name":"Active","value":"ACTIVE"}]},"aws-native:bedrock:ApplicationInferenceProfileInferenceProfileType":{"description":"Type of the Inference Profile","type":"string","enum":[{"name":"Application","value":"APPLICATION"},{"name":"SystemDefined","value":"SYSTEM_DEFINED"}]},"aws-native:bedrock:ApplicationInferenceProfileTag":{"description":"Definition of the key/value pair for a tag","properties":{"key":{"type":"string","description":"Tag Key"},"value":{"type":"string","description":"Tag Value"}},"type":"object","required":["key","value"]},"aws-native:bedrock:AutomatedReasoningPolicyPolicyDefinition":{"properties":{"rules":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:AutomatedReasoningPolicyPolicyDefinitionRule"},"description":"The rules definition block of an AutomatedReasoningPolicyDefinition."},"types":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:AutomatedReasoningPolicyPolicyDefinitionType"},"description":"The types definition block of an AutomatedReasoningPolicyDefinition."},"variables":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:AutomatedReasoningPolicyPolicyDefinitionVariable"},"description":"The variables definition block of an AutomatedReasoningPolicyDefinition."},"version":{"type":"string","description":"The policy format version."}},"type":"object"},"aws-native:bedrock:AutomatedReasoningPolicyPolicyDefinitionRule":{"properties":{"alternateExpression":{"type":"string","description":"An alternate expression for this rule"},"expression":{"type":"string","description":"The SMT expression for this rule"},"id":{"type":"string","description":"A unique id within the PolicyDefinition"}},"type":"object","required":["expression","id"]},"aws-native:bedrock:AutomatedReasoningPolicyPolicyDefinitionType":{"properties":{"description":{"type":"string","description":"A natural language description of this type."},"name":{"type":"string","description":"A name for this type."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:AutomatedReasoningPolicyPolicyDefinitionTypeValue"},"description":"A list of valid values for this type."}},"type":"object","required":["name","values"]},"aws-native:bedrock:AutomatedReasoningPolicyPolicyDefinitionTypeValue":{"properties":{"description":{"type":"string","description":"A natural language description of the type's value."},"value":{"type":"string","description":"The value of the type value."}},"type":"object","required":["value"]},"aws-native:bedrock:AutomatedReasoningPolicyPolicyDefinitionVariable":{"properties":{"description":{"type":"string","description":"A natural language description of this variable."},"name":{"type":"string","description":"A name from this variable."},"type":{"type":"string","description":"A type for this variable."}},"type":"object","required":["description","name","type"]},"aws-native:bedrock:AutomatedReasoningPolicyTag":{"description":"Definition of the key/value pair for a tag","properties":{"key":{"type":"string","description":"Tag Key"},"value":{"type":"string","description":"Tag Value"}},"type":"object","required":["key","value"]},"aws-native:bedrock:AutomatedReasoningPolicyVersionTag":{"description":"Definition of the key/value pair for a tag","properties":{"key":{"type":"string","description":"Tag Key"},"value":{"type":"string","description":"Tag Value"}},"type":"object","required":["key","value"]},"aws-native:bedrock:BlueprintStage":{"description":"Stage of the Blueprint","type":"string","enum":[{"name":"Development","value":"DEVELOPMENT"},{"name":"Live","value":"LIVE"}]},"aws-native:bedrock:BlueprintTag":{"description":"Definition of the key/value pair for a tag","properties":{"key":{"type":"string","description":"Key for the tag"},"value":{"type":"string","description":"Value for the tag"}},"type":"object","required":["key","value"]},"aws-native:bedrock:BlueprintType":{"description":"Modality Type","type":"string","enum":[{"name":"Document","value":"DOCUMENT"},{"name":"Image","value":"IMAGE"},{"name":"Audio","value":"AUDIO"},{"name":"Video","value":"VIDEO"}]},"aws-native:bedrock:DataAutomationProjectAudioExtractionCategory":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Whether generating categorical data from audio is enabled."},"typeConfiguration":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectAudioExtractionCategoryTypeConfiguration","description":"This element contains information about extractions from different types. Used to enable speaker and channel labeling for transcripts."},"types":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectAudioExtractionCategoryType"},"description":"The types of data to generate."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectAudioExtractionCategoryType":{"type":"string","enum":[{"name":"AudioContentModeration","value":"AUDIO_CONTENT_MODERATION"},{"name":"Transcript","value":"TRANSCRIPT"},{"name":"TopicContentModeration","value":"TOPIC_CONTENT_MODERATION"}]},"aws-native:bedrock:DataAutomationProjectAudioExtractionCategoryTypeConfiguration":{"properties":{"transcript":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectTranscriptConfiguration","description":"This element allows you to configure different extractions for your transcript data, such as speaker and channel labeling."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectAudioGenerativeOutputLanguage":{"type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"En","value":"EN"}]},"aws-native:bedrock:DataAutomationProjectAudioLanguageConfiguration":{"properties":{"generativeOutputLanguage":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectAudioGenerativeOutputLanguage","description":"The output language of your processing results. This can either be set to `EN` (English) or `DEFAULT` which will output the results in the dominant language of the audio. The dominant language is determined as the language in the audio, spoken the longest in the input audio."},"identifyMultipleLanguages":{"type":"boolean","description":"The toggle determining if you want to detect multiple languages from your audio."},"inputLanguages":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectLanguage"},"description":"The input language of your audio. This can be set to any of the currently supported languages via the language codes."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectAudioOverrideConfiguration":{"properties":{"languageConfiguration":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectAudioLanguageConfiguration","description":"The output and input language configuration for your audio."},"modalityProcessing":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectModalityProcessingConfiguration","description":"Sets modality processing for audio files. All modalities are enabled by default."},"sensitiveDataConfiguration":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectSensitiveDataConfiguration","description":"Configuration for sensitive data detection and redaction for audio files."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectAudioStandardExtraction":{"properties":{"category":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectAudioExtractionCategory","description":"Settings for generating data from audio."}},"type":"object","required":["category"]},"aws-native:bedrock:DataAutomationProjectAudioStandardGenerativeField":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Whether generating descriptions is enabled for audio."},"types":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectAudioStandardGenerativeFieldType"},"description":"The types of description to generate."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectAudioStandardGenerativeFieldType":{"type":"string","enum":[{"name":"AudioSummary","value":"AUDIO_SUMMARY"},{"name":"Iab","value":"IAB"},{"name":"TopicSummary","value":"TOPIC_SUMMARY"}]},"aws-native:bedrock:DataAutomationProjectAudioStandardOutputConfiguration":{"properties":{"extraction":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectAudioStandardExtraction","description":"Settings for populating data fields that describe the audio."},"generativeField":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectAudioStandardGenerativeField","description":"Whether to generate descriptions of the data."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectBlueprintItem":{"properties":{"blueprintArn":{"type":"string","description":"ARN of a Blueprint"},"blueprintStage":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectBlueprintStage","description":"The blueprint's stage."},"blueprintVersion":{"type":"string","description":"Blueprint Version"}},"type":"object","required":["blueprintArn"]},"aws-native:bedrock:DataAutomationProjectBlueprintStage":{"description":"Stage of the Blueprint","type":"string","enum":[{"name":"Development","value":"DEVELOPMENT"},{"name":"Live","value":"LIVE"}]},"aws-native:bedrock:DataAutomationProjectChannelLabelingConfiguration":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"State of channel labeling, either enabled or disabled."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectCustomOutputConfiguration":{"description":"Custom output configuration","properties":{"blueprints":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectBlueprintItem"},"description":"A list of blueprints."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectDesiredModality":{"type":"string","enum":[{"name":"Document","value":"DOCUMENT"},{"name":"Image","value":"IMAGE"},{"name":"Video","value":"VIDEO"},{"name":"Audio","value":"AUDIO"}]},"aws-native:bedrock:DataAutomationProjectDocumentBoundingBox":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Whether bounding boxes are enabled for documents."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectDocumentExtractionGranularity":{"properties":{"types":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDocumentExtractionGranularityType"},"description":"Granularity settings for documents."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectDocumentExtractionGranularityType":{"type":"string","enum":[{"name":"Document","value":"DOCUMENT"},{"name":"Page","value":"PAGE"},{"name":"Element","value":"ELEMENT"},{"name":"Word","value":"WORD"},{"name":"Line","value":"LINE"}]},"aws-native:bedrock:DataAutomationProjectDocumentOutputAdditionalFileFormat":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Whether additional file formats are enabled for a project."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectDocumentOutputFormat":{"properties":{"additionalFileFormat":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDocumentOutputAdditionalFileFormat","description":"Output settings for additional file formats."},"textFormat":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDocumentOutputTextFormat","description":"An output text format."}},"type":"object","required":["additionalFileFormat","textFormat"]},"aws-native:bedrock:DataAutomationProjectDocumentOutputTextFormat":{"properties":{"types":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDocumentOutputTextFormatType"},"description":"The types of output text to generate."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectDocumentOutputTextFormatType":{"type":"string","enum":[{"name":"PlainText","value":"PLAIN_TEXT"},{"name":"Markdown","value":"MARKDOWN"},{"name":"Html","value":"HTML"},{"name":"Csv","value":"CSV"}]},"aws-native:bedrock:DataAutomationProjectDocumentOverrideConfiguration":{"properties":{"modalityProcessing":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectModalityProcessingConfiguration","description":"Sets modality processing for document files. All modalities are enabled by default."},"sensitiveDataConfiguration":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectSensitiveDataConfiguration","description":"Configuration for sensitive data detection and redaction for document files."},"splitter":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectSplitterConfiguration","description":"Whether document splitter is enabled for a project."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectDocumentStandardExtraction":{"properties":{"boundingBox":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDocumentBoundingBox","description":"Whether to generate bounding boxes."},"granularity":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDocumentExtractionGranularity","description":"Which granularities to generate data for."}},"type":"object","required":["boundingBox","granularity"]},"aws-native:bedrock:DataAutomationProjectDocumentStandardGenerativeField":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Whether generating descriptions is enabled for documents."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectDocumentStandardOutputConfiguration":{"properties":{"extraction":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDocumentStandardExtraction","description":"Settings for populating data fields that describe the document."},"generativeField":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDocumentStandardGenerativeField","description":"Whether to generate descriptions."},"outputFormat":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDocumentOutputFormat","description":"The output format to generate."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectImageBoundingBox":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Bounding box settings for a project."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectImageExtractionCategory":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Whether generating categorical data from images is enabled."},"types":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectImageExtractionCategoryType"},"description":"The types of data to generate."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectImageExtractionCategoryType":{"type":"string","enum":[{"name":"ContentModeration","value":"CONTENT_MODERATION"},{"name":"TextDetection","value":"TEXT_DETECTION"},{"name":"Logos","value":"LOGOS"}]},"aws-native:bedrock:DataAutomationProjectImageOverrideConfiguration":{"properties":{"modalityProcessing":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectModalityProcessingConfiguration","description":"Sets modality processing for image files. All modalities are enabled by default."},"sensitiveDataConfiguration":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectSensitiveDataConfiguration","description":"Configuration for sensitive data detection and redaction for image files."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectImageStandardExtraction":{"properties":{"boundingBox":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectImageBoundingBox","description":"Settings for generating bounding boxes."},"category":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectImageExtractionCategory","description":"Settings for generating categorical data."}},"type":"object","required":["boundingBox","category"]},"aws-native:bedrock:DataAutomationProjectImageStandardGenerativeField":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Whether generating descriptions is enabled for images."},"types":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectImageStandardGenerativeFieldType"},"description":"Settings for generating descriptions of images."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectImageStandardGenerativeFieldType":{"type":"string","enum":[{"name":"ImageSummary","value":"IMAGE_SUMMARY"},{"name":"Iab","value":"IAB"}]},"aws-native:bedrock:DataAutomationProjectImageStandardOutputConfiguration":{"properties":{"extraction":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectImageStandardExtraction","description":"Settings for populating data fields that describe the image."},"generativeField":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectImageStandardGenerativeField","description":"Whether to generate descriptions of the data."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectLanguage":{"type":"string","enum":[{"name":"En","value":"EN"},{"name":"De","value":"DE"},{"name":"Es","value":"ES"},{"name":"Fr","value":"FR"},{"name":"It","value":"IT"},{"name":"Pt","value":"PT"},{"name":"Ja","value":"JA"},{"name":"Ko","value":"KO"},{"name":"Cn","value":"CN"},{"name":"Tw","value":"TW"},{"name":"Hk","value":"HK"}]},"aws-native:bedrock:DataAutomationProjectModalityProcessingConfiguration":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Stores the state of the modality for your project, set to either enabled or disabled"}},"type":"object"},"aws-native:bedrock:DataAutomationProjectModalityRoutingConfiguration":{"description":"Modality routing configuration","properties":{"jpeg":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDesiredModality","description":"Sets whether JPEG files are routed to document or image processing."},"mov":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDesiredModality","description":"Sets whether MOV files are routed to audio or video processing."},"mp4":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDesiredModality","description":"Sets whether MP4 files are routed to audio or video processing."},"png":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDesiredModality","description":"Sets whether PNG files are routed to document or image processing."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectOverrideConfiguration":{"description":"Override configuration","properties":{"audio":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectAudioOverrideConfiguration","description":"This element declares whether your project will process audio files."},"document":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDocumentOverrideConfiguration","description":"Additional settings for a project."},"image":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectImageOverrideConfiguration","description":"This element declares whether your project will process image files."},"modalityRouting":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectModalityRoutingConfiguration","description":"Lets you set which modalities certain file types are processed as."},"video":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectVideoOverrideConfiguration","description":"This element declares whether your project will process video files."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectPiiEntitiesConfiguration":{"properties":{"piiEntityTypes":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectPiiEntityTypes"},"description":"List of PII entity types to detect/redact in the output. Choose from specific entity types (such as ADDRESS, NAME, EMAIL, PHONE, US_SOCIAL_SECURITY_NUMBER) or specify ALL to detect all supported PII types. If not specified, defaults to ALL."},"redactionMaskMode":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectPiiRedactionMaskMode","description":"Defines how detected PII entities are masked in redacted output files. Set to PII to replace all detected entities with a generic [PII] marker regardless of entity type. Set to ENTITY_TYPE to replace each detected entity with its specific type marker (for example, [NAME], [EMAIL], [ADDRESS]). This setting only applies when detectionMode is set to DETECTION_AND_REDACTION. If not specified, defaults to ENTITY_TYPE."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectPiiEntityTypes":{"type":"string","enum":[{"name":"All","value":"ALL"},{"name":"Address","value":"ADDRESS"},{"name":"Age","value":"AGE"},{"name":"Name","value":"NAME"},{"name":"Email","value":"EMAIL"},{"name":"Phone","value":"PHONE"},{"name":"Username","value":"USERNAME"},{"name":"Password","value":"PASSWORD"},{"name":"DriverId","value":"DRIVER_ID"},{"name":"LicensePlate","value":"LICENSE_PLATE"},{"name":"VehicleIdentificationNumber","value":"VEHICLE_IDENTIFICATION_NUMBER"},{"name":"CreditDebitCardCvv","value":"CREDIT_DEBIT_CARD_CVV"},{"name":"CreditDebitCardExpiry","value":"CREDIT_DEBIT_CARD_EXPIRY"},{"name":"CreditDebitCardNumber","value":"CREDIT_DEBIT_CARD_NUMBER"},{"name":"Pin","value":"PIN"},{"name":"InternationalBankAccountNumber","value":"INTERNATIONAL_BANK_ACCOUNT_NUMBER"},{"name":"SwiftCode","value":"SWIFT_CODE"},{"name":"IpAddress","value":"IP_ADDRESS"},{"name":"MacAddress","value":"MAC_ADDRESS"},{"name":"Url","value":"URL"},{"name":"AwsAccessKey","value":"AWS_ACCESS_KEY"},{"name":"AwsSecretKey","value":"AWS_SECRET_KEY"},{"name":"UsBankAccountNumber","value":"US_BANK_ACCOUNT_NUMBER"},{"name":"UsBankRoutingNumber","value":"US_BANK_ROUTING_NUMBER"},{"name":"UsIndividualTaxIdentificationNumber","value":"US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"},{"name":"UsPassportNumber","value":"US_PASSPORT_NUMBER"},{"name":"UsSocialSecurityNumber","value":"US_SOCIAL_SECURITY_NUMBER"},{"name":"CaHealthNumber","value":"CA_HEALTH_NUMBER"},{"name":"CaSocialInsuranceNumber","value":"CA_SOCIAL_INSURANCE_NUMBER"},{"name":"UkNationalHealthServiceNumber","value":"UK_NATIONAL_HEALTH_SERVICE_NUMBER"},{"name":"UkNationalInsuranceNumber","value":"UK_NATIONAL_INSURANCE_NUMBER"},{"name":"UkUniqueTaxpayerReferenceNumber","value":"UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"}]},"aws-native:bedrock:DataAutomationProjectPiiRedactionMaskMode":{"type":"string","enum":[{"name":"Pii","value":"PII"},{"name":"EntityType","value":"ENTITY_TYPE"}]},"aws-native:bedrock:DataAutomationProjectProjectType":{"description":"Type of the DataAutomationProject - Sync or Async","type":"string","enum":[{"name":"Async","value":"ASYNC"},{"name":"Sync","value":"SYNC"}]},"aws-native:bedrock:DataAutomationProjectSensitiveDataConfiguration":{"properties":{"detectionMode":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectSensitiveDataDetectionMode","description":"Specifies the mode for handling sensitive data detection. Set to DETECTION to only identify sensitive data without modifying content - this produces one output file per detection scope containing detection information with original unredacted content. Set to DETECTION_AND_REDACTION to both identify and mask sensitive data - this produces two output files per detection scope: one unredacted file with detection information and one redacted file with masking applied to sensitive content. For example, if detectionScope includes both STANDARD and CUSTOM with DETECTION_AND_REDACTION mode, four output files will be generated (two for standard output and two for custom output)."},"detectionScope":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectSensitiveDataDetectionScope"},"description":"Defines which BDA output types to apply sensitive data detection to. Specify STANDARD to detect sensitive data in standard output, CUSTOM to detect in custom output (blueprint-based extraction), or both to apply detection to both output types. If not specified, defaults to both STANDARD and CUSTOM. The number of output files generated depends on both the detection mode and the scopes selected - each scope specified will produce its own set of output files according to the detection mode configured."},"piiEntitiesConfiguration":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectPiiEntitiesConfiguration","description":"Configuration for detecting and redacting Personally Identifiable Information (PII) entities."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectSensitiveDataDetectionMode":{"type":"string","enum":[{"name":"Detection","value":"DETECTION"},{"name":"DetectionAndRedaction","value":"DETECTION_AND_REDACTION"}]},"aws-native:bedrock:DataAutomationProjectSensitiveDataDetectionScope":{"type":"string","enum":[{"name":"Standard","value":"STANDARD"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:bedrock:DataAutomationProjectSpeakerLabelingConfiguration":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"State of speaker labeling, either enabled or disabled."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectSplitterConfiguration":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Whether document splitter is enabled for a project."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectStage":{"description":"Stage of the Project","type":"string","enum":[{"name":"Development","value":"DEVELOPMENT"},{"name":"Live","value":"LIVE"}]},"aws-native:bedrock:DataAutomationProjectStandardOutputConfiguration":{"description":"Standard output configuration","properties":{"audio":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectAudioStandardOutputConfiguration","description":"Settings for processing audio."},"document":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectDocumentStandardOutputConfiguration","description":"Settings for processing documents."},"image":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectImageStandardOutputConfiguration","description":"Settings for processing images."},"video":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectVideoStandardOutputConfiguration","description":"Settings for processing video."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectState":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:bedrock:DataAutomationProjectStatus":{"type":"string","enum":[{"name":"Completed","value":"COMPLETED"},{"name":"InProgress","value":"IN_PROGRESS"},{"name":"Failed","value":"FAILED"}]},"aws-native:bedrock:DataAutomationProjectTag":{"description":"Definition of the key/value pair for a tag","properties":{"key":{"type":"string","description":"Key for the tag"},"value":{"type":"string","description":"Value for the tag"}},"type":"object","required":["key","value"]},"aws-native:bedrock:DataAutomationProjectTranscriptConfiguration":{"properties":{"channelLabeling":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectChannelLabelingConfiguration","description":"Enables channel labeling. Each audio channel will be labeled with a number, and the transcript will indicate which channel is being used."},"speakerLabeling":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectSpeakerLabelingConfiguration","description":"Enables speaker labeling. Each speaker within a transcript will recieve a number, and the transcript will note which speaker is talking."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectVideoBoundingBox":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Whether bounding boxes are enabled for video."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectVideoExtractionCategory":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Whether generating categorical data from video is enabled."},"types":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectVideoExtractionCategoryType"},"description":"The types of data to generate."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectVideoExtractionCategoryType":{"type":"string","enum":[{"name":"ContentModeration","value":"CONTENT_MODERATION"},{"name":"TextDetection","value":"TEXT_DETECTION"},{"name":"Transcript","value":"TRANSCRIPT"},{"name":"Logos","value":"LOGOS"}]},"aws-native:bedrock:DataAutomationProjectVideoOverrideConfiguration":{"properties":{"modalityProcessing":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectModalityProcessingConfiguration","description":"Sets modality processing for video files. All modalities are enabled by default."},"sensitiveDataConfiguration":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectSensitiveDataConfiguration","description":"Configuration for sensitive data detection and redaction for video files."}},"type":"object"},"aws-native:bedrock:DataAutomationProjectVideoStandardExtraction":{"properties":{"boundingBox":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectVideoBoundingBox","description":"Settings for generating bounding boxes."},"category":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectVideoExtractionCategory","description":"Settings for generating categorical data."}},"type":"object","required":["boundingBox","category"]},"aws-native:bedrock:DataAutomationProjectVideoStandardGenerativeField":{"properties":{"state":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectState","description":"Whether generating descriptions is enabled for video."},"types":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectVideoStandardGenerativeFieldType"},"description":"The types of description to generate."}},"type":"object","required":["state"]},"aws-native:bedrock:DataAutomationProjectVideoStandardGenerativeFieldType":{"type":"string","enum":[{"name":"VideoSummary","value":"VIDEO_SUMMARY"},{"name":"Iab","value":"IAB"},{"name":"ChapterSummary","value":"CHAPTER_SUMMARY"}]},"aws-native:bedrock:DataAutomationProjectVideoStandardOutputConfiguration":{"properties":{"extraction":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectVideoStandardExtraction","description":"Settings for populating data fields that describe the video."},"generativeField":{"$ref":"#/types/aws-native:bedrock:DataAutomationProjectVideoStandardGenerativeField","description":"Whether to generate descriptions of the video."}},"type":"object"},"aws-native:bedrock:DataSourceBedrockDataAutomationConfiguration":{"description":"Settings for a Bedrock Data Automation used to parse documents for a data source.","properties":{"parsingModality":{"$ref":"#/types/aws-native:bedrock:DataSourceParsingModality","description":"Specifies whether to enable parsing of multimodal data, including both text and/or images."}},"type":"object"},"aws-native:bedrock:DataSourceBedrockFoundationModelConfiguration":{"description":"Settings for a foundation model used to parse documents for a data source.","properties":{"modelArn":{"type":"string","description":"The ARN of the foundation model to use for parsing."},"parsingModality":{"$ref":"#/types/aws-native:bedrock:DataSourceParsingModality","description":"Specifies whether to enable parsing of multimodal data, including both text and/or images."},"parsingPrompt":{"$ref":"#/types/aws-native:bedrock:DataSourceParsingPrompt","description":"Instructions for interpreting the contents of a document."}},"type":"object","required":["modelArn"]},"aws-native:bedrock:DataSourceBedrockFoundationModelContextEnrichmentConfiguration":{"description":"Bedrock Foundation Model configuration to be used for Context Enrichment.","properties":{"enrichmentStrategyConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceEnrichmentStrategyConfiguration","description":"The enrichment stategy used to provide additional context. For example, Neptune GraphRAG uses Amazon Bedrock foundation models to perform chunk entity extraction."},"modelArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base."}},"type":"object","required":["enrichmentStrategyConfiguration","modelArn"]},"aws-native:bedrock:DataSourceChunkingConfiguration":{"description":"Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.","properties":{"chunkingStrategy":{"$ref":"#/types/aws-native:bedrock:DataSourceChunkingStrategy","description":"Knowledge base can split your source data into chunks. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for `NONE` , then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.\n\n- `FIXED_SIZE` – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the `fixedSizeChunkingConfiguration` .\n- `HIERARCHICAL` – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.\n- `SEMANTIC` – Split documents into chunks based on groups of similar content derived with natural language processing.\n- `NONE` – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files."},"fixedSizeChunkingConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceFixedSizeChunkingConfiguration","description":"Configurations for when you choose fixed-size chunking. If you set the `chunkingStrategy` as `NONE` , exclude this field."},"hierarchicalChunkingConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceHierarchicalChunkingConfiguration","description":"Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer."},"semanticChunkingConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceSemanticChunkingConfiguration","description":"Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing."}},"type":"object","required":["chunkingStrategy"]},"aws-native:bedrock:DataSourceChunkingStrategy":{"description":"Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.","type":"string","enum":[{"name":"FixedSize","value":"FIXED_SIZE"},{"name":"None","value":"NONE"},{"name":"Hierarchical","value":"HIERARCHICAL"},{"name":"Semantic","value":"SEMANTIC"}]},"aws-native:bedrock:DataSourceConfiguration":{"description":"Specifies a raw data source location to ingest.","properties":{"confluenceConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceConfluenceDataSourceConfiguration","description":"The configuration information to connect to Confluence as your data source.\n\n\u003e Confluence data source connector is in preview release and is subject to change."},"s3Configuration":{"$ref":"#/types/aws-native:bedrock:DataSourceS3DataSourceConfiguration","description":"The configuration information to connect to Amazon S3 as your data source."},"salesforceConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceSalesforceDataSourceConfiguration","description":"The configuration information to connect to Salesforce as your data source.\n\n\u003e Salesforce data source connector is in preview release and is subject to change."},"sharePointConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceSharePointDataSourceConfiguration","description":"The configuration information to connect to SharePoint as your data source.\n\n\u003e SharePoint data source connector is in preview release and is subject to change."},"type":{"$ref":"#/types/aws-native:bedrock:DataSourceType","description":"The type of data source.","replaceOnChanges":true},"webConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceWebDataSourceConfiguration","description":"The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs.\n\n\u003e Crawling web URLs as your data source is in preview release and is subject to change."}},"type":"object","required":["type"]},"aws-native:bedrock:DataSourceConfluenceCrawlerConfiguration":{"description":"The configuration of the Confluence content. For example, configuring specific types of Confluence content.","properties":{"filterConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceCrawlFilterConfiguration","description":"The configuration of filtering the Confluence content. For example, configuring regular expression patterns to include or exclude certain content."}},"type":"object"},"aws-native:bedrock:DataSourceConfluenceDataSourceConfiguration":{"description":"The configuration information to connect to Confluence as your data source.","properties":{"crawlerConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceConfluenceCrawlerConfiguration","description":"The configuration of the Confluence content. For example, configuring specific types of Confluence content."},"sourceConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceConfluenceSourceConfiguration","description":"The endpoint information to connect to your Confluence data source."}},"type":"object","required":["sourceConfiguration"]},"aws-native:bedrock:DataSourceConfluenceSourceConfiguration":{"description":"The endpoint information to connect to your Confluence data source.","properties":{"authType":{"$ref":"#/types/aws-native:bedrock:DataSourceConfluenceSourceConfigurationAuthType","description":"The supported authentication type to authenticate and connect to your Confluence instance."},"credentialsSecretArn":{"type":"string","description":"The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Confluence connection configuration."},"hostType":{"$ref":"#/types/aws-native:bedrock:DataSourceConfluenceSourceConfigurationHostType","description":"The supported host type, whether online/cloud or server/on-premises."},"hostUrl":{"type":"string","description":"The Confluence host URL or instance URL."}},"type":"object","required":["authType","credentialsSecretArn","hostType","hostUrl"]},"aws-native:bedrock:DataSourceConfluenceSourceConfigurationAuthType":{"description":"The supported authentication type to authenticate and connect to your Confluence instance.","type":"string","enum":[{"name":"Basic","value":"BASIC"},{"name":"Oauth2ClientCredentials","value":"OAUTH2_CLIENT_CREDENTIALS"}]},"aws-native:bedrock:DataSourceConfluenceSourceConfigurationHostType":{"description":"The supported host type, whether online/cloud or server/on-premises.","type":"string","enum":[{"name":"Saas","value":"SAAS"}]},"aws-native:bedrock:DataSourceContextEnrichmentConfiguration":{"description":"Additional Enrichment Configuration for example when using GraphRag.","properties":{"bedrockFoundationModelConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceBedrockFoundationModelContextEnrichmentConfiguration","description":"The configuration of the Amazon Bedrock foundation model used for context enrichment."},"type":{"$ref":"#/types/aws-native:bedrock:DataSourceContextEnrichmentType","description":"The method used for context enrichment. It must be Amazon Bedrock foundation models."}},"type":"object","required":["type"]},"aws-native:bedrock:DataSourceContextEnrichmentType":{"description":"Enrichment type to be used for the vector database.","type":"string","enum":[{"name":"BedrockFoundationModel","value":"BEDROCK_FOUNDATION_MODEL"}]},"aws-native:bedrock:DataSourceCrawlFilterConfiguration":{"description":"The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.","properties":{"patternObjectFilter":{"$ref":"#/types/aws-native:bedrock:DataSourcePatternObjectFilterConfiguration","description":"The configuration of filtering certain objects or content types of the data source."},"type":{"$ref":"#/types/aws-native:bedrock:DataSourceCrawlFilterConfigurationType","description":"The crawl filter type."}},"type":"object","required":["type"]},"aws-native:bedrock:DataSourceCrawlFilterConfigurationType":{"description":"The crawl filter type.","type":"string","enum":[{"name":"Pattern","value":"PATTERN"}]},"aws-native:bedrock:DataSourceCustomTransformationConfiguration":{"description":"Settings for customizing steps in the data source content ingestion pipeline.","properties":{"intermediateStorage":{"$ref":"#/types/aws-native:bedrock:DataSourceIntermediateStorage","description":"An S3 bucket path for input and output objects."},"transformations":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataSourceTransformation"},"description":"A list of Lambda functions that process documents."}},"type":"object","required":["intermediateStorage","transformations"]},"aws-native:bedrock:DataSourceDataDeletionPolicy":{"description":"The deletion policy for the data source.","type":"string","enum":[{"name":"Retain","value":"RETAIN"},{"name":"Delete","value":"DELETE"}]},"aws-native:bedrock:DataSourceEnrichmentStrategyConfiguration":{"description":"Strategy to be used when using Bedrock Foundation Model for Context Enrichment.","properties":{"method":{"$ref":"#/types/aws-native:bedrock:DataSourceEnrichmentStrategyMethod","description":"The method used for the context enrichment strategy."}},"type":"object","required":["method"]},"aws-native:bedrock:DataSourceEnrichmentStrategyMethod":{"description":"Enrichment Strategy method.","type":"string","enum":[{"name":"ChunkEntityExtraction","value":"CHUNK_ENTITY_EXTRACTION"}]},"aws-native:bedrock:DataSourceFixedSizeChunkingConfiguration":{"description":"Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.","properties":{"maxTokens":{"type":"integer","description":"The maximum number of tokens to include in a chunk."},"overlapPercentage":{"type":"integer","description":"The percentage of overlap between adjacent chunks of a data source."}},"type":"object","required":["maxTokens","overlapPercentage"]},"aws-native:bedrock:DataSourceHierarchicalChunkingConfiguration":{"description":"Configurations for when you choose hierarchical chunking. If you set the chunkingStrategy as NONE, exclude this field.","properties":{"levelConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataSourceHierarchicalChunkingLevelConfiguration"},"description":"Token settings for each layer."},"overlapTokens":{"type":"integer","description":"The number of tokens to repeat across chunks in the same layer."}},"type":"object","required":["levelConfigurations","overlapTokens"]},"aws-native:bedrock:DataSourceHierarchicalChunkingLevelConfiguration":{"description":"Token settings for a layer in a hierarchical chunking configuration.","properties":{"maxTokens":{"type":"integer","description":"The maximum number of tokens that a chunk can contain in this layer."}},"type":"object","required":["maxTokens"]},"aws-native:bedrock:DataSourceIntermediateStorage":{"description":"A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline.","properties":{"s3Location":{"$ref":"#/types/aws-native:bedrock:DataSourceS3Location","description":"An S3 bucket path."}},"type":"object","required":["s3Location"]},"aws-native:bedrock:DataSourceParsingConfiguration":{"description":"Settings for parsing document contents","properties":{"bedrockDataAutomationConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceBedrockDataAutomationConfiguration","description":"If you specify `BEDROCK_DATA_AUTOMATION` as the parsing strategy for ingesting your data source, use this object to modify configurations for using the Amazon Bedrock Data Automation parser."},"bedrockFoundationModelConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceBedrockFoundationModelConfiguration","description":"If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents."},"parsingStrategy":{"$ref":"#/types/aws-native:bedrock:DataSourceParsingStrategy","description":"The parsing strategy for the data source."}},"type":"object","required":["parsingStrategy"]},"aws-native:bedrock:DataSourceParsingModality":{"description":"Determine how will parsed content be stored.","type":"string","enum":[{"name":"Multimodal","value":"MULTIMODAL"}]},"aws-native:bedrock:DataSourceParsingPrompt":{"description":"Instructions for interpreting the contents of a document.","properties":{"parsingPromptText":{"type":"string","description":"Instructions for interpreting the contents of a document."}},"type":"object","required":["parsingPromptText"]},"aws-native:bedrock:DataSourceParsingStrategy":{"description":"The parsing strategy for the data source.","type":"string","enum":[{"name":"BedrockFoundationModel","value":"BEDROCK_FOUNDATION_MODEL"},{"name":"BedrockDataAutomation","value":"BEDROCK_DATA_AUTOMATION"}]},"aws-native:bedrock:DataSourcePatternObjectFilter":{"description":"The specific filters applied to your data source content. You can filter out or include certain content.","properties":{"exclusionFilters":{"type":"array","items":{"type":"string"}},"inclusionFilters":{"type":"array","items":{"type":"string"}},"objectType":{"type":"string","description":"The supported object type or content type of the data source."}},"type":"object","required":["objectType"]},"aws-native:bedrock:DataSourcePatternObjectFilterConfiguration":{"description":"The configuration of specific filters applied to your data source content. You can filter out or include certain content.","properties":{"filters":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataSourcePatternObjectFilter"},"description":"The configuration of specific filters applied to your data source content. You can filter out or include certain content."}},"type":"object","required":["filters"]},"aws-native:bedrock:DataSourceS3DataSourceConfiguration":{"description":"The configuration information to connect to Amazon S3 as your data source.","properties":{"bucketArn":{"type":"string","description":"The ARN of the bucket that contains the data source."},"bucketOwnerAccountId":{"type":"string","description":"The account ID for the owner of the S3 bucket."},"inclusionPrefixes":{"type":"array","items":{"type":"string"},"description":"A list of S3 prefixes that define the object containing the data sources."}},"type":"object","required":["bucketArn"]},"aws-native:bedrock:DataSourceS3Location":{"description":"An Amazon S3 location.","properties":{"uri":{"type":"string","description":"The location's URI"}},"type":"object","required":["uri"]},"aws-native:bedrock:DataSourceSalesforceCrawlerConfiguration":{"description":"The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content.","properties":{"filterConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceCrawlFilterConfiguration","description":"The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content."}},"type":"object"},"aws-native:bedrock:DataSourceSalesforceDataSourceConfiguration":{"description":"The configuration information to connect to Salesforce as your data source.","properties":{"crawlerConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceSalesforceCrawlerConfiguration","description":"The configuration of the Salesforce content. For example, configuring specific types of Salesforce content."},"sourceConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceSalesforceSourceConfiguration","description":"The endpoint information to connect to your Salesforce data source."}},"type":"object","required":["sourceConfiguration"]},"aws-native:bedrock:DataSourceSalesforceSourceConfiguration":{"description":"The endpoint information to connect to your Salesforce data source.","properties":{"authType":{"$ref":"#/types/aws-native:bedrock:DataSourceSalesforceSourceConfigurationAuthType","description":"The supported authentication type to authenticate and connect to your Salesforce instance."},"credentialsSecretArn":{"type":"string","description":"The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Salesforce connection configuration."},"hostUrl":{"type":"string","description":"The Salesforce host URL or instance URL."}},"type":"object","required":["authType","credentialsSecretArn","hostUrl"]},"aws-native:bedrock:DataSourceSalesforceSourceConfigurationAuthType":{"description":"The supported authentication type to authenticate and connect to your Salesforce instance.","type":"string","enum":[{"name":"Oauth2ClientCredentials","value":"OAUTH2_CLIENT_CREDENTIALS"}]},"aws-native:bedrock:DataSourceSeedUrl":{"description":"A seed url object.","properties":{"url":{"type":"string","description":"A web url."}},"type":"object","required":["url"]},"aws-native:bedrock:DataSourceSemanticChunkingConfiguration":{"description":"Configurations for when you choose semantic chunking. If you set the chunkingStrategy as NONE, exclude this field.","properties":{"breakpointPercentileThreshold":{"type":"integer","description":"The dissimilarity threshold for splitting chunks."},"bufferSize":{"type":"integer","description":"The buffer size."},"maxTokens":{"type":"integer","description":"The maximum number of tokens that a chunk can contain."}},"type":"object","required":["breakpointPercentileThreshold","bufferSize","maxTokens"]},"aws-native:bedrock:DataSourceServerSideEncryptionConfiguration":{"description":"Contains details about the server-side encryption for the data source.","properties":{"kmsKeyArn":{"type":"string","description":"The ARN of the AWS KMS key used to encrypt the resource."}},"type":"object"},"aws-native:bedrock:DataSourceSharePointCrawlerConfiguration":{"description":"The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.","properties":{"filterConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceCrawlFilterConfiguration","description":"The configuration of filtering the SharePoint content. For example, configuring regular expression patterns to include or exclude certain content."}},"type":"object"},"aws-native:bedrock:DataSourceSharePointDataSourceConfiguration":{"description":"The configuration information to connect to SharePoint as your data source.","properties":{"crawlerConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceSharePointCrawlerConfiguration","description":"The configuration of the SharePoint content. For example, configuring specific types of SharePoint content."},"sourceConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceSharePointSourceConfiguration","description":"The endpoint information to connect to your SharePoint data source."}},"type":"object","required":["sourceConfiguration"]},"aws-native:bedrock:DataSourceSharePointSourceConfiguration":{"description":"The endpoint information to connect to your SharePoint data source.","properties":{"authType":{"$ref":"#/types/aws-native:bedrock:DataSourceSharePointSourceConfigurationAuthType","description":"The supported authentication type to authenticate and connect to your SharePoint site/sites."},"credentialsSecretArn":{"type":"string","description":"The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration."},"domain":{"type":"string","description":"The domain of your SharePoint instance or site URL/URLs."},"hostType":{"$ref":"#/types/aws-native:bedrock:DataSourceSharePointSourceConfigurationHostType","description":"The supported host type, whether online/cloud or server/on-premises."},"siteUrls":{"type":"array","items":{"type":"string"},"description":"A list of one or more SharePoint site URLs."},"tenantId":{"type":"string","description":"The identifier of your Microsoft 365 tenant."}},"type":"object","required":["authType","credentialsSecretArn","domain","hostType","siteUrls"]},"aws-native:bedrock:DataSourceSharePointSourceConfigurationAuthType":{"description":"The supported authentication type to authenticate and connect to your SharePoint site/sites.","type":"string","enum":[{"name":"Oauth2ClientCredentials","value":"OAUTH2_CLIENT_CREDENTIALS"},{"name":"Oauth2SharepointAppOnlyClientCredentials","value":"OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS"}]},"aws-native:bedrock:DataSourceSharePointSourceConfigurationHostType":{"description":"The supported host type, whether online/cloud or server/on-premises.","type":"string","enum":[{"name":"Online","value":"ONLINE"}]},"aws-native:bedrock:DataSourceStatus":{"description":"The status of a data source.","type":"string","enum":[{"name":"Available","value":"AVAILABLE"},{"name":"Deleting","value":"DELETING"},{"name":"DeleteUnsuccessful","value":"DELETE_UNSUCCESSFUL"}]},"aws-native:bedrock:DataSourceTransformation":{"description":"A Lambda function that processes documents.","properties":{"stepToApply":{"$ref":"#/types/aws-native:bedrock:DataSourceTransformationStepToApply","description":"When the service applies the transformation."},"transformationFunction":{"$ref":"#/types/aws-native:bedrock:DataSourceTransformationFunction","description":"A Lambda function that processes documents."}},"type":"object","required":["stepToApply","transformationFunction"]},"aws-native:bedrock:DataSourceTransformationFunction":{"description":"A Lambda function that processes documents.","properties":{"transformationLambdaConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceTransformationLambdaConfiguration","description":"The Lambda function."}},"type":"object","required":["transformationLambdaConfiguration"]},"aws-native:bedrock:DataSourceTransformationLambdaConfiguration":{"description":"A Lambda function that processes documents.","properties":{"lambdaArn":{"type":"string","description":"The function's ARN identifier."}},"type":"object","required":["lambdaArn"]},"aws-native:bedrock:DataSourceTransformationStepToApply":{"description":"When the service applies the transformation.","type":"string","enum":[{"name":"PostChunking","value":"POST_CHUNKING"}]},"aws-native:bedrock:DataSourceType":{"description":"The type of the data source location.","type":"string","enum":[{"name":"S3","value":"S3"},{"name":"Confluence","value":"CONFLUENCE"},{"name":"Salesforce","value":"SALESFORCE"},{"name":"Sharepoint","value":"SHAREPOINT"},{"name":"Web","value":"WEB"},{"name":"Custom","value":"CUSTOM"},{"name":"RedshiftMetadata","value":"REDSHIFT_METADATA"}]},"aws-native:bedrock:DataSourceUrlConfiguration":{"description":"A url configuration.","properties":{"seedUrls":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:DataSourceSeedUrl"},"description":"One or more seed or starting point URLs."}},"type":"object","required":["seedUrls"]},"aws-native:bedrock:DataSourceVectorIngestionConfiguration":{"description":"Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.","properties":{"chunkingConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceChunkingConfiguration","description":"Details about how to chunk the documents in the data source. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.","replaceOnChanges":true},"contextEnrichmentConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceContextEnrichmentConfiguration","description":"The context enrichment configuration used for ingestion of the data into the vector store."},"customTransformationConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceCustomTransformationConfiguration","description":"A custom document transformer for parsed data source documents."},"parsingConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceParsingConfiguration","description":"Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used.","replaceOnChanges":true}},"type":"object"},"aws-native:bedrock:DataSourceWebCrawlerConfiguration":{"description":"Configuration for the web crawler.","properties":{"crawlerLimits":{"$ref":"#/types/aws-native:bedrock:DataSourceWebCrawlerLimits","description":"The configuration of crawl limits for the web URLs."},"exclusionFilters":{"type":"array","items":{"type":"string"},"description":"A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled."},"inclusionFilters":{"type":"array","items":{"type":"string"},"description":"A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled."},"scope":{"$ref":"#/types/aws-native:bedrock:DataSourceWebScopeType","description":"The scope of what is crawled for your URLs.\n\nYou can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL \"https://docs.aws.amazon.com/bedrock/latest/userguide/\" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain \"aws.amazon.com\" can also include sub domain \"docs.aws.amazon.com\"."},"userAgent":{"type":"string","description":"The suffix that will be included in the user agent header."},"userAgentHeader":{"type":"string","description":"The full user agent header, including UUID and suffix."}},"type":"object"},"aws-native:bedrock:DataSourceWebCrawlerLimits":{"description":"Limit settings for the web crawler.","properties":{"maxPages":{"type":"integer","description":"Maximum number of pages the crawler can crawl."},"rateLimit":{"type":"integer","description":"Rate of web URLs retrieved per minute."}},"type":"object"},"aws-native:bedrock:DataSourceWebDataSourceConfiguration":{"description":"Configures a web data source location.","properties":{"crawlerConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceWebCrawlerConfiguration","description":"The Web Crawler configuration details for the web data source."},"sourceConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceWebSourceConfiguration","description":"The source configuration details for the web data source."}},"type":"object","required":["sourceConfiguration"]},"aws-native:bedrock:DataSourceWebScopeType":{"description":"The scope that a web crawl job will be restricted to.","type":"string","enum":[{"name":"HostOnly","value":"HOST_ONLY"},{"name":"Subdomains","value":"SUBDOMAINS"}]},"aws-native:bedrock:DataSourceWebSourceConfiguration":{"description":"A web source configuration.","properties":{"urlConfiguration":{"$ref":"#/types/aws-native:bedrock:DataSourceUrlConfiguration","description":"The configuration of the URL/URLs."}},"type":"object","required":["urlConfiguration"]},"aws-native:bedrock:FlowAdditionalModelRequestFields":{"type":"object"},"aws-native:bedrock:FlowAgentFlowNodeConfiguration":{"description":"Agent flow node configuration","properties":{"agentAliasArn":{"type":"string","description":"Arn representation of the Agent Alias."}},"type":"object","required":["agentAliasArn"]},"aws-native:bedrock:FlowAliasConcurrencyConfiguration":{"properties":{"maxConcurrency":{"type":"number","description":"Number of nodes executed concurrently at a time"},"type":{"$ref":"#/types/aws-native:bedrock:FlowAliasConcurrencyType","description":"The type of concurrency to use for parallel node execution. Specify one of the following options:\n\n- `Automatic` - Amazon Bedrock determines which nodes can be executed in parallel based on the flow definition and its dependencies.\n- `Manual` - You specify which nodes can be executed in parallel."}},"type":"object","required":["type"]},"aws-native:bedrock:FlowAliasConcurrencyType":{"type":"string","enum":[{"name":"Automatic","value":"Automatic"},{"name":"Manual","value":"Manual"}]},"aws-native:bedrock:FlowAliasRoutingConfigurationListItem":{"description":"Details about the routing configuration for a Flow alias.","properties":{"flowVersion":{"type":"string","description":"Version."}},"type":"object"},"aws-native:bedrock:FlowCollectorFlowNodeConfiguration":{"description":"Collector flow node configuration","type":"object"},"aws-native:bedrock:FlowCondition":{"description":"Condition branch for a condition node","properties":{"expression":{"type":"string","description":"Expression for a condition in a flow"},"name":{"type":"string","description":"Name of a condition in a flow"}},"type":"object","required":["name"]},"aws-native:bedrock:FlowConditionFlowNodeConfiguration":{"description":"Condition flow node configuration","properties":{"conditions":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowCondition"},"description":"List of conditions in a condition node"}},"type":"object","required":["conditions"]},"aws-native:bedrock:FlowConditionalConnectionConfiguration":{"description":"Conditional connection configuration","properties":{"condition":{"type":"string","description":"Name of a condition in a flow"}},"type":"object","required":["condition"]},"aws-native:bedrock:FlowConnection":{"description":"Flow connection","properties":{"configuration":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:FlowConnectionConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrock:FlowConnectionConfiguration1Properties"}],"description":"The configuration of the connection."},"name":{"type":"string","description":"Name of a connection in a flow"},"source":{"type":"string","description":"Name of a node in a flow"},"target":{"type":"string","description":"Name of a node in a flow"},"type":{"$ref":"#/types/aws-native:bedrock:FlowConnectionType","description":"Whether the source node that the connection begins from is a condition node ( `Conditional` ) or not ( `Data` )."}},"type":"object","required":["name","source","target","type"]},"aws-native:bedrock:FlowConnectionConfiguration0Properties":{"description":"Connection configuration","properties":{"data":{"$ref":"#/types/aws-native:bedrock:FlowDataConnectionConfiguration"}},"type":"object","required":["data"]},"aws-native:bedrock:FlowConnectionConfiguration1Properties":{"description":"Connection configuration","properties":{"conditional":{"$ref":"#/types/aws-native:bedrock:FlowConditionalConnectionConfiguration"}},"type":"object","required":["conditional"]},"aws-native:bedrock:FlowConnectionType":{"description":"Connection type","type":"string","enum":[{"name":"Data","value":"Data"},{"name":"Conditional","value":"Conditional"}]},"aws-native:bedrock:FlowDataConnectionConfiguration":{"description":"Data connection configuration","properties":{"sourceOutput":{"type":"string","description":"Name of a node output in a flow"},"targetInput":{"type":"string","description":"Name of a node input in a flow"}},"type":"object","required":["sourceOutput","targetInput"]},"aws-native:bedrock:FlowDefinition":{"description":"Flow definition","properties":{"connections":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowConnection"},"description":"List of connections"},"nodes":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowNode"},"description":"List of nodes in a flow"}},"type":"object"},"aws-native:bedrock:FlowFieldForReranking":{"description":"Field name for reranking","properties":{"fieldName":{"type":"string","description":"Field name for reranking"}},"type":"object","required":["fieldName"]},"aws-native:bedrock:FlowGuardrailConfiguration":{"description":"Configuration for a guardrail","properties":{"guardrailIdentifier":{"type":"string","description":"Identifier for the guardrail, could be the id or the arn"},"guardrailVersion":{"type":"string","description":"Version of the guardrail"}},"type":"object"},"aws-native:bedrock:FlowInlineCodeFlowNodeConfiguration":{"description":"Inline code config strucuture, contains code configs","properties":{"code":{"type":"string","description":"The inline code entered by customers. max size is 5MB."},"language":{"$ref":"#/types/aws-native:bedrock:FlowSupportedLanguages"}},"type":"object","required":["code","language"]},"aws-native:bedrock:FlowInputFlowNodeConfiguration":{"description":"Input flow node configuration","type":"object"},"aws-native:bedrock:FlowIteratorFlowNodeConfiguration":{"description":"Iterator flow node configuration","type":"object"},"aws-native:bedrock:FlowKnowledgeBaseFlowNodeConfiguration":{"description":"Knowledge base flow node configuration","properties":{"guardrailConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowGuardrailConfiguration"},"inferenceConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowPromptInferenceConfigurationProperties"},"knowledgeBaseId":{"type":"string","description":"Identifier of the KnowledgeBase"},"modelId":{"type":"string","description":"ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models."},"numberOfResults":{"type":"number","description":"Number Of Results to Retrieve"},"orchestrationConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowKnowledgeBaseOrchestrationConfiguration"},"promptTemplate":{"$ref":"#/types/aws-native:bedrock:FlowKnowledgeBasePromptTemplateProperties"},"rerankingConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVectorSearchRerankingConfiguration"}},"type":"object","required":["knowledgeBaseId"]},"aws-native:bedrock:FlowKnowledgeBaseOrchestrationConfiguration":{"properties":{"additionalModelRequestFields":{"$ref":"#/types/aws-native:bedrock:FlowAdditionalModelRequestFields"},"inferenceConfig":{"$ref":"#/types/aws-native:bedrock:FlowPromptInferenceConfigurationProperties"},"performanceConfig":{"$ref":"#/types/aws-native:bedrock:FlowPerformanceConfiguration"},"promptTemplate":{"$ref":"#/types/aws-native:bedrock:FlowKnowledgeBasePromptTemplateProperties"}},"type":"object"},"aws-native:bedrock:FlowKnowledgeBasePromptTemplate0Properties":{"description":"Knowledge Base Prompt template","properties":{"textPromptTemplate":{"type":"string"}},"type":"object","required":["textPromptTemplate"]},"aws-native:bedrock:FlowKnowledgeBasePromptTemplateProperties":{"description":"Knowledge Base Prompt template","properties":{"textPromptTemplate":{"type":"string"}},"type":"object","required":["textPromptTemplate"]},"aws-native:bedrock:FlowLambdaFunctionFlowNodeConfiguration":{"description":"Lambda function flow node configuration","properties":{"lambdaArn":{"type":"string","description":"ARN of a Lambda."}},"type":"object","required":["lambdaArn"]},"aws-native:bedrock:FlowLexFlowNodeConfiguration":{"description":"Lex flow node configuration","properties":{"botAliasArn":{"type":"string","description":"ARN of a Lex bot alias"},"localeId":{"type":"string","description":"Lex bot locale id"}},"type":"object","required":["botAliasArn","localeId"]},"aws-native:bedrock:FlowLoopControllerFlowNodeConfiguration":{"description":"Configuration for the LoopController node, which manages loop execution","properties":{"continueCondition":{"$ref":"#/types/aws-native:bedrock:FlowCondition"},"maxIterations":{"type":"number","description":"Maximum number of iterations the loop can perform"}},"type":"object","required":["continueCondition"]},"aws-native:bedrock:FlowLoopFlowNodeConfiguration":{"description":"Loop node config, contains loop's internal definition","properties":{"definition":{"$ref":"#/types/aws-native:bedrock:FlowDefinition"}},"type":"object","required":["definition"]},"aws-native:bedrock:FlowLoopInputFlowNodeConfiguration":{"description":"Configuration for the LoopInput node","type":"object"},"aws-native:bedrock:FlowMetadataConfigurationForReranking":{"properties":{"selectionMode":{"$ref":"#/types/aws-native:bedrock:FlowRerankingMetadataSelectionMode"},"selectiveModeConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:FlowRerankingMetadataSelectiveModeConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrock:FlowRerankingMetadataSelectiveModeConfiguration1Properties"}]}},"type":"object","required":["selectionMode"]},"aws-native:bedrock:FlowNode":{"description":"Internal mixin for flow node","properties":{"configuration":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration1Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration2Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration3Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration4Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration5Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration6Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration7Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration8Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration9Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration10Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration11Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration12Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration13Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration14Properties"},{"$ref":"#/types/aws-native:bedrock:FlowNodeConfiguration15Properties"}],"description":"Contains configurations for the node."},"inputs":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowNodeInput"},"description":"List of node inputs in a flow"},"name":{"type":"string","description":"Name of a node in a flow"},"outputs":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowNodeOutput"},"description":"List of node outputs in a flow"},"type":{"$ref":"#/types/aws-native:bedrock:FlowNodeType","description":"The type of node. This value must match the name of the key that you provide in the configuration you provide in the `FlowNodeConfiguration` field."}},"type":"object","required":["name","type"]},"aws-native:bedrock:FlowNodeConfiguration0Properties":{"description":"Node configuration in a flow","properties":{"input":{"$ref":"#/types/aws-native:bedrock:FlowInputFlowNodeConfiguration"}},"type":"object","required":["input"]},"aws-native:bedrock:FlowNodeConfiguration10Properties":{"description":"Node configuration in a flow","properties":{"collector":{"$ref":"#/types/aws-native:bedrock:FlowCollectorFlowNodeConfiguration"}},"type":"object","required":["collector"]},"aws-native:bedrock:FlowNodeConfiguration11Properties":{"description":"Node configuration in a flow","properties":{"retrieval":{"$ref":"#/types/aws-native:bedrock:FlowRetrievalFlowNodeConfiguration"}},"type":"object","required":["retrieval"]},"aws-native:bedrock:FlowNodeConfiguration12Properties":{"description":"Node configuration in a flow","properties":{"inlineCode":{"$ref":"#/types/aws-native:bedrock:FlowInlineCodeFlowNodeConfiguration"}},"type":"object","required":["inlineCode"]},"aws-native:bedrock:FlowNodeConfiguration13Properties":{"description":"Node configuration in a flow","properties":{"loop":{"$ref":"#/types/aws-native:bedrock:FlowLoopFlowNodeConfiguration"}},"type":"object","required":["loop"]},"aws-native:bedrock:FlowNodeConfiguration14Properties":{"description":"Node configuration in a flow","properties":{"loopInput":{"$ref":"#/types/aws-native:bedrock:FlowLoopInputFlowNodeConfiguration"}},"type":"object","required":["loopInput"]},"aws-native:bedrock:FlowNodeConfiguration15Properties":{"description":"Node configuration in a flow","properties":{"loopController":{"$ref":"#/types/aws-native:bedrock:FlowLoopControllerFlowNodeConfiguration"}},"type":"object","required":["loopController"]},"aws-native:bedrock:FlowNodeConfiguration1Properties":{"description":"Node configuration in a flow","properties":{"output":{"$ref":"#/types/aws-native:bedrock:FlowOutputFlowNodeConfiguration"}},"type":"object","required":["output"]},"aws-native:bedrock:FlowNodeConfiguration2Properties":{"description":"Node configuration in a flow","properties":{"knowledgeBase":{"$ref":"#/types/aws-native:bedrock:FlowKnowledgeBaseFlowNodeConfiguration"}},"type":"object","required":["knowledgeBase"]},"aws-native:bedrock:FlowNodeConfiguration3Properties":{"description":"Node configuration in a flow","properties":{"condition":{"$ref":"#/types/aws-native:bedrock:FlowConditionFlowNodeConfiguration"}},"type":"object","required":["condition"]},"aws-native:bedrock:FlowNodeConfiguration4Properties":{"description":"Node configuration in a flow","properties":{"lex":{"$ref":"#/types/aws-native:bedrock:FlowLexFlowNodeConfiguration"}},"type":"object","required":["lex"]},"aws-native:bedrock:FlowNodeConfiguration5Properties":{"description":"Node configuration in a flow","properties":{"prompt":{"$ref":"#/types/aws-native:bedrock:FlowPromptFlowNodeConfiguration"}},"type":"object","required":["prompt"]},"aws-native:bedrock:FlowNodeConfiguration6Properties":{"description":"Node configuration in a flow","properties":{"lambdaFunction":{"$ref":"#/types/aws-native:bedrock:FlowLambdaFunctionFlowNodeConfiguration"}},"type":"object","required":["lambdaFunction"]},"aws-native:bedrock:FlowNodeConfiguration7Properties":{"description":"Node configuration in a flow","properties":{"agent":{"$ref":"#/types/aws-native:bedrock:FlowAgentFlowNodeConfiguration"}},"type":"object","required":["agent"]},"aws-native:bedrock:FlowNodeConfiguration8Properties":{"description":"Node configuration in a flow","properties":{"storage":{"$ref":"#/types/aws-native:bedrock:FlowStorageFlowNodeConfiguration"}},"type":"object","required":["storage"]},"aws-native:bedrock:FlowNodeConfiguration9Properties":{"description":"Node configuration in a flow","properties":{"iterator":{"$ref":"#/types/aws-native:bedrock:FlowIteratorFlowNodeConfiguration"}},"type":"object","required":["iterator"]},"aws-native:bedrock:FlowNodeInput":{"description":"Input to a node in a flow","properties":{"category":{"$ref":"#/types/aws-native:bedrock:FlowNodeInputCategory","description":"Specifies how input data flows between iterations in a DoWhile loop.\n\n- `LoopCondition` - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue.\n- `ReturnValueToLoopStart` - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration.\n- `ExitLoop` - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop."},"expression":{"type":"string","description":"Expression for a node input in a flow"},"name":{"type":"string","description":"Name of a node input in a flow"},"type":{"$ref":"#/types/aws-native:bedrock:FlowNodeIoDataType","description":"Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown."}},"type":"object","required":["expression","name","type"]},"aws-native:bedrock:FlowNodeInputCategory":{"description":"Optional tag to classify input type, currently exclusive to LoopNode","type":"string","enum":[{"name":"LoopCondition","value":"LoopCondition"},{"name":"ReturnValueToLoopStart","value":"ReturnValueToLoopStart"},{"name":"ExitLoop","value":"ExitLoop"}]},"aws-native:bedrock:FlowNodeIoDataType":{"description":"Type of input/output for a node in a flow","type":"string","enum":[{"name":"String","value":"String"},{"name":"Number","value":"Number"},{"name":"Boolean","value":"Boolean"},{"name":"Object","value":"Object"},{"name":"Array","value":"Array"}]},"aws-native:bedrock:FlowNodeOutput":{"description":"Output of a node in a flow","properties":{"name":{"type":"string","description":"Name of a node output in a flow"},"type":{"$ref":"#/types/aws-native:bedrock:FlowNodeIoDataType","description":"The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown."}},"type":"object","required":["name","type"]},"aws-native:bedrock:FlowNodeType":{"description":"Flow node types","type":"string","enum":[{"name":"InputType","value":"Input"},{"name":"OutputType","value":"Output"},{"name":"KnowledgeBase","value":"KnowledgeBase"},{"name":"Condition","value":"Condition"},{"name":"Lex","value":"Lex"},{"name":"Prompt","value":"Prompt"},{"name":"LambdaFunction","value":"LambdaFunction"},{"name":"Agent","value":"Agent"},{"name":"Storage","value":"Storage"},{"name":"Retrieval","value":"Retrieval"},{"name":"Iterator","value":"Iterator"},{"name":"Collector","value":"Collector"},{"name":"InlineCode","value":"InlineCode"},{"name":"Loop","value":"Loop"},{"name":"LoopInput","value":"LoopInput"},{"name":"LoopController","value":"LoopController"}]},"aws-native:bedrock:FlowOutputFlowNodeConfiguration":{"description":"Output flow node configuration","type":"object"},"aws-native:bedrock:FlowPerformanceConfiguration":{"properties":{"latency":{"$ref":"#/types/aws-native:bedrock:FlowPerformanceConfigurationLatency"}},"type":"object"},"aws-native:bedrock:FlowPerformanceConfigurationLatency":{"description":"Performance Configuration Latency","type":"string","enum":[{"name":"Standard","value":"standard"},{"name":"Optimized","value":"optimized"}]},"aws-native:bedrock:FlowPromptFlowNodeConfiguration":{"description":"Prompt flow node configuration","properties":{"guardrailConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowGuardrailConfiguration"},"sourceConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:FlowPromptFlowNodeSourceConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrock:FlowPromptFlowNodeSourceConfiguration1Properties"}]}},"type":"object","required":["sourceConfiguration"]},"aws-native:bedrock:FlowPromptFlowNodeInlineConfiguration":{"description":"Inline prompt configuration for prompt node","properties":{"inferenceConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowPromptInferenceConfigurationProperties"},"modelId":{"type":"string","description":"ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models."},"templateConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowPromptTemplateConfigurationProperties"},"templateType":{"$ref":"#/types/aws-native:bedrock:FlowPromptTemplateType"}},"type":"object","required":["modelId","templateConfiguration","templateType"]},"aws-native:bedrock:FlowPromptFlowNodeResourceConfiguration":{"description":"Resource prompt configuration for prompt node","properties":{"promptArn":{"type":"string","description":"ARN of a prompt resource possibly with a version"}},"type":"object","required":["promptArn"]},"aws-native:bedrock:FlowPromptFlowNodeSourceConfiguration0Properties":{"description":"Prompt source configuration for prompt node","properties":{"resource":{"$ref":"#/types/aws-native:bedrock:FlowPromptFlowNodeResourceConfiguration"}},"type":"object","required":["resource"]},"aws-native:bedrock:FlowPromptFlowNodeSourceConfiguration1Properties":{"description":"Prompt source configuration for prompt node","properties":{"inline":{"$ref":"#/types/aws-native:bedrock:FlowPromptFlowNodeInlineConfiguration"}},"type":"object","required":["inline"]},"aws-native:bedrock:FlowPromptInferenceConfiguration0Properties":{"description":"Model inference configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:FlowPromptModelInferenceConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:FlowPromptInferenceConfigurationProperties":{"description":"Model inference configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:FlowPromptModelInferenceConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:FlowPromptInputVariable":{"description":"Input variable","properties":{"name":{"type":"string","description":"Name for an input variable"}},"type":"object"},"aws-native:bedrock:FlowPromptModelInferenceConfiguration":{"description":"Prompt model inference configuration","properties":{"maxTokens":{"type":"number","description":"Maximum length of output"},"stopSequences":{"type":"array","items":{"type":"string"},"description":"List of stop sequences"},"temperature":{"type":"number","description":"Controls randomness, higher values increase diversity"},"topP":{"type":"number","description":"Cumulative probability cutoff for token selection"}},"type":"object"},"aws-native:bedrock:FlowPromptTemplateConfiguration0Properties":{"description":"Prompt template configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:FlowTextPromptTemplateConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:FlowPromptTemplateConfigurationProperties":{"description":"Prompt template configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:FlowTextPromptTemplateConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:FlowPromptTemplateType":{"description":"Prompt template type","type":"string","enum":[{"name":"Text","value":"TEXT"}]},"aws-native:bedrock:FlowRerankingMetadataSelectionMode":{"description":"Reranking Metadata Selection Mode","type":"string","enum":[{"name":"Selective","value":"SELECTIVE"},{"name":"All","value":"ALL"}]},"aws-native:bedrock:FlowRerankingMetadataSelectiveModeConfiguration0Properties":{"description":"Reranking Metadata Selective Mode Configuration","properties":{"fieldsToInclude":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowFieldForReranking"}}},"type":"object","required":["fieldsToInclude"]},"aws-native:bedrock:FlowRerankingMetadataSelectiveModeConfiguration1Properties":{"description":"Reranking Metadata Selective Mode Configuration","properties":{"fieldsToExclude":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowFieldForReranking"}}},"type":"object","required":["fieldsToExclude"]},"aws-native:bedrock:FlowRetrievalFlowNodeConfiguration":{"description":"Retrieval flow node configuration","properties":{"serviceConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowRetrievalFlowNodeServiceConfigurationProperties"}},"type":"object","required":["serviceConfiguration"]},"aws-native:bedrock:FlowRetrievalFlowNodeS3Configuration":{"description":"s3 Retrieval configuration for Retrieval node","properties":{"bucketName":{"type":"string","description":"bucket name of an s3 that will be used for Retrieval flow node configuration"}},"type":"object","required":["bucketName"]},"aws-native:bedrock:FlowRetrievalFlowNodeServiceConfiguration0Properties":{"description":"Retrieval service configuration for Retrieval node","properties":{"s3":{"$ref":"#/types/aws-native:bedrock:FlowRetrievalFlowNodeS3Configuration"}},"type":"object"},"aws-native:bedrock:FlowRetrievalFlowNodeServiceConfigurationProperties":{"description":"Retrieval service configuration for Retrieval node","properties":{"s3":{"$ref":"#/types/aws-native:bedrock:FlowRetrievalFlowNodeS3Configuration"}},"type":"object"},"aws-native:bedrock:FlowS3Location":{"description":"A bucket, key and optional version pointing to an S3 object containing a UTF-8 encoded JSON string Definition with the same schema as the Definition property of this resource","properties":{"bucket":{"type":"string","description":"A bucket in S3"},"key":{"type":"string","description":"A object key in S3"},"version":{"type":"string","description":"The version of the the S3 object to use"}},"type":"object","required":["bucket","key"]},"aws-native:bedrock:FlowStatus":{"description":"Schema Type for Flow APIs","type":"string","enum":[{"name":"Failed","value":"Failed"},{"name":"Prepared","value":"Prepared"},{"name":"Preparing","value":"Preparing"},{"name":"NotPrepared","value":"NotPrepared"}]},"aws-native:bedrock:FlowStorageFlowNodeConfiguration":{"description":"Storage flow node configuration","properties":{"serviceConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowStorageFlowNodeServiceConfigurationProperties"}},"type":"object","required":["serviceConfiguration"]},"aws-native:bedrock:FlowStorageFlowNodeS3Configuration":{"description":"s3 storage configuration for storage node","properties":{"bucketName":{"type":"string","description":"bucket name of an s3 that will be used for storage flow node configuration"}},"type":"object","required":["bucketName"]},"aws-native:bedrock:FlowStorageFlowNodeServiceConfiguration0Properties":{"description":"storage service configuration for storage node","properties":{"s3":{"$ref":"#/types/aws-native:bedrock:FlowStorageFlowNodeS3Configuration"}},"type":"object"},"aws-native:bedrock:FlowStorageFlowNodeServiceConfigurationProperties":{"description":"storage service configuration for storage node","properties":{"s3":{"$ref":"#/types/aws-native:bedrock:FlowStorageFlowNodeS3Configuration"}},"type":"object"},"aws-native:bedrock:FlowSupportedLanguages":{"description":"Enum encodes the supported language type","type":"string","enum":[{"name":"Python3","value":"Python_3"}]},"aws-native:bedrock:FlowTextPromptTemplateConfiguration":{"description":"Configuration for text prompt template","properties":{"inputVariables":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowPromptInputVariable"},"description":"List of input variables"},"text":{"type":"string","description":"Prompt content for String prompt template"}},"type":"object","required":["text"]},"aws-native:bedrock:FlowValidation":{"description":"Validation for Flow","properties":{"message":{"type":"string","description":"validation message"}},"type":"object","required":["message"]},"aws-native:bedrock:FlowVectorSearchBedrockRerankingConfiguration":{"properties":{"metadataConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowMetadataConfigurationForReranking"},"modelConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVectorSearchBedrockRerankingModelConfiguration"},"numberOfRerankedResults":{"type":"number","description":"Number Of Results For Reranking"}},"type":"object","required":["modelConfiguration"]},"aws-native:bedrock:FlowVectorSearchBedrockRerankingModelConfiguration":{"properties":{"additionalModelRequestFields":{"$ref":"#/types/aws-native:bedrock:FlowAdditionalModelRequestFields"},"modelArn":{"type":"string"}},"type":"object","required":["modelArn"]},"aws-native:bedrock:FlowVectorSearchRerankingConfiguration":{"properties":{"bedrockRerankingConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVectorSearchBedrockRerankingConfiguration"},"type":{"$ref":"#/types/aws-native:bedrock:FlowVectorSearchRerankingConfigurationType"}},"type":"object","required":["type"]},"aws-native:bedrock:FlowVectorSearchRerankingConfigurationType":{"description":"Enum of Rerank Configuration Types","type":"string","enum":[{"name":"BedrockRerankingModel","value":"BEDROCK_RERANKING_MODEL"}]},"aws-native:bedrock:FlowVersionAdditionalModelRequestFields":{"type":"object"},"aws-native:bedrock:FlowVersionAgentFlowNodeConfiguration":{"description":"Agent flow node configuration","properties":{"agentAliasArn":{"type":"string","description":"Arn representation of the Agent Alias."}},"type":"object","required":["agentAliasArn"]},"aws-native:bedrock:FlowVersionCollectorFlowNodeConfiguration":{"description":"Collector flow node configuration","type":"object"},"aws-native:bedrock:FlowVersionConditionFlowNodeConfiguration":{"description":"Condition flow node configuration","properties":{"conditions":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowCondition"},"description":"List of conditions in a condition node"}},"type":"object","required":["conditions"]},"aws-native:bedrock:FlowVersionFieldForReranking":{"description":"Field name for reranking","properties":{"fieldName":{"type":"string","description":"Field name for reranking"}},"type":"object","required":["fieldName"]},"aws-native:bedrock:FlowVersionFlowCondition":{"description":"Condition branch for a condition node","properties":{"expression":{"type":"string","description":"Expression for a condition in a flow"},"name":{"type":"string","description":"Name of a condition in a flow"}},"type":"object","required":["name"]},"aws-native:bedrock:FlowVersionFlowConditionalConnectionConfiguration":{"description":"Conditional connection configuration","properties":{"condition":{"type":"string","description":"Name of a condition in a flow"}},"type":"object","required":["condition"]},"aws-native:bedrock:FlowVersionFlowConnection":{"description":"Flow connection","properties":{"configuration":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowConnectionConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowConnectionConfiguration1Properties"}],"description":"The configuration of the connection."},"name":{"type":"string","description":"Name of a connection in a flow"},"source":{"type":"string","description":"Name of a node in a flow"},"target":{"type":"string","description":"Name of a node in a flow"},"type":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowConnectionType","description":"Whether the source node that the connection begins from is a condition node ( `Conditional` ) or not ( `Data` )."}},"type":"object","required":["name","source","target","type"]},"aws-native:bedrock:FlowVersionFlowConnectionConfiguration0Properties":{"description":"Connection configuration","properties":{"data":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowDataConnectionConfiguration"}},"type":"object","required":["data"]},"aws-native:bedrock:FlowVersionFlowConnectionConfiguration1Properties":{"description":"Connection configuration","properties":{"conditional":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowConditionalConnectionConfiguration"}},"type":"object","required":["conditional"]},"aws-native:bedrock:FlowVersionFlowConnectionType":{"description":"Connection type","type":"string","enum":[{"name":"Data","value":"Data"},{"name":"Conditional","value":"Conditional"}]},"aws-native:bedrock:FlowVersionFlowDataConnectionConfiguration":{"description":"Data connection configuration","properties":{"sourceOutput":{"type":"string","description":"Name of a node output in a flow"},"targetInput":{"type":"string","description":"Name of a node input in a flow"}},"type":"object","required":["sourceOutput","targetInput"]},"aws-native:bedrock:FlowVersionFlowDefinition":{"description":"Flow definition","properties":{"connections":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowConnection"},"description":"List of connections"},"nodes":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNode"},"description":"List of nodes in a flow"}},"type":"object"},"aws-native:bedrock:FlowVersionFlowNode":{"description":"Internal mixin for flow node","properties":{"configuration":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration1Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration2Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration3Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration4Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration5Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration6Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration7Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration8Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration9Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration10Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration11Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration12Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration13Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration14Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeConfiguration15Properties"}],"description":"Contains configurations for the node."},"inputs":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeInput"},"description":"List of node inputs in a flow"},"name":{"type":"string","description":"Name of a node in a flow"},"outputs":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeOutput"},"description":"List of node outputs in a flow"},"type":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeType","description":"The type of node. This value must match the name of the key that you provide in the configuration you provide in the `FlowNodeConfiguration` field."}},"type":"object","required":["name","type"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration0Properties":{"description":"Node configuration in a flow","properties":{"input":{"$ref":"#/types/aws-native:bedrock:FlowVersionInputFlowNodeConfiguration"}},"type":"object","required":["input"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration10Properties":{"description":"Node configuration in a flow","properties":{"iterator":{"$ref":"#/types/aws-native:bedrock:FlowVersionIteratorFlowNodeConfiguration"}},"type":"object","required":["iterator"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration11Properties":{"description":"Node configuration in a flow","properties":{"collector":{"$ref":"#/types/aws-native:bedrock:FlowVersionCollectorFlowNodeConfiguration"}},"type":"object","required":["collector"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration12Properties":{"description":"Node configuration in a flow","properties":{"inlineCode":{"$ref":"#/types/aws-native:bedrock:FlowVersionInlineCodeFlowNodeConfiguration"}},"type":"object","required":["inlineCode"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration13Properties":{"description":"Node configuration in a flow","properties":{"loop":{"$ref":"#/types/aws-native:bedrock:FlowVersionLoopFlowNodeConfiguration"}},"type":"object","required":["loop"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration14Properties":{"description":"Node configuration in a flow","properties":{"loopInput":{"$ref":"#/types/aws-native:bedrock:FlowVersionLoopInputFlowNodeConfiguration"}},"type":"object","required":["loopInput"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration15Properties":{"description":"Node configuration in a flow","properties":{"loopController":{"$ref":"#/types/aws-native:bedrock:FlowVersionLoopControllerFlowNodeConfiguration"}},"type":"object","required":["loopController"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration1Properties":{"description":"Node configuration in a flow","properties":{"output":{"$ref":"#/types/aws-native:bedrock:FlowVersionOutputFlowNodeConfiguration"}},"type":"object","required":["output"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration2Properties":{"description":"Node configuration in a flow","properties":{"knowledgeBase":{"$ref":"#/types/aws-native:bedrock:FlowVersionKnowledgeBaseFlowNodeConfiguration"}},"type":"object","required":["knowledgeBase"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration3Properties":{"description":"Node configuration in a flow","properties":{"condition":{"$ref":"#/types/aws-native:bedrock:FlowVersionConditionFlowNodeConfiguration"}},"type":"object","required":["condition"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration4Properties":{"description":"Node configuration in a flow","properties":{"lex":{"$ref":"#/types/aws-native:bedrock:FlowVersionLexFlowNodeConfiguration"}},"type":"object","required":["lex"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration5Properties":{"description":"Node configuration in a flow","properties":{"prompt":{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptFlowNodeConfiguration"}},"type":"object","required":["prompt"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration6Properties":{"description":"Node configuration in a flow","properties":{"lambdaFunction":{"$ref":"#/types/aws-native:bedrock:FlowVersionLambdaFunctionFlowNodeConfiguration"}},"type":"object","required":["lambdaFunction"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration7Properties":{"description":"Node configuration in a flow","properties":{"agent":{"$ref":"#/types/aws-native:bedrock:FlowVersionAgentFlowNodeConfiguration"}},"type":"object","required":["agent"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration8Properties":{"description":"Node configuration in a flow","properties":{"storage":{"$ref":"#/types/aws-native:bedrock:FlowVersionStorageFlowNodeConfiguration"}},"type":"object","required":["storage"]},"aws-native:bedrock:FlowVersionFlowNodeConfiguration9Properties":{"description":"Node configuration in a flow","properties":{"retrieval":{"$ref":"#/types/aws-native:bedrock:FlowVersionRetrievalFlowNodeConfiguration"}},"type":"object","required":["retrieval"]},"aws-native:bedrock:FlowVersionFlowNodeInput":{"description":"Input to a node in a flow","properties":{"expression":{"type":"string","description":"Expression for a node input in a flow"},"name":{"type":"string","description":"Name of a node input in a flow"},"type":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeIoDataType","description":"Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown."}},"type":"object","required":["expression","name","type"]},"aws-native:bedrock:FlowVersionFlowNodeIoDataType":{"description":"Type of input/output for a node in a flow","type":"string","enum":[{"name":"String","value":"String"},{"name":"Number","value":"Number"},{"name":"Boolean","value":"Boolean"},{"name":"Object","value":"Object"},{"name":"Array","value":"Array"}]},"aws-native:bedrock:FlowVersionFlowNodeOutput":{"description":"Output of a node in a flow","properties":{"name":{"type":"string","description":"Name of a node output in a flow"},"type":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowNodeIoDataType","description":"The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown."}},"type":"object","required":["name","type"]},"aws-native:bedrock:FlowVersionFlowNodeType":{"description":"Flow node types","type":"string","enum":[{"name":"InputType","value":"Input"},{"name":"OutputType","value":"Output"},{"name":"KnowledgeBase","value":"KnowledgeBase"},{"name":"Condition","value":"Condition"},{"name":"Lex","value":"Lex"},{"name":"Prompt","value":"Prompt"},{"name":"LambdaFunction","value":"LambdaFunction"},{"name":"Agent","value":"Agent"},{"name":"Iterator","value":"Iterator"},{"name":"Collector","value":"Collector"},{"name":"Storage","value":"Storage"},{"name":"Retrieval","value":"Retrieval"},{"name":"InlineCode","value":"InlineCode"},{"name":"Loop","value":"Loop"},{"name":"LoopInput","value":"LoopInput"},{"name":"LoopController","value":"LoopController"}]},"aws-native:bedrock:FlowVersionFlowStatus":{"description":"Schema Type for Flow APIs","type":"string","enum":[{"name":"Failed","value":"Failed"},{"name":"Prepared","value":"Prepared"},{"name":"Preparing","value":"Preparing"},{"name":"NotPrepared","value":"NotPrepared"}]},"aws-native:bedrock:FlowVersionGuardrailConfiguration":{"description":"Configuration for a guardrail","properties":{"guardrailIdentifier":{"type":"string","description":"Identifier for the guardrail, could be the id or the arn"},"guardrailVersion":{"type":"string","description":"Version of the guardrail"}},"type":"object"},"aws-native:bedrock:FlowVersionInlineCodeFlowNodeConfiguration":{"description":"Inline code config strucuture, contains code configs","properties":{"code":{"type":"string","description":"The inline code entered by customers. max size is 5MB."},"language":{"$ref":"#/types/aws-native:bedrock:FlowVersionSupportedLanguages"}},"type":"object","required":["code","language"]},"aws-native:bedrock:FlowVersionInputFlowNodeConfiguration":{"description":"Input flow node configuration","type":"object"},"aws-native:bedrock:FlowVersionIteratorFlowNodeConfiguration":{"description":"Iterator flow node configuration","type":"object"},"aws-native:bedrock:FlowVersionKnowledgeBaseFlowNodeConfiguration":{"description":"Knowledge base flow node configuration","properties":{"guardrailConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVersionGuardrailConfiguration"},"inferenceConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptInferenceConfigurationProperties"},"knowledgeBaseId":{"type":"string","description":"Identifier of the KnowledgeBase"},"modelId":{"type":"string","description":"ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models."},"numberOfResults":{"type":"number","description":"Number Of Results to Retrieve"},"orchestrationConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVersionKnowledgeBaseOrchestrationConfiguration"},"promptTemplate":{"$ref":"#/types/aws-native:bedrock:FlowVersionKnowledgeBasePromptTemplateProperties"},"rerankingConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVersionVectorSearchRerankingConfiguration"}},"type":"object","required":["knowledgeBaseId"]},"aws-native:bedrock:FlowVersionKnowledgeBaseOrchestrationConfiguration":{"properties":{"additionalModelRequestFields":{"$ref":"#/types/aws-native:bedrock:FlowVersionAdditionalModelRequestFields"},"inferenceConfig":{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptInferenceConfigurationProperties"},"performanceConfig":{"$ref":"#/types/aws-native:bedrock:FlowVersionPerformanceConfiguration"},"promptTemplate":{"$ref":"#/types/aws-native:bedrock:FlowVersionKnowledgeBasePromptTemplateProperties"}},"type":"object"},"aws-native:bedrock:FlowVersionKnowledgeBasePromptTemplate0Properties":{"description":"Knowledge Base Prompt template","properties":{"textPromptTemplate":{"type":"string"}},"type":"object","required":["textPromptTemplate"]},"aws-native:bedrock:FlowVersionKnowledgeBasePromptTemplateProperties":{"description":"Knowledge Base Prompt template","properties":{"textPromptTemplate":{"type":"string"}},"type":"object","required":["textPromptTemplate"]},"aws-native:bedrock:FlowVersionLambdaFunctionFlowNodeConfiguration":{"description":"Lambda function flow node configuration","properties":{"lambdaArn":{"type":"string","description":"ARN of a Lambda."}},"type":"object","required":["lambdaArn"]},"aws-native:bedrock:FlowVersionLexFlowNodeConfiguration":{"description":"Lex flow node configuration","properties":{"botAliasArn":{"type":"string","description":"ARN of a Lex bot alias"},"localeId":{"type":"string","description":"Lex bot locale id"}},"type":"object","required":["botAliasArn","localeId"]},"aws-native:bedrock:FlowVersionLoopControllerFlowNodeConfiguration":{"description":"Configuration for the LoopController node, which manages loop execution","properties":{"continueCondition":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowCondition"},"maxIterations":{"type":"number","description":"Maximum number of iterations the loop can perform"}},"type":"object","required":["continueCondition"]},"aws-native:bedrock:FlowVersionLoopFlowNodeConfiguration":{"description":"Loop node config, contains loop's internal definition","properties":{"definition":{"$ref":"#/types/aws-native:bedrock:FlowVersionFlowDefinition"}},"type":"object","required":["definition"]},"aws-native:bedrock:FlowVersionLoopInputFlowNodeConfiguration":{"description":"Configuration for the LoopInput node","type":"object"},"aws-native:bedrock:FlowVersionMetadataConfigurationForReranking":{"properties":{"selectionMode":{"$ref":"#/types/aws-native:bedrock:FlowVersionRerankingMetadataSelectionMode"},"selectiveModeConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:FlowVersionRerankingMetadataSelectiveModeConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionRerankingMetadataSelectiveModeConfiguration1Properties"}]}},"type":"object","required":["selectionMode"]},"aws-native:bedrock:FlowVersionOutputFlowNodeConfiguration":{"description":"Output flow node configuration","type":"object"},"aws-native:bedrock:FlowVersionPerformanceConfiguration":{"properties":{"latency":{"$ref":"#/types/aws-native:bedrock:FlowVersionPerformanceConfigurationLatency"}},"type":"object"},"aws-native:bedrock:FlowVersionPerformanceConfigurationLatency":{"description":"Performance Configuration Latency","type":"string","enum":[{"name":"Standard","value":"standard"},{"name":"Optimized","value":"optimized"}]},"aws-native:bedrock:FlowVersionPromptFlowNodeConfiguration":{"description":"Prompt flow node configuration","properties":{"guardrailConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVersionGuardrailConfiguration"},"sourceConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptFlowNodeSourceConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptFlowNodeSourceConfiguration1Properties"}]}},"type":"object","required":["sourceConfiguration"]},"aws-native:bedrock:FlowVersionPromptFlowNodeInlineConfiguration":{"description":"Inline prompt configuration for prompt node","properties":{"inferenceConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptInferenceConfigurationProperties"},"modelId":{"type":"string","description":"ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models."},"templateConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptTemplateConfigurationProperties"},"templateType":{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptTemplateType"}},"type":"object","required":["modelId","templateConfiguration","templateType"]},"aws-native:bedrock:FlowVersionPromptFlowNodeResourceConfiguration":{"description":"Resource prompt configuration for prompt node","properties":{"promptArn":{"type":"string","description":"ARN of a prompt resource possibly with a version"}},"type":"object","required":["promptArn"]},"aws-native:bedrock:FlowVersionPromptFlowNodeSourceConfiguration0Properties":{"description":"Prompt source configuration for prompt node","properties":{"resource":{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptFlowNodeResourceConfiguration"}},"type":"object","required":["resource"]},"aws-native:bedrock:FlowVersionPromptFlowNodeSourceConfiguration1Properties":{"description":"Prompt source configuration for prompt node","properties":{"inline":{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptFlowNodeInlineConfiguration"}},"type":"object","required":["inline"]},"aws-native:bedrock:FlowVersionPromptInferenceConfiguration0Properties":{"description":"Model inference configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptModelInferenceConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:FlowVersionPromptInferenceConfigurationProperties":{"description":"Model inference configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptModelInferenceConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:FlowVersionPromptInputVariable":{"description":"Input variable","properties":{"name":{"type":"string","description":"Name for an input variable"}},"type":"object"},"aws-native:bedrock:FlowVersionPromptModelInferenceConfiguration":{"description":"Prompt model inference configuration","properties":{"maxTokens":{"type":"number","description":"Maximum length of output"},"stopSequences":{"type":"array","items":{"type":"string"},"description":"List of stop sequences"},"temperature":{"type":"number","description":"Controls randomness, higher values increase diversity"},"topP":{"type":"number","description":"Cumulative probability cutoff for token selection"}},"type":"object"},"aws-native:bedrock:FlowVersionPromptTemplateConfiguration0Properties":{"description":"Prompt template configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:FlowVersionTextPromptTemplateConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:FlowVersionPromptTemplateConfigurationProperties":{"description":"Prompt template configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:FlowVersionTextPromptTemplateConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:FlowVersionPromptTemplateType":{"description":"Prompt template type","type":"string","enum":[{"name":"Text","value":"TEXT"}]},"aws-native:bedrock:FlowVersionRerankingMetadataSelectionMode":{"description":"Reranking Metadata Selection Mode","type":"string","enum":[{"name":"Selective","value":"SELECTIVE"},{"name":"All","value":"ALL"}]},"aws-native:bedrock:FlowVersionRerankingMetadataSelectiveModeConfiguration0Properties":{"description":"Reranking Metadata Selective Mode Configuration","properties":{"fieldsToInclude":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowVersionFieldForReranking"}}},"type":"object","required":["fieldsToInclude"]},"aws-native:bedrock:FlowVersionRerankingMetadataSelectiveModeConfiguration1Properties":{"description":"Reranking Metadata Selective Mode Configuration","properties":{"fieldsToExclude":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowVersionFieldForReranking"}}},"type":"object","required":["fieldsToExclude"]},"aws-native:bedrock:FlowVersionRetrievalFlowNodeConfiguration":{"description":"Retrieval flow node configuration","properties":{"serviceConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVersionRetrievalFlowNodeServiceConfigurationProperties"}},"type":"object","required":["serviceConfiguration"]},"aws-native:bedrock:FlowVersionRetrievalFlowNodeS3Configuration":{"description":"s3 Retrieval configuration for Retrieval node","properties":{"bucketName":{"type":"string","description":"bucket name of an s3 that will be used for Retrieval flow node configuration"}},"type":"object","required":["bucketName"]},"aws-native:bedrock:FlowVersionRetrievalFlowNodeServiceConfiguration0Properties":{"description":"Retrieval service configuration for Retrieval node","properties":{"s3":{"$ref":"#/types/aws-native:bedrock:FlowVersionRetrievalFlowNodeS3Configuration"}},"type":"object"},"aws-native:bedrock:FlowVersionRetrievalFlowNodeServiceConfigurationProperties":{"description":"Retrieval service configuration for Retrieval node","properties":{"s3":{"$ref":"#/types/aws-native:bedrock:FlowVersionRetrievalFlowNodeS3Configuration"}},"type":"object"},"aws-native:bedrock:FlowVersionStorageFlowNodeConfiguration":{"description":"Storage flow node configuration","properties":{"serviceConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVersionStorageFlowNodeServiceConfigurationProperties"}},"type":"object","required":["serviceConfiguration"]},"aws-native:bedrock:FlowVersionStorageFlowNodeS3Configuration":{"description":"s3 storage configuration for storage node","properties":{"bucketName":{"type":"string","description":"bucket name of an s3 that will be used for storage flow node configuration"}},"type":"object","required":["bucketName"]},"aws-native:bedrock:FlowVersionStorageFlowNodeServiceConfiguration0Properties":{"description":"storage service configuration for storage node","properties":{"s3":{"$ref":"#/types/aws-native:bedrock:FlowVersionStorageFlowNodeS3Configuration"}},"type":"object"},"aws-native:bedrock:FlowVersionStorageFlowNodeServiceConfigurationProperties":{"description":"storage service configuration for storage node","properties":{"s3":{"$ref":"#/types/aws-native:bedrock:FlowVersionStorageFlowNodeS3Configuration"}},"type":"object"},"aws-native:bedrock:FlowVersionSupportedLanguages":{"description":"Enum encodes the supported language type","type":"string","enum":[{"name":"Python3","value":"Python_3"}]},"aws-native:bedrock:FlowVersionTextPromptTemplateConfiguration":{"description":"Configuration for text prompt template","properties":{"inputVariables":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:FlowVersionPromptInputVariable"},"description":"List of input variables"},"text":{"type":"string","description":"Prompt content for String prompt template"}},"type":"object","required":["text"]},"aws-native:bedrock:FlowVersionVectorSearchBedrockRerankingConfiguration":{"properties":{"metadataConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVersionMetadataConfigurationForReranking"},"modelConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVersionVectorSearchBedrockRerankingModelConfiguration"},"numberOfRerankedResults":{"type":"number","description":"Number Of Results For Reranking"}},"type":"object","required":["modelConfiguration"]},"aws-native:bedrock:FlowVersionVectorSearchBedrockRerankingModelConfiguration":{"properties":{"additionalModelRequestFields":{"$ref":"#/types/aws-native:bedrock:FlowVersionAdditionalModelRequestFields"},"modelArn":{"type":"string"}},"type":"object","required":["modelArn"]},"aws-native:bedrock:FlowVersionVectorSearchRerankingConfiguration":{"properties":{"bedrockRerankingConfiguration":{"$ref":"#/types/aws-native:bedrock:FlowVersionVectorSearchBedrockRerankingConfiguration"},"type":{"$ref":"#/types/aws-native:bedrock:FlowVersionVectorSearchRerankingConfigurationType"}},"type":"object","required":["type"]},"aws-native:bedrock:FlowVersionVectorSearchRerankingConfigurationType":{"description":"Enum of Rerank Configuration Types","type":"string","enum":[{"name":"BedrockRerankingModel","value":"BEDROCK_RERANKING_MODEL"}]},"aws-native:bedrock:GuardrailAutomatedReasoningPolicyConfig":{"description":"Optional configuration for integrating Automated Reasoning policies with the guardrail.","properties":{"confidenceThreshold":{"type":"number","description":"The confidence threshold for triggering guardrail actions based on Automated Reasoning policy violations."},"policies":{"type":"array","items":{"type":"string"},"description":"The list of Automated Reasoning policy ARNs to include in the guardrail configuration"}},"type":"object","required":["policies"]},"aws-native:bedrock:GuardrailContentFilterAction":{"type":"string","enum":[{"name":"Block","value":"BLOCK"},{"name":"None","value":"NONE"}]},"aws-native:bedrock:GuardrailContentFilterConfig":{"description":"Content filter config in content policy.","properties":{"inputAction":{"$ref":"#/types/aws-native:bedrock:GuardrailContentFilterAction","description":"Specifies the action to take when harmful content is detected. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `NONE` – Take no action but return detection information in the trace response."},"inputEnabled":{"type":"boolean","description":"Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"inputModalities":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:GuardrailModality"},"description":"List of modalities"},"inputStrength":{"$ref":"#/types/aws-native:bedrock:GuardrailFilterStrength","description":"The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces."},"outputAction":{"$ref":"#/types/aws-native:bedrock:GuardrailContentFilterAction","description":"Specifies the action to take when harmful content is detected in the output. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `NONE` – Take no action but return detection information in the trace response."},"outputEnabled":{"type":"boolean","description":"Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"outputModalities":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:GuardrailModality"},"description":"List of modalities"},"outputStrength":{"$ref":"#/types/aws-native:bedrock:GuardrailFilterStrength","description":"The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces."},"type":{"$ref":"#/types/aws-native:bedrock:GuardrailContentFilterType","description":"The harmful category that the content filter is applied to."}},"type":"object","required":["inputStrength","outputStrength","type"]},"aws-native:bedrock:GuardrailContentFilterType":{"description":"Type of filter in content policy","type":"string","enum":[{"name":"Sexual","value":"SEXUAL"},{"name":"Violence","value":"VIOLENCE"},{"name":"Hate","value":"HATE"},{"name":"Insults","value":"INSULTS"},{"name":"Misconduct","value":"MISCONDUCT"},{"name":"PromptAttack","value":"PROMPT_ATTACK"}]},"aws-native:bedrock:GuardrailContentFiltersTierName":{"description":"Tier name for tier configuration in content filters policy","type":"string","enum":[{"name":"Classic","value":"CLASSIC"},{"name":"Standard","value":"STANDARD"}]},"aws-native:bedrock:GuardrailContentPolicyConfig":{"description":"Content policy config for a guardrail.","properties":{"contentFiltersTierConfig":{"$ref":"#/types/aws-native:bedrock:GuardrailContentPolicyConfigContentFiltersTierConfigProperties","description":"Guardrail tier config for content policy"},"filtersConfig":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:GuardrailContentFilterConfig"},"description":"List of content filter configs in content policy."}},"type":"object","required":["filtersConfig"]},"aws-native:bedrock:GuardrailContentPolicyConfigContentFiltersTierConfigProperties":{"description":"Guardrail tier config for content policy","properties":{"tierName":{"$ref":"#/types/aws-native:bedrock:GuardrailContentFiltersTierName"}},"type":"object","required":["tierName"]},"aws-native:bedrock:GuardrailContextualGroundingAction":{"type":"string","enum":[{"name":"Block","value":"BLOCK"},{"name":"None","value":"NONE"}]},"aws-native:bedrock:GuardrailContextualGroundingFilterConfig":{"description":"A config for grounding filter.","properties":{"action":{"$ref":"#/types/aws-native:bedrock:GuardrailContextualGroundingAction","description":"Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `NONE` – Take no action but return detection information in the trace response."},"enabled":{"type":"boolean","description":"Specifies whether to enable contextual grounding evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"threshold":{"type":"number","description":"The threshold for this filter."},"type":{"$ref":"#/types/aws-native:bedrock:GuardrailContextualGroundingFilterType","description":"The filter details for the guardrails contextual grounding filter."}},"type":"object","required":["threshold","type"]},"aws-native:bedrock:GuardrailContextualGroundingFilterType":{"description":"Type of contextual grounding filter","type":"string","enum":[{"name":"Grounding","value":"GROUNDING"},{"name":"Relevance","value":"RELEVANCE"}]},"aws-native:bedrock:GuardrailContextualGroundingPolicyConfig":{"description":"Contextual grounding policy config for a guardrail.","properties":{"filtersConfig":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:GuardrailContextualGroundingFilterConfig"},"description":"List of contextual grounding filter configs."}},"type":"object","required":["filtersConfig"]},"aws-native:bedrock:GuardrailCrossRegionConfig":{"description":"The system-defined guardrail profile that you’re using with your guardrail","properties":{"guardrailProfileArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the guardrail profile"}},"type":"object","required":["guardrailProfileArn"]},"aws-native:bedrock:GuardrailFilterStrength":{"description":"Strength for filters","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Low","value":"LOW"},{"name":"Medium","value":"MEDIUM"},{"name":"High","value":"HIGH"}]},"aws-native:bedrock:GuardrailManagedWordsConfig":{"description":"A managed words config.","properties":{"inputAction":{"$ref":"#/types/aws-native:bedrock:GuardrailWordAction","description":"Specifies the action to take when harmful content is detected in the input. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `NONE` – Take no action but return detection information in the trace response."},"inputEnabled":{"type":"boolean","description":"Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"outputAction":{"$ref":"#/types/aws-native:bedrock:GuardrailWordAction","description":"Specifies the action to take when harmful content is detected in the output. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `NONE` – Take no action but return detection information in the trace response."},"outputEnabled":{"type":"boolean","description":"Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"type":{"$ref":"#/types/aws-native:bedrock:GuardrailManagedWordsType","description":"The managed word type to configure for the guardrail."}},"type":"object","required":["type"]},"aws-native:bedrock:GuardrailManagedWordsType":{"description":"Options for managed words.","type":"string","enum":[{"name":"Profanity","value":"PROFANITY"}]},"aws-native:bedrock:GuardrailModality":{"description":"Modality for filters","type":"string","enum":[{"name":"Text","value":"TEXT"},{"name":"Image","value":"IMAGE"}]},"aws-native:bedrock:GuardrailPiiEntityConfig":{"description":"Pii entity configuration.","properties":{"action":{"$ref":"#/types/aws-native:bedrock:GuardrailSensitiveInformationAction","description":"Configure guardrail action when the PII entity is detected."},"inputAction":{"$ref":"#/types/aws-native:bedrock:GuardrailSensitiveInformationAction","description":"Specifies the action to take when harmful content is detected in the input. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `ANONYMIZE` – Mask the content and replace it with identifier tags.\n- `NONE` – Take no action but return detection information in the trace response."},"inputEnabled":{"type":"boolean","description":"Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"outputAction":{"$ref":"#/types/aws-native:bedrock:GuardrailSensitiveInformationAction","description":"Specifies the action to take when harmful content is detected in the output. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `ANONYMIZE` – Mask the content and replace it with identifier tags.\n- `NONE` – Take no action but return detection information in the trace response."},"outputEnabled":{"type":"boolean","description":"Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"type":{"$ref":"#/types/aws-native:bedrock:GuardrailPiiEntityType","description":"Configure guardrail type when the PII entity is detected.\n\nThe following PIIs are used to block or mask sensitive information:\n\n- *General*\n\n- *ADDRESS*\n\nA physical address, such as \"100 Main Street, Anytown, USA\" or \"Suite #12, Building 123\". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.\n- *AGE*\n\nAn individual's age, including the quantity and unit of time. For example, in the phrase \"I am 40 years old,\" Guardrails recognizes \"40 years\" as an age.\n- *NAME*\n\nAn individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the \"John Doe Organization\" as an organization, and it recognizes \"Jane Doe Street\" as an address.\n- *EMAIL*\n\nAn email address, such as *marymajor@email.com* .\n- *PHONE*\n\nA phone number. This entity type also includes fax and pager numbers.\n- *USERNAME*\n\nA user name that identifies an account, such as a login name, screen name, nick name, or handle.\n- *PASSWORD*\n\nAn alphanumeric string that is used as a password, such as \"* *very20special#pass** \".\n- *DRIVER_ID*\n\nThe number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.\n- *LICENSE_PLATE*\n\nA license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.\n- *VEHICLE_IDENTIFICATION_NUMBER*\n\nA Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs.\n- *Finance*\n\n- *CREDIT_DEBIT_CARD_CVV*\n\nA three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.\n- *CREDIT_DEBIT_CARD_EXPIRY*\n\nThe expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY* . Guardrails recognizes expiration dates such as *01/21* , *01/2021* , and *Jan 2021* .\n- *CREDIT_DEBIT_CARD_NUMBER*\n\nThe number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.\n- *PIN*\n\nA four-digit personal identification number (PIN) with which you can access your bank account.\n- *INTERNATIONAL_BANK_ACCOUNT_NUMBER*\n\nAn International Bank Account Number has specific formats in each country. For more information, see [www.iban.com/structure](https://docs.aws.amazon.com/https://www.iban.com/structure) .\n- *SWIFT_CODE*\n\nA SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.\n\nSWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.\n- *IT*\n\n- *IP_ADDRESS*\n\nAn IPv4 address, such as *198.51.100.0* .\n- *MAC_ADDRESS*\n\nA *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC).\n- *URL*\n\nA web address, such as *www.example.com* .\n- *AWS_ACCESS_KEY*\n\nA unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.\n- *AWS_SECRET_KEY*\n\nA unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.\n- *USA specific*\n\n- *US_BANK_ACCOUNT_NUMBER*\n\nA US bank account number, which is typically 10 to 12 digits long.\n- *US_BANK_ROUTING_NUMBER*\n\nA US bank account routing number. These are typically nine digits long,\n- *US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER*\n\nA US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a \"9\" and contain a \"7\" or \"8\" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.\n- *US_PASSPORT_NUMBER*\n\nA US passport number. Passport numbers range from six to nine alphanumeric characters.\n- *US_SOCIAL_SECURITY_NUMBER*\n\nA US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.\n- *Canada specific*\n\n- *CA_HEALTH_NUMBER*\n\nA Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.\n- *CA_SOCIAL_INSURANCE_NUMBER*\n\nA Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.\n\nThe SIN is formatted as three groups of three digits, such as *123-456-789* . A SIN can be validated through a simple check-digit process called the [Luhn algorithm](https://docs.aws.amazon.com/https://www.wikipedia.org/wiki/Luhn_algorithm) .\n- *UK Specific*\n\n- *UK_NATIONAL_HEALTH_SERVICE_NUMBER*\n\nA UK National Health Service Number is a 10-17 digit number, such as *485 777 3456* . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.\n- *UK_NATIONAL_INSURANCE_NUMBER*\n\nA UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.\n\nThe number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.\n- *UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER*\n\nA UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.\n- *Custom*\n\n- *Regex filter* - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc.."}},"type":"object","required":["action","type"]},"aws-native:bedrock:GuardrailPiiEntityType":{"description":"The currently supported PII entities","type":"string","enum":[{"name":"Address","value":"ADDRESS"},{"name":"Age","value":"AGE"},{"name":"AwsAccessKey","value":"AWS_ACCESS_KEY"},{"name":"AwsSecretKey","value":"AWS_SECRET_KEY"},{"name":"CaHealthNumber","value":"CA_HEALTH_NUMBER"},{"name":"CaSocialInsuranceNumber","value":"CA_SOCIAL_INSURANCE_NUMBER"},{"name":"CreditDebitCardCvv","value":"CREDIT_DEBIT_CARD_CVV"},{"name":"CreditDebitCardExpiry","value":"CREDIT_DEBIT_CARD_EXPIRY"},{"name":"CreditDebitCardNumber","value":"CREDIT_DEBIT_CARD_NUMBER"},{"name":"DriverId","value":"DRIVER_ID"},{"name":"Email","value":"EMAIL"},{"name":"InternationalBankAccountNumber","value":"INTERNATIONAL_BANK_ACCOUNT_NUMBER"},{"name":"IpAddress","value":"IP_ADDRESS"},{"name":"LicensePlate","value":"LICENSE_PLATE"},{"name":"MacAddress","value":"MAC_ADDRESS"},{"name":"Name","value":"NAME"},{"name":"Password","value":"PASSWORD"},{"name":"Phone","value":"PHONE"},{"name":"Pin","value":"PIN"},{"name":"SwiftCode","value":"SWIFT_CODE"},{"name":"UkNationalHealthServiceNumber","value":"UK_NATIONAL_HEALTH_SERVICE_NUMBER"},{"name":"UkNationalInsuranceNumber","value":"UK_NATIONAL_INSURANCE_NUMBER"},{"name":"UkUniqueTaxpayerReferenceNumber","value":"UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"},{"name":"Url","value":"URL"},{"name":"Username","value":"USERNAME"},{"name":"UsBankAccountNumber","value":"US_BANK_ACCOUNT_NUMBER"},{"name":"UsBankRoutingNumber","value":"US_BANK_ROUTING_NUMBER"},{"name":"UsIndividualTaxIdentificationNumber","value":"US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"},{"name":"UsPassportNumber","value":"US_PASSPORT_NUMBER"},{"name":"UsSocialSecurityNumber","value":"US_SOCIAL_SECURITY_NUMBER"},{"name":"VehicleIdentificationNumber","value":"VEHICLE_IDENTIFICATION_NUMBER"}]},"aws-native:bedrock:GuardrailRegexConfig":{"description":"A regex configuration.","properties":{"action":{"$ref":"#/types/aws-native:bedrock:GuardrailSensitiveInformationAction","description":"The guardrail action to configure when matching regular expression is detected."},"description":{"type":"string","description":"The regex description."},"inputAction":{"$ref":"#/types/aws-native:bedrock:GuardrailSensitiveInformationAction","description":"Specifies the action to take when harmful content is detected in the input. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `NONE` – Take no action but return detection information in the trace response."},"inputEnabled":{"type":"boolean","description":"Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"name":{"type":"string","description":"The regex name."},"outputAction":{"$ref":"#/types/aws-native:bedrock:GuardrailSensitiveInformationAction","description":"Specifies the action to take when harmful content is detected in the output. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `NONE` – Take no action but return detection information in the trace response."},"outputEnabled":{"type":"boolean","description":"Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"pattern":{"type":"string","description":"The regex pattern."}},"type":"object","required":["action","name","pattern"]},"aws-native:bedrock:GuardrailSensitiveInformationAction":{"description":"Options for sensitive information action.","type":"string","enum":[{"name":"Block","value":"BLOCK"},{"name":"Anonymize","value":"ANONYMIZE"},{"name":"None","value":"NONE"}]},"aws-native:bedrock:GuardrailSensitiveInformationPolicyConfig":{"description":"Sensitive information policy config for a guardrail.","properties":{"piiEntitiesConfig":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:GuardrailPiiEntityConfig"},"description":"List of entities."},"regexesConfig":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:GuardrailRegexConfig"},"description":"List of regex."}},"type":"object"},"aws-native:bedrock:GuardrailStatus":{"description":"Status of the guardrail","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Updating","value":"UPDATING"},{"name":"Versioning","value":"VERSIONING"},{"name":"Ready","value":"READY"},{"name":"Failed","value":"FAILED"},{"name":"Deleting","value":"DELETING"}]},"aws-native:bedrock:GuardrailTag":{"description":"Definition of the key/value pair for a tag","properties":{"key":{"type":"string","description":"Tag Key"},"value":{"type":"string","description":"Tag Value"}},"type":"object","required":["key","value"]},"aws-native:bedrock:GuardrailTopicAction":{"type":"string","enum":[{"name":"Block","value":"BLOCK"},{"name":"None","value":"NONE"}]},"aws-native:bedrock:GuardrailTopicConfig":{"description":"Topic config in topic policy.","properties":{"definition":{"type":"string","description":"Definition of topic in topic policy"},"examples":{"type":"array","items":{"type":"string"},"description":"List of text examples"},"inputAction":{"$ref":"#/types/aws-native:bedrock:GuardrailTopicAction","description":"Specifies the action to take when harmful content is detected in the input. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `NONE` – Take no action but return detection information in the trace response."},"inputEnabled":{"type":"boolean","description":"Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"name":{"type":"string","description":"Name of topic in topic policy"},"outputAction":{"$ref":"#/types/aws-native:bedrock:GuardrailTopicAction","description":"Specifies the action to take when harmful content is detected in the output. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `NONE` – Take no action but return detection information in the trace response."},"outputEnabled":{"type":"boolean","description":"Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"type":{"$ref":"#/types/aws-native:bedrock:GuardrailTopicType","description":"Specifies to deny the topic."}},"type":"object","required":["definition","name","type"]},"aws-native:bedrock:GuardrailTopicPolicyConfig":{"description":"Topic policy config for a guardrail.","properties":{"topicsConfig":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:GuardrailTopicConfig"},"description":"List of topic configs in topic policy."},"topicsTierConfig":{"$ref":"#/types/aws-native:bedrock:GuardrailTopicPolicyConfigTopicsTierConfigProperties","description":"Guardrail tier config for topic policy"}},"type":"object","required":["topicsConfig"]},"aws-native:bedrock:GuardrailTopicPolicyConfigTopicsTierConfigProperties":{"description":"Guardrail tier config for topic policy","properties":{"tierName":{"$ref":"#/types/aws-native:bedrock:GuardrailTopicsTierName"}},"type":"object","required":["tierName"]},"aws-native:bedrock:GuardrailTopicType":{"description":"Type of topic in a policy","type":"string","enum":[{"name":"Deny","value":"DENY"}]},"aws-native:bedrock:GuardrailTopicsTierName":{"description":"Tier name for tier configuration in topic policy","type":"string","enum":[{"name":"Classic","value":"CLASSIC"},{"name":"Standard","value":"STANDARD"}]},"aws-native:bedrock:GuardrailWordAction":{"type":"string","enum":[{"name":"Block","value":"BLOCK"},{"name":"None","value":"NONE"}]},"aws-native:bedrock:GuardrailWordConfig":{"description":"A custom word config.","properties":{"inputAction":{"$ref":"#/types/aws-native:bedrock:GuardrailWordAction","description":"Specifies the action to take when harmful content is detected in the input. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `NONE` – Take no action but return detection information in the trace response."},"inputEnabled":{"type":"boolean","description":"Specifies whether to enable guardrail evaluation on the intput. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"outputAction":{"$ref":"#/types/aws-native:bedrock:GuardrailWordAction","description":"Specifies the action to take when harmful content is detected in the output. Supported values include:\n\n- `BLOCK` – Block the content and replace it with blocked messaging.\n- `NONE` – Take no action but return detection information in the trace response."},"outputEnabled":{"type":"boolean","description":"Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response."},"text":{"type":"string","description":"The custom word text."}},"type":"object","required":["text"]},"aws-native:bedrock:GuardrailWordPolicyConfig":{"description":"Word policy config for a guardrail.","properties":{"managedWordListsConfig":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:GuardrailManagedWordsConfig"},"description":"A config for the list of managed words."},"wordsConfig":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:GuardrailWordConfig"},"description":"List of custom word configs."}},"type":"object"},"aws-native:bedrock:IntelligentPromptRouterPromptRouterStatus":{"description":"Status of a PromptRouter","type":"string","enum":[{"name":"Available","value":"AVAILABLE"}]},"aws-native:bedrock:IntelligentPromptRouterPromptRouterTargetModel":{"description":"Model configuration","properties":{"modelArn":{"type":"string","description":"Arn of underlying model which are added in the Prompt Router."}},"type":"object","required":["modelArn"]},"aws-native:bedrock:IntelligentPromptRouterPromptRouterType":{"description":"Type of a Prompt Router","type":"string","enum":[{"name":"Custom","value":"custom"},{"name":"Default","value":"default"}]},"aws-native:bedrock:IntelligentPromptRouterRoutingCriteria":{"description":"Represents the criteria used for routing requests.","properties":{"responseQualityDifference":{"type":"number","description":"The criteria's response quality difference."}},"type":"object","required":["responseQualityDifference"]},"aws-native:bedrock:IntelligentPromptRouterTag":{"description":"Definition of the key/value pair for a tag","properties":{"key":{"type":"string","description":"Tag Key"},"value":{"type":"string","description":"Tag Value"}},"type":"object","required":["key","value"]},"aws-native:bedrock:KnowledgeBaseAudioConfiguration":{"description":"Configure the audio configuration for multi modal ingestion.","properties":{"segmentationConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseAudioSegmentationConfiguration"}},"type":"object","required":["segmentationConfiguration"]},"aws-native:bedrock:KnowledgeBaseAudioSegmentationConfiguration":{"description":"Configure the audio segmentation configuration for multi modal ingestion.","properties":{"fixedLengthDuration":{"type":"integer"}},"type":"object","required":["fixedLengthDuration"]},"aws-native:bedrock:KnowledgeBaseBedrockEmbeddingModelConfiguration":{"description":"The vector configuration details for the Bedrock embeddings model.","properties":{"audio":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseAudioConfiguration"},"description":"Configuration settings for processing audio content in multimodal knowledge bases."},"dimensions":{"type":"integer","description":"The dimensions details for the vector configuration used on the Bedrock embeddings model."},"embeddingDataType":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType","description":"The data type for the vectors when using a model to convert text into vector embeddings."},"video":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseVideoConfiguration"},"description":"Configuration settings for processing video content in multimodal knowledge bases."}},"type":"object"},"aws-native:bedrock:KnowledgeBaseBedrockEmbeddingModelConfigurationEmbeddingDataType":{"description":"The data type for the vectors when using a model to convert text into vector embeddings.","type":"string","enum":[{"name":"Float32","value":"FLOAT32"},{"name":"Binary","value":"BINARY"}]},"aws-native:bedrock:KnowledgeBaseConfiguration":{"description":"Contains details about the embeddings model used for the knowledge base.","properties":{"kendraKnowledgeBaseConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseKendraKnowledgeBaseConfiguration","description":"Settings for an Amazon Kendra knowledge base.","replaceOnChanges":true},"sqlKnowledgeBaseConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseSqlKnowledgeBaseConfiguration","description":"Specifies configurations for a knowledge base connected to an SQL database."},"type":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseType","description":"The type of data that the data source is converted into for the knowledge base.","replaceOnChanges":true},"vectorKnowledgeBaseConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseVectorKnowledgeBaseConfiguration","description":"Contains details about the model that's used to convert the data source into vector embeddings.","replaceOnChanges":true}},"type":"object","required":["type"]},"aws-native:bedrock:KnowledgeBaseCuratedQuery":{"description":"Curated query or question and answer pair","properties":{"naturalLanguage":{"type":"string"},"sql":{"type":"string"}},"type":"object","required":["naturalLanguage","sql"]},"aws-native:bedrock:KnowledgeBaseEmbeddingModelConfiguration":{"description":"The embeddings model configuration details for the vector model used in Knowledge Base.","properties":{"bedrockEmbeddingModelConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseBedrockEmbeddingModelConfiguration","description":"The vector configuration details on the Bedrock embeddings model."}},"type":"object"},"aws-native:bedrock:KnowledgeBaseInclusionType":{"description":"Include or Exclude status for an entity","type":"string","enum":[{"name":"Include","value":"INCLUDE"},{"name":"Exclude","value":"EXCLUDE"}]},"aws-native:bedrock:KnowledgeBaseKendraKnowledgeBaseConfiguration":{"description":"Configurations for a Kendra knowledge base","properties":{"kendraIndexArn":{"type":"string","description":"The ARN of the Amazon Kendra index."}},"type":"object","required":["kendraIndexArn"]},"aws-native:bedrock:KnowledgeBaseMongoDbAtlasConfiguration":{"description":"Contains the storage configuration of the knowledge base in MongoDb Atlas Cloud.","properties":{"collectionName":{"type":"string","description":"Name of the collection within MongoDB Atlas."},"credentialsSecretArn":{"type":"string","description":"The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon Mongo database."},"databaseName":{"type":"string","description":"Name of the database within MongoDB Atlas."},"endpoint":{"type":"string","description":"MongoDB Atlas endpoint."},"endpointServiceName":{"type":"string","description":"MongoDB Atlas endpoint service name."},"fieldMapping":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseMongoDbAtlasFieldMapping","description":"Contains the names of the fields to which to map information about the vector store."},"textIndexName":{"type":"string","description":"Name of a MongoDB Atlas text index."},"vectorIndexName":{"type":"string","description":"Name of a MongoDB Atlas index."}},"type":"object","required":["collectionName","credentialsSecretArn","databaseName","endpoint","fieldMapping","vectorIndexName"]},"aws-native:bedrock:KnowledgeBaseMongoDbAtlasFieldMapping":{"description":"Contains the names of the fields to which to map information about the vector store.","properties":{"metadataField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores metadata about the vector store."},"textField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose."},"vectorField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources."}},"type":"object","required":["metadataField","textField","vectorField"]},"aws-native:bedrock:KnowledgeBaseNeptuneAnalyticsConfiguration":{"description":"Contains the configurations to use Neptune Analytics as Vector Store.","properties":{"fieldMapping":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseNeptuneAnalyticsFieldMapping","description":"Contains the names of the fields to which to map information about the vector store."},"graphArn":{"type":"string","description":"ARN for Neptune Analytics graph database."}},"type":"object","required":["fieldMapping","graphArn"]},"aws-native:bedrock:KnowledgeBaseNeptuneAnalyticsFieldMapping":{"description":"A mapping of Bedrock Knowledge Base fields to Neptune Analytics fields.","properties":{"metadataField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores metadata about the vector store."},"textField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose."}},"type":"object","required":["metadataField","textField"]},"aws-native:bedrock:KnowledgeBaseOpenSearchManagedClusterConfiguration":{"description":"Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.","properties":{"domainArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the OpenSearch domain."},"domainEndpoint":{"type":"string","description":"The endpoint URL the OpenSearch domain."},"fieldMapping":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseOpenSearchManagedClusterFieldMapping","description":"Contains the names of the fields to which to map information about the vector store."},"vectorIndexName":{"type":"string","description":"The name of the vector store."}},"type":"object","required":["domainArn","domainEndpoint","fieldMapping","vectorIndexName"]},"aws-native:bedrock:KnowledgeBaseOpenSearchManagedClusterFieldMapping":{"description":"A mapping of Bedrock Knowledge Base fields to OpenSearch Managed Cluster field names","properties":{"metadataField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores metadata about the vector store."},"textField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose."},"vectorField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources."}},"type":"object","required":["metadataField","textField","vectorField"]},"aws-native:bedrock:KnowledgeBaseOpenSearchServerlessConfiguration":{"description":"Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.","properties":{"collectionArn":{"type":"string","description":"The ARN of the OpenSearch Service vector store."},"fieldMapping":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseOpenSearchServerlessFieldMapping","description":"Contains the names of the fields to which to map information about the vector store."},"vectorIndexName":{"type":"string","description":"The name of the vector store."}},"type":"object","required":["collectionArn","fieldMapping","vectorIndexName"]},"aws-native:bedrock:KnowledgeBaseOpenSearchServerlessFieldMapping":{"description":"A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names","properties":{"metadataField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores metadata about the vector store."},"textField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose."},"vectorField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources."}},"type":"object","required":["metadataField","textField","vectorField"]},"aws-native:bedrock:KnowledgeBasePineconeConfiguration":{"description":"Contains the storage configuration of the knowledge base in Pinecone.","properties":{"connectionString":{"type":"string","description":"The endpoint URL for your index management page."},"credentialsSecretArn":{"type":"string","description":"The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key."},"fieldMapping":{"$ref":"#/types/aws-native:bedrock:KnowledgeBasePineconeFieldMapping","description":"Contains the names of the fields to which to map information about the vector store."},"namespace":{"type":"string","description":"The namespace to be used to write new data to your database."}},"type":"object","required":["connectionString","credentialsSecretArn","fieldMapping"]},"aws-native:bedrock:KnowledgeBasePineconeFieldMapping":{"description":"Contains the names of the fields to which to map information about the vector store.","properties":{"metadataField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores metadata about the vector store."},"textField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose."}},"type":"object","required":["metadataField","textField"]},"aws-native:bedrock:KnowledgeBaseQueryEngineType":{"description":"SQL query engine type","type":"string","enum":[{"name":"Redshift","value":"REDSHIFT"}]},"aws-native:bedrock:KnowledgeBaseQueryGenerationColumn":{"description":"Redshift query generation column","properties":{"description":{"type":"string"},"inclusion":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseInclusionType"},"name":{"type":"string"}},"type":"object"},"aws-native:bedrock:KnowledgeBaseQueryGenerationConfiguration":{"description":"Configurations for generating Redshift engine queries","properties":{"executionTimeoutSeconds":{"type":"integer","description":"The time after which query generation will time out."},"generationContext":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseQueryGenerationContext","description":"Specifies configurations for context to use during query generation."}},"type":"object"},"aws-native:bedrock:KnowledgeBaseQueryGenerationContext":{"description":"Context used to improve query generation","properties":{"curatedQueries":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseCuratedQuery"},"description":"An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries."},"tables":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseQueryGenerationTable"},"description":"An array of objects, each of which defines information about a table in the database."}},"type":"object"},"aws-native:bedrock:KnowledgeBaseQueryGenerationTable":{"description":"Tables used for Redshift query generation context","properties":{"columns":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseQueryGenerationColumn"}},"description":{"type":"string"},"inclusion":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseInclusionType"},"name":{"type":"string"}},"type":"object","required":["name"]},"aws-native:bedrock:KnowledgeBaseRdsConfiguration":{"description":"Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.","properties":{"credentialsSecretArn":{"type":"string","description":"The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database."},"databaseName":{"type":"string","description":"The name of your Amazon RDS database."},"fieldMapping":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRdsFieldMapping","description":"Contains the names of the fields to which to map information about the vector store."},"resourceArn":{"type":"string","description":"The ARN of the vector store."},"tableName":{"type":"string","description":"The name of the table in the database."}},"type":"object","required":["credentialsSecretArn","databaseName","fieldMapping","resourceArn","tableName"]},"aws-native:bedrock:KnowledgeBaseRdsFieldMapping":{"description":"Contains the names of the fields to which to map information about the vector store.","properties":{"customMetadataField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores custom metadata about the vector store."},"metadataField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores metadata about the vector store."},"primaryKeyField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores the ID for each entry."},"textField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose."},"vectorField":{"type":"string","description":"The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources."}},"type":"object","required":["metadataField","primaryKeyField","textField","vectorField"]},"aws-native:bedrock:KnowledgeBaseRedshiftConfiguration":{"description":"Configurations for a Redshift knowledge base","properties":{"queryEngineConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftQueryEngineConfiguration","description":"Specifies configurations for an Amazon Redshift query engine.","replaceOnChanges":true},"queryGenerationConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseQueryGenerationConfiguration","description":"Specifies configurations for generating queries."},"storageConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftQueryEngineStorageConfiguration"},"description":"Specifies configurations for Amazon Redshift database storage.","replaceOnChanges":true}},"type":"object","required":["queryEngineConfiguration","storageConfigurations"]},"aws-native:bedrock:KnowledgeBaseRedshiftProvisionedAuthConfiguration":{"description":"Configurations for Redshift query engine provisioned auth setup","properties":{"databaseUser":{"type":"string","description":"Redshift database user"},"type":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftProvisionedAuthType","description":"The type of authentication to use."},"usernamePasswordSecretArn":{"type":"string","description":"The ARN of an Secrets Manager secret for authentication."}},"type":"object","required":["type"]},"aws-native:bedrock:KnowledgeBaseRedshiftProvisionedAuthType":{"description":"Provisioned Redshift auth type","type":"string","enum":[{"name":"Iam","value":"IAM"},{"name":"UsernamePassword","value":"USERNAME_PASSWORD"},{"name":"Username","value":"USERNAME"}]},"aws-native:bedrock:KnowledgeBaseRedshiftProvisionedConfiguration":{"description":"Configurations for provisioned Redshift query engine","properties":{"authConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftProvisionedAuthConfiguration","description":"Specifies configurations for authentication to Amazon Redshift."},"clusterIdentifier":{"type":"string","description":"The ID of the Amazon Redshift cluster."}},"type":"object","required":["authConfiguration","clusterIdentifier"]},"aws-native:bedrock:KnowledgeBaseRedshiftQueryEngineAwsDataCatalogStorageConfiguration":{"description":"Configurations for Redshift query engine AWS Data Catalog backed storage","properties":{"tableNames":{"type":"array","items":{"type":"string"}}},"type":"object","required":["tableNames"]},"aws-native:bedrock:KnowledgeBaseRedshiftQueryEngineConfiguration":{"description":"Configurations for Redshift query engine","properties":{"provisionedConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftProvisionedConfiguration","description":"Specifies configurations for a provisioned Amazon Redshift query engine."},"serverlessConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftServerlessConfiguration","description":"Specifies configurations for a serverless Amazon Redshift query engine."},"type":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftQueryEngineType","description":"The type of query engine."}},"type":"object","required":["type"]},"aws-native:bedrock:KnowledgeBaseRedshiftQueryEngineRedshiftStorageConfiguration":{"description":"Configurations for Redshift query engine Redshift backed storage","properties":{"databaseName":{"type":"string"}},"type":"object","required":["databaseName"]},"aws-native:bedrock:KnowledgeBaseRedshiftQueryEngineStorageConfiguration":{"description":"Configurations for available Redshift query engine storage types","properties":{"awsDataCatalogConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftQueryEngineAwsDataCatalogStorageConfiguration"},"redshiftConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftQueryEngineRedshiftStorageConfiguration"},"type":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftQueryEngineStorageType"}},"type":"object","required":["type"]},"aws-native:bedrock:KnowledgeBaseRedshiftQueryEngineStorageType":{"description":"Redshift query engine storage type","type":"string","enum":[{"name":"Redshift","value":"REDSHIFT"},{"name":"AwsDataCatalog","value":"AWS_DATA_CATALOG"}]},"aws-native:bedrock:KnowledgeBaseRedshiftQueryEngineType":{"description":"Redshift query engine type","type":"string","enum":[{"name":"Serverless","value":"SERVERLESS"},{"name":"Provisioned","value":"PROVISIONED"}]},"aws-native:bedrock:KnowledgeBaseRedshiftServerlessAuthConfiguration":{"description":"Configurations for Redshift query engine serverless auth setup","properties":{"type":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftServerlessAuthType","description":"The type of authentication to use."},"usernamePasswordSecretArn":{"type":"string","description":"The ARN of an Secrets Manager secret for authentication."}},"type":"object","required":["type"]},"aws-native:bedrock:KnowledgeBaseRedshiftServerlessAuthType":{"description":"Serverless Redshift auth type","type":"string","enum":[{"name":"Iam","value":"IAM"},{"name":"UsernamePassword","value":"USERNAME_PASSWORD"}]},"aws-native:bedrock:KnowledgeBaseRedshiftServerlessConfiguration":{"description":"Configurations for serverless Redshift query engine","properties":{"authConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftServerlessAuthConfiguration","description":"Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse."},"workgroupArn":{"type":"string","description":"The ARN of the Amazon Redshift workgroup."}},"type":"object","required":["authConfiguration","workgroupArn"]},"aws-native:bedrock:KnowledgeBaseS3Location":{"description":"An Amazon S3 location.","properties":{"uri":{"type":"string","description":"The location's URI"}},"type":"object","required":["uri"]},"aws-native:bedrock:KnowledgeBaseS3VectorsConfiguration":{"description":"Contains the storage configuration of the knowledge base for S3 vectors.","properties":{"indexArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the vector index used for the knowledge base. This ARN identifies the specific vector index resource within Amazon Bedrock."},"indexName":{"type":"string","description":"The name of the vector index used for the knowledge base. This name identifies the vector index within the Amazon Bedrock service."},"vectorBucketArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored. This bucket contains the vector data used by the knowledge base."}},"type":"object"},"aws-native:bedrock:KnowledgeBaseSqlKnowledgeBaseConfiguration":{"description":"Configurations for a SQL knowledge base","properties":{"redshiftConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRedshiftConfiguration","description":"Specifies configurations for a knowledge base connected to an Amazon Redshift database."},"type":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseQueryEngineType","description":"The type of SQL database to connect to the knowledge base.","replaceOnChanges":true}},"type":"object","required":["type"]},"aws-native:bedrock:KnowledgeBaseStatus":{"description":"The status of a knowledge base.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Updating","value":"UPDATING"},{"name":"Failed","value":"FAILED"},{"name":"DeleteUnsuccessful","value":"DELETE_UNSUCCESSFUL"}]},"aws-native:bedrock:KnowledgeBaseStorageConfiguration":{"description":"The vector store service in which the knowledge base is stored.","properties":{"mongoDbAtlasConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseMongoDbAtlasConfiguration","description":"Contains the storage configuration of the knowledge base in MongoDB Atlas."},"neptuneAnalyticsConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseNeptuneAnalyticsConfiguration","description":"Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information, see [Create a vector index in Amazon Neptune Analytics.](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html) ."},"opensearchManagedClusterConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseOpenSearchManagedClusterConfiguration","description":"Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html) ."},"opensearchServerlessConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseOpenSearchServerlessConfiguration","description":"Contains the storage configuration of the knowledge base in Amazon OpenSearch Service."},"pineconeConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBasePineconeConfiguration","description":"Contains the storage configuration of the knowledge base in Pinecone."},"rdsConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseRdsConfiguration","description":"Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html) ."},"s3VectorsConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseS3VectorsConfiguration","description":"The configuration settings for storing knowledge base data using S3 vectors. This includes vector index information and S3 bucket details for vector storage."},"type":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseStorageType","description":"The vector store service in which the knowledge base is stored."}},"type":"object","required":["type"]},"aws-native:bedrock:KnowledgeBaseStorageType":{"description":"The storage type of a knowledge base.","type":"string","enum":[{"name":"OpensearchServerless","value":"OPENSEARCH_SERVERLESS"},{"name":"Pinecone","value":"PINECONE"},{"name":"Rds","value":"RDS"},{"name":"MongoDbAtlas","value":"MONGO_DB_ATLAS"},{"name":"NeptuneAnalytics","value":"NEPTUNE_ANALYTICS"},{"name":"S3Vectors","value":"S3_VECTORS"},{"name":"OpensearchManagedCluster","value":"OPENSEARCH_MANAGED_CLUSTER"}]},"aws-native:bedrock:KnowledgeBaseSupplementalDataStorageConfiguration":{"description":"Configurations for supplemental data storage.","properties":{"supplementalDataStorageLocations":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseSupplementalDataStorageLocation"}}},"type":"object","required":["supplementalDataStorageLocations"]},"aws-native:bedrock:KnowledgeBaseSupplementalDataStorageLocation":{"description":"Supplemental data storage location.","properties":{"s3Location":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseS3Location"},"supplementalDataStorageLocationType":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseSupplementalDataStorageLocationType"}},"type":"object","required":["supplementalDataStorageLocationType"]},"aws-native:bedrock:KnowledgeBaseSupplementalDataStorageLocationType":{"description":"Supplemental data storage location type.","type":"string","enum":[{"name":"S3","value":"S3"}]},"aws-native:bedrock:KnowledgeBaseType":{"description":"The type of a knowledge base.","type":"string","enum":[{"name":"Vector","value":"VECTOR"},{"name":"Kendra","value":"KENDRA"},{"name":"Sql","value":"SQL"}]},"aws-native:bedrock:KnowledgeBaseVectorKnowledgeBaseConfiguration":{"description":"Contains details about the model used to create vector embeddings for the knowledge base.","properties":{"embeddingModelArn":{"type":"string","description":"The ARN of the model used to create vector embeddings for the knowledge base."},"embeddingModelConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseEmbeddingModelConfiguration","description":"The embeddings model configuration details for the vector model used in Knowledge Base."},"supplementalDataStorageConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseSupplementalDataStorageConfiguration","description":"If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using [RetrieveAndGenerate](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html) ."}},"type":"object","required":["embeddingModelArn"]},"aws-native:bedrock:KnowledgeBaseVideoConfiguration":{"description":"Configure the video configuration for multi modal ingestion.","properties":{"segmentationConfiguration":{"$ref":"#/types/aws-native:bedrock:KnowledgeBaseVideoSegmentationConfiguration"}},"type":"object","required":["segmentationConfiguration"]},"aws-native:bedrock:KnowledgeBaseVideoSegmentationConfiguration":{"description":"Configure the video segmentation configuration for multi modal ingestion.","properties":{"fixedLengthDuration":{"type":"integer"}},"type":"object","required":["fixedLengthDuration"]},"aws-native:bedrock:PromptAdditionalModelRequestFields":{"description":"Contains model-specific configurations","type":"object"},"aws-native:bedrock:PromptAgentResource":{"description":"Target Agent to invoke with Prompt","properties":{"agentIdentifier":{"type":"string","description":"Arn representation of the Agent Alias."}},"type":"object","required":["agentIdentifier"]},"aws-native:bedrock:PromptAnyToolChoice":{"description":"Any Tool choice","type":"object"},"aws-native:bedrock:PromptAutoToolChoice":{"description":"Auto Tool choice","type":"object"},"aws-native:bedrock:PromptCachePointBlock":{"description":"CachePointBlock","properties":{"type":{"$ref":"#/types/aws-native:bedrock:PromptCachePointType"}},"type":"object","required":["type"]},"aws-native:bedrock:PromptCachePointType":{"description":"CachePoint types for CachePointBlock","type":"string","enum":[{"name":"Default","value":"default"}]},"aws-native:bedrock:PromptChatPromptTemplateConfiguration":{"description":"Configuration for chat prompt template","properties":{"inputVariables":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:PromptInputVariable"},"description":"List of input variables"},"messages":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:PromptMessage"},"description":"List of messages for chat prompt template"},"system":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:PromptSystemContentBlock0Properties"},{"$ref":"#/types/aws-native:bedrock:PromptSystemContentBlock1Properties"}]},"description":"Configuration for chat prompt template"},"toolConfiguration":{"$ref":"#/types/aws-native:bedrock:PromptToolConfiguration"}},"type":"object","required":["messages"]},"aws-native:bedrock:PromptContentBlock0Properties":{"description":"Configuration for chat prompt template","properties":{"text":{"type":"string","description":"Configuration for chat prompt template"}},"type":"object","required":["text"]},"aws-native:bedrock:PromptContentBlock1Properties":{"description":"Configuration for chat prompt template","properties":{"cachePoint":{"$ref":"#/types/aws-native:bedrock:PromptCachePointBlock"}},"type":"object","required":["cachePoint"]},"aws-native:bedrock:PromptConversationRole":{"description":"Conversation roles for the chat prompt","type":"string","enum":[{"name":"User","value":"user"},{"name":"Assistant","value":"assistant"}]},"aws-native:bedrock:PromptGenAiResource0Properties":{"description":"Target resource to invoke with Prompt","properties":{"agent":{"$ref":"#/types/aws-native:bedrock:PromptAgentResource"}},"type":"object","required":["agent"]},"aws-native:bedrock:PromptGenAiResourceProperties":{"description":"Target resource to invoke with Prompt","properties":{"agent":{"$ref":"#/types/aws-native:bedrock:PromptAgentResource"}},"type":"object","required":["agent"]},"aws-native:bedrock:PromptInferenceConfiguration0Properties":{"description":"Model inference configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:PromptModelInferenceConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:PromptInferenceConfigurationProperties":{"description":"Model inference configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:PromptModelInferenceConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:PromptInputVariable":{"description":"Input variable","properties":{"name":{"type":"string","description":"Name for an input variable"}},"type":"object"},"aws-native:bedrock:PromptMessage":{"description":"Chat prompt Message","properties":{"content":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:PromptContentBlock0Properties"},{"$ref":"#/types/aws-native:bedrock:PromptContentBlock1Properties"}]},"description":"List of Content Blocks"},"role":{"$ref":"#/types/aws-native:bedrock:PromptConversationRole"}},"type":"object","required":["content","role"]},"aws-native:bedrock:PromptMetadataEntry":{"description":"Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:bedrock:PromptModelInferenceConfiguration":{"description":"Prompt model inference configuration","properties":{"maxTokens":{"type":"number","description":"Maximum length of output"},"stopSequences":{"type":"array","items":{"type":"string"},"description":"List of stop sequences"},"temperature":{"type":"number","description":"Controls randomness, higher values increase diversity"},"topP":{"type":"number","description":"Cumulative probability cutoff for token selection"}},"type":"object"},"aws-native:bedrock:PromptSpecificToolChoice":{"description":"Specific Tool choice","properties":{"name":{"type":"string","description":"Tool name"}},"type":"object","required":["name"]},"aws-native:bedrock:PromptSystemContentBlock0Properties":{"description":"Configuration for chat prompt template","properties":{"text":{"type":"string","description":"Configuration for chat prompt template"}},"type":"object","required":["text"]},"aws-native:bedrock:PromptSystemContentBlock1Properties":{"description":"Configuration for chat prompt template","properties":{"cachePoint":{"$ref":"#/types/aws-native:bedrock:PromptCachePointBlock"}},"type":"object","required":["cachePoint"]},"aws-native:bedrock:PromptTemplateConfiguration0Properties":{"description":"Prompt template configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:PromptTextPromptTemplateConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:PromptTemplateConfiguration1Properties":{"description":"Prompt template configuration","properties":{"chat":{"$ref":"#/types/aws-native:bedrock:PromptChatPromptTemplateConfiguration"}},"type":"object","required":["chat"]},"aws-native:bedrock:PromptTemplateType":{"description":"Prompt template type","type":"string","enum":[{"name":"Text","value":"TEXT"},{"name":"Chat","value":"CHAT"}]},"aws-native:bedrock:PromptTextPromptTemplateConfiguration":{"description":"Configuration for text prompt template","properties":{"cachePoint":{"$ref":"#/types/aws-native:bedrock:PromptCachePointBlock"},"inputVariables":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:PromptInputVariable"},"description":"List of input variables"},"text":{"type":"string","description":"Prompt content for String prompt template"},"textS3Location":{"$ref":"#/types/aws-native:bedrock:PromptTextS3Location"}},"type":"object"},"aws-native:bedrock:PromptTextS3Location":{"description":"The identifier for the S3 resource.","properties":{"bucket":{"type":"string","description":"A bucket in S3"},"key":{"type":"string","description":"A object key in S3"},"version":{"type":"string","description":"The version of the the S3 object to use"}},"type":"object","required":["bucket","key"]},"aws-native:bedrock:PromptTool0Properties":{"description":"Tool details","properties":{"toolSpec":{"$ref":"#/types/aws-native:bedrock:PromptToolSpecification"}},"type":"object","required":["toolSpec"]},"aws-native:bedrock:PromptTool1Properties":{"description":"Tool details","properties":{"cachePoint":{"$ref":"#/types/aws-native:bedrock:PromptCachePointBlock"}},"type":"object","required":["cachePoint"]},"aws-native:bedrock:PromptToolChoice0Properties":{"description":"Tool choice","properties":{"auto":{"$ref":"#/types/aws-native:bedrock:PromptAutoToolChoice"}},"type":"object","required":["auto"]},"aws-native:bedrock:PromptToolChoice1Properties":{"description":"Tool choice","properties":{"any":{"$ref":"#/types/aws-native:bedrock:PromptAnyToolChoice"}},"type":"object","required":["any"]},"aws-native:bedrock:PromptToolChoice2Properties":{"description":"Tool choice","properties":{"tool":{"$ref":"#/types/aws-native:bedrock:PromptSpecificToolChoice"}},"type":"object","required":["tool"]},"aws-native:bedrock:PromptToolConfiguration":{"description":"Tool configuration","properties":{"toolChoice":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:PromptToolChoice0Properties"},{"$ref":"#/types/aws-native:bedrock:PromptToolChoice1Properties"},{"$ref":"#/types/aws-native:bedrock:PromptToolChoice2Properties"}]},"tools":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:PromptTool0Properties"},{"$ref":"#/types/aws-native:bedrock:PromptTool1Properties"}]},"description":"List of Tools"}},"type":"object","required":["tools"]},"aws-native:bedrock:PromptToolInputSchema0Properties":{"description":"Tool input schema json","properties":{"json":{"$ref":"pulumi.json#/Any"}},"type":"object","required":["json"]},"aws-native:bedrock:PromptToolInputSchemaProperties":{"description":"Tool input schema json","properties":{"json":{"$ref":"pulumi.json#/Any"}},"type":"object","required":["json"]},"aws-native:bedrock:PromptToolSpecification":{"description":"Tool specification","properties":{"description":{"type":"string"},"inputSchema":{"$ref":"#/types/aws-native:bedrock:PromptToolInputSchemaProperties"},"name":{"type":"string","description":"Tool name"}},"type":"object","required":["inputSchema","name"]},"aws-native:bedrock:PromptVariant":{"description":"Prompt variant","properties":{"additionalModelRequestFields":{"$ref":"#/types/aws-native:bedrock:PromptAdditionalModelRequestFields","description":"Contains model-specific inference configurations that aren't in the `inferenceConfiguration` field. To see model-specific inference parameters, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) ."},"genAiResource":{"$ref":"#/types/aws-native:bedrock:PromptGenAiResourceProperties","description":"Specifies a generative AI resource with which to use the prompt."},"inferenceConfiguration":{"$ref":"#/types/aws-native:bedrock:PromptInferenceConfigurationProperties","description":"Contains inference configurations for the prompt variant."},"metadata":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:PromptMetadataEntry"},"description":"An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant."},"modelId":{"type":"string","description":"ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models."},"name":{"type":"string","description":"Name for a variant."},"templateConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:PromptTemplateConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrock:PromptTemplateConfiguration1Properties"}],"description":"Contains configurations for the prompt template."},"templateType":{"$ref":"#/types/aws-native:bedrock:PromptTemplateType","description":"The type of prompt template to use."}},"type":"object","required":["name","templateConfiguration","templateType"]},"aws-native:bedrock:PromptVersionAdditionalModelRequestFields":{"description":"Contains model-specific configurations","type":"object"},"aws-native:bedrock:PromptVersionAnyToolChoice":{"description":"Any Tool choice","type":"object"},"aws-native:bedrock:PromptVersionAutoToolChoice":{"description":"Auto Tool choice","type":"object"},"aws-native:bedrock:PromptVersionCachePointBlock":{"description":"CachePointBlock","properties":{"type":{"$ref":"#/types/aws-native:bedrock:PromptVersionCachePointType"}},"type":"object","required":["type"]},"aws-native:bedrock:PromptVersionCachePointType":{"description":"CachePoint types for CachePointBlock","type":"string","enum":[{"name":"Default","value":"default"}]},"aws-native:bedrock:PromptVersionChatPromptTemplateConfiguration":{"description":"Configuration for chat prompt template","properties":{"inputVariables":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:PromptVersionPromptInputVariable"},"description":"List of input variables"},"messages":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:PromptVersionMessage"},"description":"List of messages for chat prompt template"},"system":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:PromptVersionSystemContentBlock0Properties"},{"$ref":"#/types/aws-native:bedrock:PromptVersionSystemContentBlock1Properties"}]},"description":"Configuration for chat prompt template"},"toolConfiguration":{"$ref":"#/types/aws-native:bedrock:PromptVersionToolConfiguration"}},"type":"object","required":["messages"]},"aws-native:bedrock:PromptVersionContentBlock0Properties":{"description":"Configuration for chat prompt template","properties":{"text":{"type":"string","description":"Configuration for chat prompt template"}},"type":"object","required":["text"]},"aws-native:bedrock:PromptVersionContentBlock1Properties":{"description":"Configuration for chat prompt template","properties":{"cachePoint":{"$ref":"#/types/aws-native:bedrock:PromptVersionCachePointBlock"}},"type":"object","required":["cachePoint"]},"aws-native:bedrock:PromptVersionConversationRole":{"description":"Conversation roles for the chat prompt","type":"string","enum":[{"name":"User","value":"user"},{"name":"Assistant","value":"assistant"}]},"aws-native:bedrock:PromptVersionMessage":{"description":"Chat prompt Message","properties":{"content":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:PromptVersionContentBlock0Properties"},{"$ref":"#/types/aws-native:bedrock:PromptVersionContentBlock1Properties"}]},"description":"List of Content Blocks"},"role":{"$ref":"#/types/aws-native:bedrock:PromptVersionConversationRole"}},"type":"object","required":["content","role"]},"aws-native:bedrock:PromptVersionPromptAgentResource":{"description":"Target Agent to invoke with Prompt","properties":{"agentIdentifier":{"type":"string","description":"Arn representation of the Agent Alias."}},"type":"object","required":["agentIdentifier"]},"aws-native:bedrock:PromptVersionPromptGenAiResource0Properties":{"description":"Target resource to invoke with Prompt","properties":{"agent":{"$ref":"#/types/aws-native:bedrock:PromptVersionPromptAgentResource"}},"type":"object","required":["agent"]},"aws-native:bedrock:PromptVersionPromptGenAiResourceProperties":{"description":"Target resource to invoke with Prompt","properties":{"agent":{"$ref":"#/types/aws-native:bedrock:PromptVersionPromptAgentResource"}},"type":"object","required":["agent"]},"aws-native:bedrock:PromptVersionPromptInferenceConfiguration0Properties":{"description":"Model inference configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:PromptVersionPromptModelInferenceConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:PromptVersionPromptInferenceConfigurationProperties":{"description":"Model inference configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:PromptVersionPromptModelInferenceConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:PromptVersionPromptInputVariable":{"description":"Input variable","properties":{"name":{"type":"string","description":"Name for an input variable"}},"type":"object"},"aws-native:bedrock:PromptVersionPromptMetadataEntry":{"description":"Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:bedrock:PromptVersionPromptModelInferenceConfiguration":{"description":"Prompt model inference configuration","properties":{"maxTokens":{"type":"number","description":"Maximum length of output"},"stopSequences":{"type":"array","items":{"type":"string"},"description":"List of stop sequences"},"temperature":{"type":"number","description":"Controls randomness, higher values increase diversity"},"topP":{"type":"number","description":"Cumulative probability cutoff for token selection"}},"type":"object"},"aws-native:bedrock:PromptVersionPromptTemplateConfiguration0Properties":{"description":"Prompt template configuration","properties":{"text":{"$ref":"#/types/aws-native:bedrock:PromptVersionTextPromptTemplateConfiguration"}},"type":"object","required":["text"]},"aws-native:bedrock:PromptVersionPromptTemplateConfiguration1Properties":{"description":"Prompt template configuration","properties":{"chat":{"$ref":"#/types/aws-native:bedrock:PromptVersionChatPromptTemplateConfiguration"}},"type":"object","required":["chat"]},"aws-native:bedrock:PromptVersionPromptTemplateType":{"description":"Prompt template type","type":"string","enum":[{"name":"Text","value":"TEXT"},{"name":"Chat","value":"CHAT"}]},"aws-native:bedrock:PromptVersionPromptVariant":{"description":"Prompt variant","properties":{"additionalModelRequestFields":{"$ref":"#/types/aws-native:bedrock:PromptVersionAdditionalModelRequestFields","description":"Contains model-specific inference configurations that aren't in the `inferenceConfiguration` field. To see model-specific inference parameters, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) ."},"genAiResource":{"$ref":"#/types/aws-native:bedrock:PromptVersionPromptGenAiResourceProperties","description":"Specifies a generative AI resource with which to use the prompt."},"inferenceConfiguration":{"$ref":"#/types/aws-native:bedrock:PromptVersionPromptInferenceConfigurationProperties","description":"Contains inference configurations for the prompt variant."},"metadata":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:PromptVersionPromptMetadataEntry"},"description":"An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant."},"modelId":{"type":"string","description":"ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models."},"name":{"type":"string","description":"Name for a variant."},"templateConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:PromptVersionPromptTemplateConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrock:PromptVersionPromptTemplateConfiguration1Properties"}],"description":"Contains configurations for the prompt template."},"templateType":{"$ref":"#/types/aws-native:bedrock:PromptVersionPromptTemplateType","description":"The type of prompt template to use."}},"type":"object","required":["name","templateConfiguration","templateType"]},"aws-native:bedrock:PromptVersionSpecificToolChoice":{"description":"Specific Tool choice","properties":{"name":{"type":"string","description":"Tool name"}},"type":"object","required":["name"]},"aws-native:bedrock:PromptVersionSystemContentBlock0Properties":{"description":"Configuration for chat prompt template","properties":{"text":{"type":"string","description":"Configuration for chat prompt template"}},"type":"object","required":["text"]},"aws-native:bedrock:PromptVersionSystemContentBlock1Properties":{"description":"Configuration for chat prompt template","properties":{"cachePoint":{"$ref":"#/types/aws-native:bedrock:PromptVersionCachePointBlock"}},"type":"object","required":["cachePoint"]},"aws-native:bedrock:PromptVersionTextPromptTemplateConfiguration":{"description":"Configuration for text prompt template","properties":{"cachePoint":{"$ref":"#/types/aws-native:bedrock:PromptVersionCachePointBlock"},"inputVariables":{"type":"array","items":{"$ref":"#/types/aws-native:bedrock:PromptVersionPromptInputVariable"},"description":"List of input variables"},"text":{"type":"string","description":"Prompt content for String prompt template"}},"type":"object","required":["text"]},"aws-native:bedrock:PromptVersionTool0Properties":{"description":"Tool details","properties":{"toolSpec":{"$ref":"#/types/aws-native:bedrock:PromptVersionToolSpecification"}},"type":"object","required":["toolSpec"]},"aws-native:bedrock:PromptVersionTool1Properties":{"description":"Tool details","properties":{"cachePoint":{"$ref":"#/types/aws-native:bedrock:PromptVersionCachePointBlock"}},"type":"object","required":["cachePoint"]},"aws-native:bedrock:PromptVersionToolChoice0Properties":{"description":"Tool choice","properties":{"auto":{"$ref":"#/types/aws-native:bedrock:PromptVersionAutoToolChoice"}},"type":"object","required":["auto"]},"aws-native:bedrock:PromptVersionToolChoice1Properties":{"description":"Tool choice","properties":{"any":{"$ref":"#/types/aws-native:bedrock:PromptVersionAnyToolChoice"}},"type":"object","required":["any"]},"aws-native:bedrock:PromptVersionToolChoice2Properties":{"description":"Tool choice","properties":{"tool":{"$ref":"#/types/aws-native:bedrock:PromptVersionSpecificToolChoice"}},"type":"object","required":["tool"]},"aws-native:bedrock:PromptVersionToolConfiguration":{"description":"Tool configuration","properties":{"toolChoice":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:PromptVersionToolChoice0Properties"},{"$ref":"#/types/aws-native:bedrock:PromptVersionToolChoice1Properties"},{"$ref":"#/types/aws-native:bedrock:PromptVersionToolChoice2Properties"}]},"tools":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:bedrock:PromptVersionTool0Properties"},{"$ref":"#/types/aws-native:bedrock:PromptVersionTool1Properties"}]},"description":"List of Tools"}},"type":"object","required":["tools"]},"aws-native:bedrock:PromptVersionToolInputSchema0Properties":{"description":"Tool input schema json","properties":{"json":{"$ref":"pulumi.json#/Any"}},"type":"object","required":["json"]},"aws-native:bedrock:PromptVersionToolInputSchemaProperties":{"description":"Tool input schema json","properties":{"json":{"$ref":"pulumi.json#/Any"}},"type":"object","required":["json"]},"aws-native:bedrock:PromptVersionToolSpecification":{"description":"Tool specification","properties":{"description":{"type":"string"},"inputSchema":{"$ref":"#/types/aws-native:bedrock:PromptVersionToolInputSchemaProperties"},"name":{"type":"string","description":"Tool name"}},"type":"object","required":["inputSchema","name"]},"aws-native:bedrockagentcore:BrowserCustomBrowserNetworkConfiguration":{"description":"Network configuration for browser","properties":{"networkMode":{"$ref":"#/types/aws-native:bedrockagentcore:BrowserCustomBrowserNetworkMode","description":"The network mode."},"vpcConfig":{"$ref":"#/types/aws-native:bedrockagentcore:BrowserCustomVpcConfig"}},"type":"object","required":["networkMode"]},"aws-native:bedrockagentcore:BrowserCustomBrowserNetworkMode":{"description":"Network modes supported by browser","type":"string","enum":[{"name":"Public","value":"PUBLIC"},{"name":"Vpc","value":"VPC"}]},"aws-native:bedrockagentcore:BrowserCustomBrowserSigning":{"description":"Browser signing configuration","properties":{"enabled":{"type":"boolean"}},"type":"object"},"aws-native:bedrockagentcore:BrowserCustomBrowserStatus":{"description":"Status of browser","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"Ready","value":"READY"},{"name":"Deleting","value":"DELETING"},{"name":"DeleteFailed","value":"DELETE_FAILED"},{"name":"Deleted","value":"DELETED"}]},"aws-native:bedrockagentcore:BrowserCustomRecordingConfig":{"description":"Recording configuration for browser","properties":{"enabled":{"type":"boolean","description":"The recording configuration for a browser. This structure defines how browser sessions are recorded."},"s3Location":{"$ref":"#/types/aws-native:bedrockagentcore:BrowserCustomS3Location","description":"The S3 location."}},"type":"object"},"aws-native:bedrockagentcore:BrowserCustomS3Location":{"description":"S3 Location Configuration","properties":{"bucket":{"type":"string","description":"The S3 location bucket name."},"prefix":{"type":"string","description":"The S3 location object prefix."}},"type":"object","required":["bucket","prefix"]},"aws-native:bedrockagentcore:BrowserCustomVpcConfig":{"description":"Network mode configuration for VPC","properties":{"securityGroups":{"type":"array","items":{"type":"string"}},"subnets":{"type":"array","items":{"type":"string"}}},"type":"object","required":["securityGroups","subnets"]},"aws-native:bedrockagentcore:BrowserProfileStatus":{"description":"Status of browser profile","type":"string","enum":[{"name":"Ready","value":"READY"},{"name":"Deleting","value":"DELETING"},{"name":"Deleted","value":"DELETED"},{"name":"Saving","value":"SAVING"}]},"aws-native:bedrockagentcore:CodeInterpreterCustomCodeInterpreterNetworkConfiguration":{"description":"Network configuration for code interpreter","properties":{"networkMode":{"$ref":"#/types/aws-native:bedrockagentcore:CodeInterpreterCustomCodeInterpreterNetworkMode","description":"The network mode."},"vpcConfig":{"$ref":"#/types/aws-native:bedrockagentcore:CodeInterpreterCustomVpcConfig"}},"type":"object","required":["networkMode"]},"aws-native:bedrockagentcore:CodeInterpreterCustomCodeInterpreterNetworkMode":{"description":"Network modes supported by code interpreter","type":"string","enum":[{"name":"Public","value":"PUBLIC"},{"name":"Sandbox","value":"SANDBOX"},{"name":"Vpc","value":"VPC"}]},"aws-native:bedrockagentcore:CodeInterpreterCustomCodeInterpreterStatus":{"description":"Status of Code interpreter","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"Ready","value":"READY"},{"name":"Deleting","value":"DELETING"},{"name":"DeleteFailed","value":"DELETE_FAILED"},{"name":"Deleted","value":"DELETED"}]},"aws-native:bedrockagentcore:CodeInterpreterCustomVpcConfig":{"description":"Network mode configuration for VPC","properties":{"securityGroups":{"type":"array","items":{"type":"string"}},"subnets":{"type":"array","items":{"type":"string"}}},"type":"object","required":["securityGroups","subnets"]},"aws-native:bedrockagentcore:EvaluatorBedrockEvaluatorModelConfig":{"description":"The configuration for using Amazon Bedrock models in evaluator assessments.","properties":{"additionalModelRequestFields":{"$ref":"pulumi.json#/Any","description":"Additional model-specific request fields."},"inferenceConfig":{"$ref":"#/types/aws-native:bedrockagentcore:EvaluatorInferenceConfiguration"},"modelId":{"type":"string","description":"The identifier of the Amazon Bedrock model to use for evaluation."}},"type":"object","required":["modelId"]},"aws-native:bedrockagentcore:EvaluatorCategoricalScaleDefinition":{"description":"A categorical rating scale option.","properties":{"definition":{"type":"string","description":"The description that explains what this categorical rating represents."},"label":{"type":"string","description":"The label of this categorical rating option."}},"type":"object","required":["definition","label"]},"aws-native:bedrockagentcore:EvaluatorConfig":{"description":"The configuration that defines how an evaluator assesses agent performance.","properties":{"llmAsAJudge":{"$ref":"#/types/aws-native:bedrockagentcore:EvaluatorLlmAsAJudgeEvaluatorConfig"}},"type":"object","required":["llmAsAJudge"]},"aws-native:bedrockagentcore:EvaluatorInferenceConfiguration":{"description":"The inference configuration parameters that control model behavior during evaluation.","properties":{"maxTokens":{"type":"integer","description":"The maximum number of tokens to generate in the model response."},"temperature":{"type":"number","description":"The temperature value that controls randomness in the model's responses."},"topP":{"type":"number","description":"The top-p sampling parameter that controls the diversity of the model's responses."}},"type":"object"},"aws-native:bedrockagentcore:EvaluatorLevel":{"type":"string","enum":[{"name":"ToolCall","value":"TOOL_CALL"},{"name":"Trace","value":"TRACE"},{"name":"Session","value":"SESSION"}]},"aws-native:bedrockagentcore:EvaluatorLlmAsAJudgeEvaluatorConfig":{"description":"The configuration for LLM-as-a-Judge evaluation.","properties":{"instructions":{"type":"string","description":"The evaluation instructions that guide the language model in assessing agent performance."},"modelConfig":{"$ref":"#/types/aws-native:bedrockagentcore:EvaluatorModelConfig"},"ratingScale":{"$ref":"#/types/aws-native:bedrockagentcore:EvaluatorRatingScale"}},"type":"object","required":["instructions","modelConfig","ratingScale"]},"aws-native:bedrockagentcore:EvaluatorModelConfig":{"description":"The model configuration that specifies which foundation model to use for evaluation.","properties":{"bedrockEvaluatorModelConfig":{"$ref":"#/types/aws-native:bedrockagentcore:EvaluatorBedrockEvaluatorModelConfig"}},"type":"object","required":["bedrockEvaluatorModelConfig"]},"aws-native:bedrockagentcore:EvaluatorNumericalScaleDefinition":{"description":"A numerical rating scale option.","properties":{"definition":{"type":"string","description":"The description that explains what this numerical rating represents."},"label":{"type":"string","description":"The label that describes this numerical rating option."},"value":{"type":"number","description":"The numerical value for this rating scale option."}},"type":"object","required":["definition","label","value"]},"aws-native:bedrockagentcore:EvaluatorRatingScale":{"description":"The rating scale that defines how evaluators should score agent performance.","properties":{"categorical":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:EvaluatorCategoricalScaleDefinition"}},"numerical":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:EvaluatorNumericalScaleDefinition"}}},"type":"object"},"aws-native:bedrockagentcore:EvaluatorStatus":{"type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Creating","value":"CREATING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"Updating","value":"UPDATING"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"Deleting","value":"DELETING"}]},"aws-native:bedrockagentcore:EvaluatorTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:bedrockagentcore:GatewayAuthorizerConfiguration0Properties":{"properties":{"customJwtAuthorizer":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayCustomJwtAuthorizerConfiguration"}},"type":"object","required":["customJwtAuthorizer"]},"aws-native:bedrockagentcore:GatewayAuthorizerConfigurationProperties":{"properties":{"customJwtAuthorizer":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayCustomJwtAuthorizerConfiguration"}},"type":"object","required":["customJwtAuthorizer"]},"aws-native:bedrockagentcore:GatewayAuthorizerType":{"type":"string","enum":[{"name":"CustomJwt","value":"CUSTOM_JWT"},{"name":"AwsIam","value":"AWS_IAM"},{"name":"None","value":"NONE"}]},"aws-native:bedrockagentcore:GatewayAuthorizingClaimMatchValueType":{"description":"The value or values in the custom claim to match and relationship of match","properties":{"claimMatchOperator":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayClaimMatchOperator"},"claimMatchValue":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayClaimMatchValueType"}},"type":"object","required":["claimMatchOperator","claimMatchValue"]},"aws-native:bedrockagentcore:GatewayClaimMatchOperator":{"description":"The relationship between the claim field value and the value or values being matched","type":"string","enum":[{"name":"Equals","value":"EQUALS"},{"name":"Contains","value":"CONTAINS"},{"name":"ContainsAny","value":"CONTAINS_ANY"}]},"aws-native:bedrockagentcore:GatewayClaimMatchValueType":{"description":"The value or values in the custom claim to match for","properties":{"matchValueString":{"type":"string"},"matchValueStringList":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:bedrockagentcore:GatewayCustomClaimValidationType":{"description":"Required custom claim","properties":{"authorizingClaimMatchValue":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayAuthorizingClaimMatchValueType"},"inboundTokenClaimName":{"type":"string"},"inboundTokenClaimValueType":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayInboundTokenClaimValueType"}},"type":"object","required":["authorizingClaimMatchValue","inboundTokenClaimName","inboundTokenClaimValueType"]},"aws-native:bedrockagentcore:GatewayCustomJwtAuthorizerConfiguration":{"properties":{"allowedAudience":{"type":"array","items":{"type":"string"}},"allowedClients":{"type":"array","items":{"type":"string"}},"allowedScopes":{"type":"array","items":{"type":"string"}},"customClaims":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayCustomClaimValidationType"}},"discoveryUrl":{"type":"string"}},"type":"object","required":["discoveryUrl"]},"aws-native:bedrockagentcore:GatewayExceptionLevel":{"type":"string","enum":[{"name":"Debug","value":"DEBUG"}]},"aws-native:bedrockagentcore:GatewayInboundTokenClaimValueType":{"description":"Token claim data type","type":"string","enum":[{"name":"String","value":"STRING"},{"name":"StringArray","value":"STRING_ARRAY"}]},"aws-native:bedrockagentcore:GatewayInterceptionPoint":{"type":"string","enum":[{"name":"Request","value":"REQUEST"},{"name":"Response","value":"RESPONSE"}]},"aws-native:bedrockagentcore:GatewayInterceptorConfiguration":{"properties":{"inputConfiguration":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayInterceptorInputConfiguration"},"interceptionPoints":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayInterceptionPoint"}},"interceptor":{"$ref":"#/types/aws-native:bedrockagentcore:InterceptorConfigurationProperties"}},"type":"object","required":["interceptionPoints","interceptor"]},"aws-native:bedrockagentcore:GatewayInterceptorInputConfiguration":{"properties":{"passRequestHeaders":{"type":"boolean"}},"type":"object","required":["passRequestHeaders"]},"aws-native:bedrockagentcore:GatewayLambdaInterceptorConfiguration":{"properties":{"arn":{"type":"string"}},"type":"object","required":["arn"]},"aws-native:bedrockagentcore:GatewayMcpGatewayConfiguration":{"properties":{"instructions":{"type":"string"},"searchType":{"$ref":"#/types/aws-native:bedrockagentcore:GatewaySearchType"},"supportedVersions":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:bedrockagentcore:GatewayProtocolConfiguration0Properties":{"properties":{"mcp":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayMcpGatewayConfiguration"}},"type":"object","required":["mcp"]},"aws-native:bedrockagentcore:GatewayProtocolConfigurationProperties":{"properties":{"mcp":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayMcpGatewayConfiguration"}},"type":"object","required":["mcp"]},"aws-native:bedrockagentcore:GatewayProtocolType":{"type":"string","enum":[{"name":"Mcp","value":"MCP"}]},"aws-native:bedrockagentcore:GatewaySearchType":{"type":"string","enum":[{"name":"Semantic","value":"SEMANTIC"}]},"aws-native:bedrockagentcore:GatewayStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Updating","value":"UPDATING"},{"name":"UpdateUnsuccessful","value":"UPDATE_UNSUCCESSFUL"},{"name":"Deleting","value":"DELETING"},{"name":"Ready","value":"READY"},{"name":"Failed","value":"FAILED"}]},"aws-native:bedrockagentcore:GatewayTargetApiGatewayTargetConfiguration":{"properties":{"apiGatewayToolConfiguration":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetApiGatewayToolConfiguration"},"restApiId":{"type":"string"},"stage":{"type":"string"}},"type":"object","required":["apiGatewayToolConfiguration","restApiId","stage"]},"aws-native:bedrockagentcore:GatewayTargetApiGatewayToolConfiguration":{"properties":{"toolFilters":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetApiGatewayToolFilter"}},"toolOverrides":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetApiGatewayToolOverride"}}},"type":"object","required":["toolFilters"]},"aws-native:bedrockagentcore:GatewayTargetApiGatewayToolFilter":{"properties":{"filterPath":{"type":"string"},"methods":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetRestApiMethod"}}},"type":"object","required":["filterPath","methods"]},"aws-native:bedrockagentcore:GatewayTargetApiGatewayToolOverride":{"properties":{"description":{"type":"string"},"method":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetRestApiMethod"},"name":{"type":"string"},"path":{"type":"string"}},"type":"object","required":["method","name","path"]},"aws-native:bedrockagentcore:GatewayTargetApiKeyCredentialLocation":{"type":"string","enum":[{"name":"Header","value":"HEADER"},{"name":"QueryParameter","value":"QUERY_PARAMETER"}]},"aws-native:bedrockagentcore:GatewayTargetApiKeyCredentialProvider":{"properties":{"credentialLocation":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetApiKeyCredentialLocation"},"credentialParameterName":{"type":"string"},"credentialPrefix":{"type":"string"},"providerArn":{"type":"string"}},"type":"object","required":["providerArn"]},"aws-native:bedrockagentcore:GatewayTargetApiSchemaConfiguration0Properties":{"properties":{"s3":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetS3Configuration"}},"type":"object","required":["s3"]},"aws-native:bedrockagentcore:GatewayTargetApiSchemaConfiguration1Properties":{"properties":{"inlinePayload":{"type":"string"}},"type":"object","required":["inlinePayload"]},"aws-native:bedrockagentcore:GatewayTargetCredentialProvider0Properties":{"properties":{"oauthCredentialProvider":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetOAuthCredentialProvider"}},"type":"object","required":["oauthCredentialProvider"]},"aws-native:bedrockagentcore:GatewayTargetCredentialProvider1Properties":{"properties":{"apiKeyCredentialProvider":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetApiKeyCredentialProvider"}},"type":"object","required":["apiKeyCredentialProvider"]},"aws-native:bedrockagentcore:GatewayTargetCredentialProviderConfiguration":{"properties":{"credentialProvider":{"oneOf":[{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetCredentialProvider0Properties"},{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetCredentialProvider1Properties"}],"description":"The credential provider for the gateway target."},"credentialProviderType":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetCredentialProviderType","description":"The credential provider type for the gateway target."}},"type":"object","required":["credentialProviderType"]},"aws-native:bedrockagentcore:GatewayTargetCredentialProviderType":{"type":"string","enum":[{"name":"GatewayIamRole","value":"GATEWAY_IAM_ROLE"},{"name":"Oauth","value":"OAUTH"},{"name":"ApiKey","value":"API_KEY"}]},"aws-native:bedrockagentcore:GatewayTargetMcpLambdaTargetConfiguration":{"properties":{"lambdaArn":{"type":"string"},"toolSchema":{"oneOf":[{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetToolSchema0Properties"},{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetToolSchema1Properties"}]}},"type":"object","required":["lambdaArn","toolSchema"]},"aws-native:bedrockagentcore:GatewayTargetMcpServerTargetConfiguration":{"properties":{"endpoint":{"type":"string"}},"type":"object","required":["endpoint"]},"aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration0Properties":{"properties":{"openApiSchema":{"oneOf":[{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetApiSchemaConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetApiSchemaConfiguration1Properties"}]}},"type":"object","required":["openApiSchema"]},"aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration1Properties":{"properties":{"smithyModel":{"oneOf":[{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetApiSchemaConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetApiSchemaConfiguration1Properties"}]}},"type":"object","required":["smithyModel"]},"aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration2Properties":{"properties":{"lambda":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetMcpLambdaTargetConfiguration"}},"type":"object","required":["lambda"]},"aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration3Properties":{"properties":{"mcpServer":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetMcpServerTargetConfiguration"}},"type":"object","required":["mcpServer"]},"aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration4Properties":{"properties":{"apiGateway":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetApiGatewayTargetConfiguration"}},"type":"object","required":["apiGateway"]},"aws-native:bedrockagentcore:GatewayTargetMetadataConfiguration":{"properties":{"allowedQueryParameters":{"type":"array","items":{"type":"string"}},"allowedRequestHeaders":{"type":"array","items":{"type":"string"}},"allowedResponseHeaders":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:bedrockagentcore:GatewayTargetOAuthCredentialProvider":{"properties":{"customParameters":{"type":"object","additionalProperties":{"type":"string"}},"defaultReturnUrl":{"type":"string","description":"Return URL for OAuth callback."},"grantType":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetOAuthGrantType"},"providerArn":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}}},"type":"object","required":["providerArn","scopes"]},"aws-native:bedrockagentcore:GatewayTargetOAuthGrantType":{"type":"string","enum":[{"name":"AuthorizationCode","value":"AUTHORIZATION_CODE"},{"name":"ClientCredentials","value":"CLIENT_CREDENTIALS"}]},"aws-native:bedrockagentcore:GatewayTargetRestApiMethod":{"type":"string","enum":[{"name":"Get","value":"GET"},{"name":"Delete","value":"DELETE"},{"name":"Head","value":"HEAD"},{"name":"Options","value":"OPTIONS"},{"name":"Patch","value":"PATCH"},{"name":"Put","value":"PUT"},{"name":"Post","value":"POST"}]},"aws-native:bedrockagentcore:GatewayTargetS3Configuration":{"properties":{"bucketOwnerAccountId":{"type":"string"},"uri":{"type":"string"}},"type":"object"},"aws-native:bedrockagentcore:GatewayTargetSchemaDefinition":{"properties":{"description":{"type":"string"},"items":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetSchemaDefinition"},"properties":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetSchemaDefinition"}},"required":{"type":"array","items":{"type":"string"}},"type":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetSchemaType"}},"type":"object","required":["type"]},"aws-native:bedrockagentcore:GatewayTargetSchemaType":{"type":"string","enum":[{"name":"String","value":"string"},{"name":"Number","value":"number"},{"name":"Object","value":"object"},{"name":"Array","value":"array"},{"name":"Boolean","value":"boolean"},{"name":"Integer","value":"integer"}]},"aws-native:bedrockagentcore:GatewayTargetTargetConfiguration0Properties":{"properties":{"mcp":{"oneOf":[{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration1Properties"},{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration2Properties"},{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration3Properties"},{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration4Properties"}]}},"type":"object","required":["mcp"]},"aws-native:bedrockagentcore:GatewayTargetTargetConfigurationProperties":{"properties":{"mcp":{"oneOf":[{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration0Properties"},{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration1Properties"},{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration2Properties"},{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration3Properties"},{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetMcpTargetConfiguration4Properties"}]}},"type":"object","required":["mcp"]},"aws-native:bedrockagentcore:GatewayTargetTargetStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Updating","value":"UPDATING"},{"name":"UpdateUnsuccessful","value":"UPDATE_UNSUCCESSFUL"},{"name":"Deleting","value":"DELETING"},{"name":"Ready","value":"READY"},{"name":"Failed","value":"FAILED"},{"name":"Synchronizing","value":"SYNCHRONIZING"},{"name":"SynchronizeUnsuccessful","value":"SYNCHRONIZE_UNSUCCESSFUL"}]},"aws-native:bedrockagentcore:GatewayTargetToolDefinition":{"properties":{"description":{"type":"string"},"inputSchema":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetSchemaDefinition"},"name":{"type":"string"},"outputSchema":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetSchemaDefinition"}},"type":"object","required":["description","inputSchema","name"]},"aws-native:bedrockagentcore:GatewayTargetToolSchema0Properties":{"properties":{"s3":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetS3Configuration"}},"type":"object","required":["s3"]},"aws-native:bedrockagentcore:GatewayTargetToolSchema1Properties":{"properties":{"inlinePayload":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayTargetToolDefinition"}}},"type":"object","required":["inlinePayload"]},"aws-native:bedrockagentcore:GatewayWorkloadIdentityDetails":{"properties":{"workloadIdentityArn":{"type":"string"}},"type":"object","required":["workloadIdentityArn"]},"aws-native:bedrockagentcore:InterceptorConfiguration0Properties":{"properties":{"lambda":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayLambdaInterceptorConfiguration"}},"type":"object","required":["lambda"]},"aws-native:bedrockagentcore:InterceptorConfigurationProperties":{"properties":{"lambda":{"$ref":"#/types/aws-native:bedrockagentcore:GatewayLambdaInterceptorConfiguration"}},"type":"object","required":["lambda"]},"aws-native:bedrockagentcore:MemoryContentConfiguration":{"properties":{"level":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryContentConfigurationLevel","description":"The level of content detail to deliver"},"type":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryContentConfigurationType","description":"The type of content to deliver"}},"type":"object","required":["type"]},"aws-native:bedrockagentcore:MemoryContentConfigurationLevel":{"description":"The level of content detail to deliver","type":"string","enum":[{"name":"MetadataOnly","value":"METADATA_ONLY"},{"name":"FullContent","value":"FULL_CONTENT"}]},"aws-native:bedrockagentcore:MemoryContentConfigurationType":{"description":"The type of content to deliver","type":"string","enum":[{"name":"MemoryRecords","value":"MEMORY_RECORDS"}]},"aws-native:bedrockagentcore:MemoryCustomConfigurationInput":{"properties":{"episodicOverride":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryEpisodicOverride"},"selfManagedConfiguration":{"$ref":"#/types/aws-native:bedrockagentcore:MemorySelfManagedConfiguration"},"semanticOverride":{"$ref":"#/types/aws-native:bedrockagentcore:MemorySemanticOverride"},"summaryOverride":{"$ref":"#/types/aws-native:bedrockagentcore:MemorySummaryOverride"},"userPreferenceOverride":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryUserPreferenceOverride"}},"type":"object"},"aws-native:bedrockagentcore:MemoryCustomMemoryStrategy":{"properties":{"configuration":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryCustomConfigurationInput"},"createdAt":{"type":"string","description":"Creation timestamp of the memory strategy"},"description":{"type":"string"},"name":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}},"status":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryCustomMemoryStrategyStatus","description":"Status of the memory strategy"},"strategyId":{"type":"string","description":"Unique identifier for the memory strategy"},"type":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryCustomMemoryStrategyType","description":"Type of memory strategy"},"updatedAt":{"type":"string","description":"Last update timestamp of the memory strategy"}},"type":"object","required":["name"]},"aws-native:bedrockagentcore:MemoryCustomMemoryStrategyStatus":{"description":"Status of the memory strategy","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Failed","value":"FAILED"}]},"aws-native:bedrockagentcore:MemoryCustomMemoryStrategyType":{"description":"Type of memory strategy","type":"string","enum":[{"name":"Semantic","value":"SEMANTIC"},{"name":"Summarization","value":"SUMMARIZATION"},{"name":"UserPreference","value":"USER_PREFERENCE"},{"name":"Custom","value":"CUSTOM"},{"name":"Episodic","value":"EPISODIC"}]},"aws-native:bedrockagentcore:MemoryEpisodicMemoryStrategy":{"properties":{"createdAt":{"type":"string","description":"Creation timestamp of the memory strategy"},"description":{"type":"string"},"name":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}},"reflectionConfiguration":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryEpisodicReflectionConfigurationInput"},"status":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryEpisodicMemoryStrategyStatus","description":"Status of the memory strategy"},"strategyId":{"type":"string","description":"Unique identifier for the memory strategy"},"type":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryEpisodicMemoryStrategyType","description":"Type of memory strategy"},"updatedAt":{"type":"string","description":"Last update timestamp of the memory strategy"}},"type":"object","required":["name"]},"aws-native:bedrockagentcore:MemoryEpisodicMemoryStrategyStatus":{"description":"Status of the memory strategy","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Failed","value":"FAILED"}]},"aws-native:bedrockagentcore:MemoryEpisodicMemoryStrategyType":{"description":"Type of memory strategy","type":"string","enum":[{"name":"Semantic","value":"SEMANTIC"},{"name":"Summarization","value":"SUMMARIZATION"},{"name":"UserPreference","value":"USER_PREFERENCE"},{"name":"Custom","value":"CUSTOM"},{"name":"Episodic","value":"EPISODIC"}]},"aws-native:bedrockagentcore:MemoryEpisodicOverride":{"properties":{"consolidation":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryEpisodicOverrideConsolidationConfigurationInput"},"extraction":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryEpisodicOverrideExtractionConfigurationInput"},"reflection":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryEpisodicOverrideReflectionConfigurationInput"}},"type":"object"},"aws-native:bedrockagentcore:MemoryEpisodicOverrideConsolidationConfigurationInput":{"properties":{"appendToPrompt":{"type":"string"},"modelId":{"type":"string"}},"type":"object","required":["appendToPrompt","modelId"]},"aws-native:bedrockagentcore:MemoryEpisodicOverrideExtractionConfigurationInput":{"properties":{"appendToPrompt":{"type":"string"},"modelId":{"type":"string"}},"type":"object","required":["appendToPrompt","modelId"]},"aws-native:bedrockagentcore:MemoryEpisodicOverrideReflectionConfigurationInput":{"properties":{"appendToPrompt":{"type":"string"},"modelId":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}}},"type":"object","required":["appendToPrompt","modelId"]},"aws-native:bedrockagentcore:MemoryEpisodicReflectionConfigurationInput":{"properties":{"namespaces":{"type":"array","items":{"type":"string"}}},"type":"object","required":["namespaces"]},"aws-native:bedrockagentcore:MemoryInvocationConfigurationInput":{"properties":{"payloadDeliveryBucketName":{"type":"string"},"topicArn":{"type":"string"}},"type":"object"},"aws-native:bedrockagentcore:MemoryKinesisResource":{"properties":{"contentConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryContentConfiguration"}},"dataStreamArn":{"type":"string"}},"type":"object","required":["contentConfigurations","dataStreamArn"]},"aws-native:bedrockagentcore:MemoryMessageBasedTriggerInput":{"properties":{"messageCount":{"type":"integer"}},"type":"object"},"aws-native:bedrockagentcore:MemorySelfManagedConfiguration":{"properties":{"historicalContextWindowSize":{"type":"integer"},"invocationConfiguration":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryInvocationConfigurationInput"},"triggerConditions":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryTriggerConditionInput"}}},"type":"object"},"aws-native:bedrockagentcore:MemorySemanticMemoryStrategy":{"properties":{"createdAt":{"type":"string","description":"Creation timestamp of the memory strategy"},"description":{"type":"string"},"name":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}},"status":{"$ref":"#/types/aws-native:bedrockagentcore:MemorySemanticMemoryStrategyStatus","description":"Status of the memory strategy"},"strategyId":{"type":"string","description":"Unique identifier for the memory strategy"},"type":{"$ref":"#/types/aws-native:bedrockagentcore:MemorySemanticMemoryStrategyType","description":"Type of memory strategy"},"updatedAt":{"type":"string","description":"Last update timestamp of the memory strategy"}},"type":"object","required":["name"]},"aws-native:bedrockagentcore:MemorySemanticMemoryStrategyStatus":{"description":"Status of the memory strategy","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Failed","value":"FAILED"}]},"aws-native:bedrockagentcore:MemorySemanticMemoryStrategyType":{"description":"Type of memory strategy","type":"string","enum":[{"name":"Semantic","value":"SEMANTIC"},{"name":"Summarization","value":"SUMMARIZATION"},{"name":"UserPreference","value":"USER_PREFERENCE"},{"name":"Custom","value":"CUSTOM"},{"name":"Episodic","value":"EPISODIC"}]},"aws-native:bedrockagentcore:MemorySemanticOverride":{"properties":{"consolidation":{"$ref":"#/types/aws-native:bedrockagentcore:MemorySemanticOverrideConsolidationConfigurationInput"},"extraction":{"$ref":"#/types/aws-native:bedrockagentcore:MemorySemanticOverrideExtractionConfigurationInput"}},"type":"object"},"aws-native:bedrockagentcore:MemorySemanticOverrideConsolidationConfigurationInput":{"properties":{"appendToPrompt":{"type":"string"},"modelId":{"type":"string"}},"type":"object","required":["appendToPrompt","modelId"]},"aws-native:bedrockagentcore:MemorySemanticOverrideExtractionConfigurationInput":{"properties":{"appendToPrompt":{"type":"string"},"modelId":{"type":"string"}},"type":"object","required":["appendToPrompt","modelId"]},"aws-native:bedrockagentcore:MemoryStatus":{"description":"Status of the Memory resource","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Failed","value":"FAILED"},{"name":"Deleting","value":"DELETING"}]},"aws-native:bedrockagentcore:MemoryStrategy":{"properties":{"customMemoryStrategy":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryCustomMemoryStrategy"},"episodicMemoryStrategy":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryEpisodicMemoryStrategy"},"semanticMemoryStrategy":{"$ref":"#/types/aws-native:bedrockagentcore:MemorySemanticMemoryStrategy"},"summaryMemoryStrategy":{"$ref":"#/types/aws-native:bedrockagentcore:MemorySummaryMemoryStrategy"},"userPreferenceMemoryStrategy":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryUserPreferenceMemoryStrategy"}},"type":"object"},"aws-native:bedrockagentcore:MemoryStreamDeliveryResource":{"properties":{"kinesis":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryKinesisResource"}},"type":"object"},"aws-native:bedrockagentcore:MemoryStreamDeliveryResources":{"properties":{"resources":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryStreamDeliveryResource"}}},"type":"object","required":["resources"]},"aws-native:bedrockagentcore:MemorySummaryMemoryStrategy":{"properties":{"createdAt":{"type":"string","description":"Creation timestamp of the memory strategy"},"description":{"type":"string"},"name":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}},"status":{"$ref":"#/types/aws-native:bedrockagentcore:MemorySummaryMemoryStrategyStatus","description":"Status of the memory strategy"},"strategyId":{"type":"string","description":"Unique identifier for the memory strategy"},"type":{"$ref":"#/types/aws-native:bedrockagentcore:MemorySummaryMemoryStrategyType","description":"Type of memory strategy"},"updatedAt":{"type":"string","description":"Last update timestamp of the memory strategy"}},"type":"object","required":["name"]},"aws-native:bedrockagentcore:MemorySummaryMemoryStrategyStatus":{"description":"Status of the memory strategy","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Failed","value":"FAILED"}]},"aws-native:bedrockagentcore:MemorySummaryMemoryStrategyType":{"description":"Type of memory strategy","type":"string","enum":[{"name":"Semantic","value":"SEMANTIC"},{"name":"Summarization","value":"SUMMARIZATION"},{"name":"UserPreference","value":"USER_PREFERENCE"},{"name":"Custom","value":"CUSTOM"},{"name":"Episodic","value":"EPISODIC"}]},"aws-native:bedrockagentcore:MemorySummaryOverride":{"properties":{"consolidation":{"$ref":"#/types/aws-native:bedrockagentcore:MemorySummaryOverrideConsolidationConfigurationInput"}},"type":"object"},"aws-native:bedrockagentcore:MemorySummaryOverrideConsolidationConfigurationInput":{"properties":{"appendToPrompt":{"type":"string"},"modelId":{"type":"string"}},"type":"object","required":["appendToPrompt","modelId"]},"aws-native:bedrockagentcore:MemoryTimeBasedTriggerInput":{"properties":{"idleSessionTimeout":{"type":"integer"}},"type":"object"},"aws-native:bedrockagentcore:MemoryTokenBasedTriggerInput":{"properties":{"tokenCount":{"type":"integer"}},"type":"object"},"aws-native:bedrockagentcore:MemoryTriggerConditionInput":{"properties":{"messageBasedTrigger":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryMessageBasedTriggerInput"},"timeBasedTrigger":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryTimeBasedTriggerInput"},"tokenBasedTrigger":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryTokenBasedTriggerInput"}},"type":"object"},"aws-native:bedrockagentcore:MemoryUserPreferenceMemoryStrategy":{"properties":{"createdAt":{"type":"string","description":"Creation timestamp of the memory strategy"},"description":{"type":"string"},"name":{"type":"string"},"namespaces":{"type":"array","items":{"type":"string"}},"status":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryUserPreferenceMemoryStrategyStatus","description":"Status of the memory strategy"},"strategyId":{"type":"string","description":"Unique identifier for the memory strategy"},"type":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryUserPreferenceMemoryStrategyType","description":"Type of memory strategy"},"updatedAt":{"type":"string","description":"Last update timestamp of the memory strategy"}},"type":"object","required":["name"]},"aws-native:bedrockagentcore:MemoryUserPreferenceMemoryStrategyStatus":{"description":"Status of the memory strategy","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Failed","value":"FAILED"}]},"aws-native:bedrockagentcore:MemoryUserPreferenceMemoryStrategyType":{"description":"Type of memory strategy","type":"string","enum":[{"name":"Semantic","value":"SEMANTIC"},{"name":"Summarization","value":"SUMMARIZATION"},{"name":"UserPreference","value":"USER_PREFERENCE"},{"name":"Custom","value":"CUSTOM"},{"name":"Episodic","value":"EPISODIC"}]},"aws-native:bedrockagentcore:MemoryUserPreferenceOverride":{"properties":{"consolidation":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryUserPreferenceOverrideConsolidationConfigurationInput"},"extraction":{"$ref":"#/types/aws-native:bedrockagentcore:MemoryUserPreferenceOverrideExtractionConfigurationInput"}},"type":"object"},"aws-native:bedrockagentcore:MemoryUserPreferenceOverrideConsolidationConfigurationInput":{"properties":{"appendToPrompt":{"type":"string"},"modelId":{"type":"string"}},"type":"object","required":["appendToPrompt","modelId"]},"aws-native:bedrockagentcore:MemoryUserPreferenceOverrideExtractionConfigurationInput":{"properties":{"appendToPrompt":{"type":"string"},"modelId":{"type":"string"}},"type":"object","required":["appendToPrompt","modelId"]},"aws-native:bedrockagentcore:OnlineEvaluationConfigCloudWatchLogsInputConfig":{"description":"The configuration for reading agent traces from CloudWatch logs.","properties":{"logGroupNames":{"type":"array","items":{"type":"string"},"description":"The list of CloudWatch log group names to monitor for agent traces."},"serviceNames":{"type":"array","items":{"type":"string"},"description":"The list of service names to filter traces within the specified log groups."}},"type":"object","required":["logGroupNames","serviceNames"]},"aws-native:bedrockagentcore:OnlineEvaluationConfigCloudWatchOutputConfig":{"description":"The CloudWatch configuration for writing evaluation results.","properties":{"logGroupName":{"type":"string","description":"The CloudWatch log group name for evaluation results."}},"type":"object"},"aws-native:bedrockagentcore:OnlineEvaluationConfigDataSourceConfig":{"description":"The configuration that specifies where to read agent traces for online evaluation.","properties":{"cloudWatchLogs":{"$ref":"#/types/aws-native:bedrockagentcore:OnlineEvaluationConfigCloudWatchLogsInputConfig"}},"type":"object","required":["cloudWatchLogs"]},"aws-native:bedrockagentcore:OnlineEvaluationConfigEvaluatorReference":{"description":"The reference to an evaluator used in online evaluation configurations.","properties":{"evaluatorId":{"type":"string","description":"The unique identifier of the evaluator."}},"type":"object","required":["evaluatorId"]},"aws-native:bedrockagentcore:OnlineEvaluationConfigExecutionStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:bedrockagentcore:OnlineEvaluationConfigFilter":{"description":"The filter that applies conditions to agent traces during online evaluation.","properties":{"key":{"type":"string","description":"The key or field name to filter on within the agent trace data."},"operator":{"$ref":"#/types/aws-native:bedrockagentcore:OnlineEvaluationConfigFilterOperator","description":"The comparison operator to use for filtering."},"value":{"$ref":"#/types/aws-native:bedrockagentcore:OnlineEvaluationConfigFilterValue"}},"type":"object","required":["key","operator","value"]},"aws-native:bedrockagentcore:OnlineEvaluationConfigFilterOperator":{"description":"The comparison operator to use for filtering.","type":"string","enum":[{"name":"Equals","value":"Equals"},{"name":"NotEquals","value":"NotEquals"},{"name":"GreaterThan","value":"GreaterThan"},{"name":"LessThan","value":"LessThan"},{"name":"GreaterThanOrEqual","value":"GreaterThanOrEqual"},{"name":"LessThanOrEqual","value":"LessThanOrEqual"},{"name":"Contains","value":"Contains"},{"name":"NotContains","value":"NotContains"}]},"aws-native:bedrockagentcore:OnlineEvaluationConfigFilterValue":{"description":"The value used in filter comparisons.","properties":{"booleanValue":{"type":"boolean","description":"The boolean value for true/false filtering conditions."},"doubleValue":{"type":"number","description":"The numeric value for numerical filtering."},"stringValue":{"type":"string","description":"The string value for text-based filtering."}},"type":"object"},"aws-native:bedrockagentcore:OnlineEvaluationConfigOutputConfig":{"description":"The configuration that specifies where evaluation results should be written.","properties":{"cloudWatchConfig":{"$ref":"#/types/aws-native:bedrockagentcore:OnlineEvaluationConfigCloudWatchOutputConfig"}},"type":"object"},"aws-native:bedrockagentcore:OnlineEvaluationConfigRule":{"description":"The evaluation rule that defines sampling configuration, filtering criteria, and session detection settings.","properties":{"filters":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:OnlineEvaluationConfigFilter"},"description":"The list of filters that determine which agent traces should be included in the evaluation."},"samplingConfig":{"$ref":"#/types/aws-native:bedrockagentcore:OnlineEvaluationConfigSamplingConfig"},"sessionConfig":{"$ref":"#/types/aws-native:bedrockagentcore:OnlineEvaluationConfigSessionConfig"}},"type":"object","required":["samplingConfig"]},"aws-native:bedrockagentcore:OnlineEvaluationConfigSamplingConfig":{"description":"The configuration that controls what percentage of agent traces are sampled for evaluation.","properties":{"samplingPercentage":{"type":"number","description":"The percentage of agent traces to sample for evaluation."}},"type":"object","required":["samplingPercentage"]},"aws-native:bedrockagentcore:OnlineEvaluationConfigSessionConfig":{"description":"The configuration that defines how agent sessions are detected.","properties":{"sessionTimeoutMinutes":{"type":"integer","description":"The number of minutes of inactivity after which an agent session is considered complete."}},"type":"object","required":["sessionTimeoutMinutes"]},"aws-native:bedrockagentcore:OnlineEvaluationConfigStatus":{"type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Creating","value":"CREATING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"Updating","value":"UPDATING"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"Deleting","value":"DELETING"}]},"aws-native:bedrockagentcore:OnlineEvaluationConfigTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:bedrockagentcore:PolicyCedarPolicy":{"description":"A Cedar policy statement within the AgentCore Policy system.","properties":{"statement":{"type":"string","description":"The Cedar policy statement that defines the authorization logic."}},"type":"object","required":["statement"]},"aws-native:bedrockagentcore:PolicyDefinition":{"description":"The definition structure for policies. Encapsulates different policy formats.","properties":{"cedar":{"$ref":"#/types/aws-native:bedrockagentcore:PolicyCedarPolicy"}},"type":"object","required":["cedar"]},"aws-native:bedrockagentcore:PolicyEngineStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"DeleteFailed","value":"DELETE_FAILED"}]},"aws-native:bedrockagentcore:PolicyEngineTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:bedrockagentcore:PolicyStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"DeleteFailed","value":"DELETE_FAILED"}]},"aws-native:bedrockagentcore:PolicyValidationMode":{"description":"The validation mode for the policy. Determines how Cedar analyzer validation results are handled.","type":"string","enum":[{"name":"FailOnAnyFindings","value":"FAIL_ON_ANY_FINDINGS"},{"name":"IgnoreAllFindings","value":"IGNORE_ALL_FINDINGS"}]},"aws-native:bedrockagentcore:RuntimeAgentManagedRuntimeType":{"description":"Managed runtime types","type":"string","enum":[{"name":"Python310","value":"PYTHON_3_10"},{"name":"Python311","value":"PYTHON_3_11"},{"name":"Python312","value":"PYTHON_3_12"},{"name":"Python313","value":"PYTHON_3_13"}]},"aws-native:bedrockagentcore:RuntimeAgentRuntimeArtifact":{"properties":{"codeConfiguration":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeCodeConfiguration"},"containerConfiguration":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeContainerConfiguration","description":"Representation of a container configuration."}},"type":"object"},"aws-native:bedrockagentcore:RuntimeAgentStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"Updating","value":"UPDATING"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"Ready","value":"READY"},{"name":"Deleting","value":"DELETING"}]},"aws-native:bedrockagentcore:RuntimeAuthorizerConfiguration":{"description":"Configuration for the authorizer","properties":{"customJwtAuthorizer":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeCustomJwtAuthorizerConfiguration","description":"Represents inbound authorization configuration options used to authenticate incoming requests."}},"type":"object"},"aws-native:bedrockagentcore:RuntimeAuthorizingClaimMatchValueType":{"description":"The value or values in the custom claim to match and relationship of match","properties":{"claimMatchOperator":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeClaimMatchOperator"},"claimMatchValue":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeClaimMatchValueType"}},"type":"object","required":["claimMatchOperator","claimMatchValue"]},"aws-native:bedrockagentcore:RuntimeClaimMatchOperator":{"description":"The relationship between the claim field value and the value or values being matched","type":"string","enum":[{"name":"Equals","value":"EQUALS"},{"name":"Contains","value":"CONTAINS"},{"name":"ContainsAny","value":"CONTAINS_ANY"}]},"aws-native:bedrockagentcore:RuntimeClaimMatchValueType":{"description":"The value or values in the custom claim to match for","properties":{"matchValueString":{"type":"string"},"matchValueStringList":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:bedrockagentcore:RuntimeCode":{"description":"Object represents source code from zip file","properties":{"s3":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeS3Location"}},"type":"object"},"aws-native:bedrockagentcore:RuntimeCodeConfiguration":{"description":"Representation of a code configuration","properties":{"code":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeCode"},"entryPoint":{"type":"array","items":{"type":"string"}},"runtime":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeAgentManagedRuntimeType"}},"type":"object","required":["code","entryPoint","runtime"]},"aws-native:bedrockagentcore:RuntimeContainerConfiguration":{"properties":{"containerUri":{"type":"string","description":"The container Uri."}},"type":"object","required":["containerUri"]},"aws-native:bedrockagentcore:RuntimeCustomClaimValidationType":{"description":"Required custom claim","properties":{"authorizingClaimMatchValue":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeAuthorizingClaimMatchValueType"},"inboundTokenClaimName":{"type":"string"},"inboundTokenClaimValueType":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeInboundTokenClaimValueType"}},"type":"object","required":["authorizingClaimMatchValue","inboundTokenClaimName","inboundTokenClaimValueType"]},"aws-native:bedrockagentcore:RuntimeCustomJwtAuthorizerConfiguration":{"description":"Configuration for custom JWT authorizer","properties":{"allowedAudience":{"type":"array","items":{"type":"string"},"description":"Represents inbound authorization configuration options used to authenticate incoming requests."},"allowedClients":{"type":"array","items":{"type":"string"},"description":"Represents individual client IDs that are validated in the incoming JWT token validation process."},"allowedScopes":{"type":"array","items":{"type":"string"}},"customClaims":{"type":"array","items":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeCustomClaimValidationType"}},"discoveryUrl":{"type":"string","description":"The configuration authorization."}},"type":"object","required":["discoveryUrl"]},"aws-native:bedrockagentcore:RuntimeEndpointAgentRuntimeEndpointStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"Updating","value":"UPDATING"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"Ready","value":"READY"},{"name":"Deleting","value":"DELETING"}]},"aws-native:bedrockagentcore:RuntimeInboundTokenClaimValueType":{"description":"Token claim data type","type":"string","enum":[{"name":"String","value":"STRING"},{"name":"StringArray","value":"STRING_ARRAY"}]},"aws-native:bedrockagentcore:RuntimeLifecycleConfiguration":{"description":"Configuration for managing the lifecycle of runtime sessions and resources","properties":{"idleRuntimeSessionTimeout":{"type":"integer","description":"Timeout in seconds for idle runtime sessions"},"maxLifetime":{"type":"integer","description":"Maximum lifetime in seconds for runtime sessions"}},"type":"object"},"aws-native:bedrockagentcore:RuntimeNetworkConfiguration":{"properties":{"networkMode":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeNetworkMode","description":"The network mode."},"networkModeConfig":{"$ref":"#/types/aws-native:bedrockagentcore:RuntimeVpcConfig"}},"type":"object","required":["networkMode"]},"aws-native:bedrockagentcore:RuntimeNetworkMode":{"description":"Network mode configuration type","type":"string","enum":[{"name":"Public","value":"PUBLIC"},{"name":"Vpc","value":"VPC"}]},"aws-native:bedrockagentcore:RuntimeProtocolConfiguration":{"type":"string","enum":[{"name":"Mcp","value":"MCP"},{"name":"Http","value":"HTTP"},{"name":"A2a","value":"A2A"}]},"aws-native:bedrockagentcore:RuntimeRequestHeaderConfiguration":{"description":"Configuration for HTTP request headers","properties":{"requestHeaderAllowlist":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:bedrockagentcore:RuntimeS3Location":{"description":"S3 Location Configuration","properties":{"bucket":{"type":"string","description":"S3 bucket name"},"prefix":{"type":"string","description":"S3 object key prefix"},"versionId":{"type":"string","description":"S3 object version ID"}},"type":"object","required":["bucket","prefix"]},"aws-native:bedrockagentcore:RuntimeVpcConfig":{"description":"Network mode configuration for VPC","properties":{"securityGroups":{"type":"array","items":{"type":"string"}},"subnets":{"type":"array","items":{"type":"string"}}},"type":"object","required":["securityGroups","subnets"]},"aws-native:bedrockagentcore:RuntimeWorkloadIdentityDetails":{"description":"Configuration for workload identity","properties":{"workloadIdentityArn":{"type":"string","description":"The Amazon Resource Name (ARN) for the workload identity."}},"type":"object","required":["workloadIdentityArn"]},"aws-native:bedrockagentcore:WorkloadIdentityTag":{"properties":{"key":{"type":"string","description":"The key name of the tag."},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key","value"]},"aws-native:bedrockmantle:ProjectTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag."},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key","value"]},"aws-native:billing:BillingViewDimensionKey":{"type":"string","enum":[{"name":"LinkedAccount","value":"LINKED_ACCOUNT"}]},"aws-native:billing:BillingViewTag":{"description":"A key-value pair to associate with a Billing View.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:billing:BillingViewType":{"type":"string","enum":[{"name":"Primary","value":"PRIMARY"},{"name":"BillingGroup","value":"BILLING_GROUP"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:billing:DataFilterExpressionProperties":{"description":"See [Expression](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_billing_Expression.html) . Billing view only supports `LINKED_ACCOUNT` and `Tags` .","properties":{"dimensions":{"$ref":"#/types/aws-native:billing:DataFilterExpressionPropertiesDimensionsProperties","description":"The specific `Dimension` to use for `Expression` ."},"tags":{"$ref":"#/types/aws-native:billing:DataFilterExpressionPropertiesTagsProperties","description":"The specific `Tag` to use for `Expression` ."},"timeRange":{"$ref":"#/types/aws-native:billing:DataFilterExpressionPropertiesTimeRangeProperties"}},"type":"object"},"aws-native:billing:DataFilterExpressionPropertiesDimensionsProperties":{"description":"The specific `Dimension` to use for `Expression` .","properties":{"key":{"$ref":"#/types/aws-native:billing:BillingViewDimensionKey"},"values":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:billing:DataFilterExpressionPropertiesTagsProperties":{"description":"The specific `Tag` to use for `Expression` .","properties":{"key":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:billing:DataFilterExpressionPropertiesTimeRangeProperties":{"properties":{"beginDateInclusive":{"type":"string"},"endDateInclusive":{"type":"string"}},"type":"object"},"aws-native:budgets:BudgetsActionActionThreshold":{"properties":{"type":{"$ref":"#/types/aws-native:budgets:BudgetsActionActionThresholdType","description":"The type of threshold for a notification."},"value":{"type":"number","description":"The threshold of a notification."}},"type":"object","required":["type","value"]},"aws-native:budgets:BudgetsActionActionThresholdType":{"description":"The type of threshold for a notification.","type":"string","enum":[{"name":"Percentage","value":"PERCENTAGE"},{"name":"AbsoluteValue","value":"ABSOLUTE_VALUE"}]},"aws-native:budgets:BudgetsActionActionType":{"description":"The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.","type":"string","enum":[{"name":"ApplyIamPolicy","value":"APPLY_IAM_POLICY"},{"name":"ApplyScpPolicy","value":"APPLY_SCP_POLICY"},{"name":"RunSsmDocuments","value":"RUN_SSM_DOCUMENTS"}]},"aws-native:budgets:BudgetsActionApprovalModel":{"description":"This specifies if the action needs manual or automatic approval.","type":"string","enum":[{"name":"Automatic","value":"AUTOMATIC"},{"name":"Manual","value":"MANUAL"}]},"aws-native:budgets:BudgetsActionDefinition":{"properties":{"iamActionDefinition":{"$ref":"#/types/aws-native:budgets:BudgetsActionIamActionDefinition","description":"The AWS Identity and Access Management ( IAM ) action definition details."},"scpActionDefinition":{"$ref":"#/types/aws-native:budgets:BudgetsActionScpActionDefinition","description":"The service control policies (SCP) action definition details."},"ssmActionDefinition":{"$ref":"#/types/aws-native:budgets:BudgetsActionSsmActionDefinition","description":"The Amazon EC2 Systems Manager ( SSM ) action definition details."}},"type":"object"},"aws-native:budgets:BudgetsActionIamActionDefinition":{"properties":{"groups":{"type":"array","items":{"type":"string"},"description":"A list of groups to be attached. There must be at least one group."},"policyArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the policy to be attached."},"roles":{"type":"array","items":{"type":"string"},"description":"A list of roles to be attached. There must be at least one role."},"users":{"type":"array","items":{"type":"string"},"description":"A list of users to be attached. There must be at least one user."}},"type":"object","required":["policyArn"]},"aws-native:budgets:BudgetsActionNotificationType":{"description":"The type of a notification.","type":"string","enum":[{"name":"Actual","value":"ACTUAL"},{"name":"Forecasted","value":"FORECASTED"}]},"aws-native:budgets:BudgetsActionResourceTag":{"properties":{"key":{"type":"string","description":"The key that's associated with the tag."},"value":{"type":"string","description":"The value that's associated with the tag."}},"type":"object","required":["key","value"]},"aws-native:budgets:BudgetsActionScpActionDefinition":{"properties":{"policyId":{"type":"string","description":"The policy ID attached."},"targetIds":{"type":"array","items":{"type":"string"},"description":"A list of target IDs."}},"type":"object","required":["policyId","targetIds"]},"aws-native:budgets:BudgetsActionSsmActionDefinition":{"properties":{"instanceIds":{"type":"array","items":{"type":"string"},"description":"The EC2 and RDS instance IDs."},"region":{"type":"string","description":"The Region to run the ( SSM ) document."},"subtype":{"$ref":"#/types/aws-native:budgets:BudgetsActionSsmActionDefinitionSubtype","description":"The action subType."}},"type":"object","required":["instanceIds","region","subtype"]},"aws-native:budgets:BudgetsActionSsmActionDefinitionSubtype":{"description":"The action subType.","type":"string","enum":[{"name":"StopEc2Instances","value":"STOP_EC2_INSTANCES"},{"name":"StopRdsInstances","value":"STOP_RDS_INSTANCES"}]},"aws-native:budgets:BudgetsActionSubscriber":{"properties":{"address":{"type":"string","description":"The address that AWS sends budget notifications to, either an SNS topic or an email.\n\nWhen you create a subscriber, the value of `Address` can't contain line breaks."},"type":{"$ref":"#/types/aws-native:budgets:BudgetsActionSubscriberType","description":"The type of notification that AWS sends to a subscriber."}},"type":"object","required":["address","type"]},"aws-native:budgets:BudgetsActionSubscriberType":{"description":"The type of notification that AWS sends to a subscriber.","type":"string","enum":[{"name":"Sns","value":"SNS"},{"name":"Email","value":"EMAIL"}]},"aws-native:cases:CaseRuleBooleanCondition0Properties":{"description":"A boolean condition for a rule.","properties":{"equalTo":{"$ref":"#/types/aws-native:cases:CaseRuleBooleanOperands"}},"type":"object","required":["equalTo"]},"aws-native:cases:CaseRuleBooleanCondition1Properties":{"description":"A boolean condition for a rule.","properties":{"notEqualTo":{"$ref":"#/types/aws-native:cases:CaseRuleBooleanOperands"}},"type":"object","required":["notEqualTo"]},"aws-native:cases:CaseRuleBooleanOperands":{"description":"Boolean operands for a condition.","properties":{"operandOne":{"$ref":"#/types/aws-native:cases:CaseRuleOperandOneProperties"},"operandTwo":{"oneOf":[{"$ref":"#/types/aws-native:cases:CaseRuleOperandTwo0Properties"},{"$ref":"#/types/aws-native:cases:CaseRuleOperandTwo1Properties"},{"$ref":"#/types/aws-native:cases:CaseRuleOperandTwo2Properties"},{"$ref":"#/types/aws-native:cases:CaseRuleOperandTwo3Properties"}]},"result":{"type":"boolean","description":"The value of the outer rule if the condition evaluates to true."}},"type":"object","required":["operandOne","operandTwo","result"]},"aws-native:cases:CaseRuleDetails0Properties":{"description":"Defines the rule behavior and conditions. Specifies the rule type and the conditions under which it applies. In the Amazon Connect admin website, this corresponds to case field conditions.","properties":{"required":{"$ref":"#/types/aws-native:cases:CaseRuleRequiredCaseRule"}},"type":"object","required":["required"]},"aws-native:cases:CaseRuleDetails1Properties":{"description":"Defines the rule behavior and conditions. Specifies the rule type and the conditions under which it applies. In the Amazon Connect admin website, this corresponds to case field conditions.","properties":{"hidden":{"$ref":"#/types/aws-native:cases:CaseRuleHiddenCaseRule"}},"type":"object","required":["hidden"]},"aws-native:cases:CaseRuleEmptyOperandValue":{"description":"An empty operand value.","type":"object"},"aws-native:cases:CaseRuleHiddenCaseRule":{"description":"Hidden rule type, used to indicate whether a field is hidden","properties":{"conditions":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:cases:CaseRuleBooleanCondition0Properties"},{"$ref":"#/types/aws-native:cases:CaseRuleBooleanCondition1Properties"}]},"description":"List of conditions for the hidden rule; the first condition to evaluate to true dictates the value of the rule"},"defaultValue":{"type":"boolean","description":"The value of the rule (i.e. whether the field is hidden) should none of the conditions evaluate to true"}},"type":"object","required":["conditions","defaultValue"]},"aws-native:cases:CaseRuleOperandOne0Properties":{"description":"The left hand operand in the condition.","properties":{"fieldId":{"type":"string","description":"The field ID this operand should take the value of."}},"type":"object","required":["fieldId"]},"aws-native:cases:CaseRuleOperandOneProperties":{"description":"The left hand operand in the condition.","properties":{"fieldId":{"type":"string","description":"The field ID this operand should take the value of."}},"type":"object","required":["fieldId"]},"aws-native:cases:CaseRuleOperandTwo0Properties":{"description":"The right hand operand in the condition.","properties":{"stringValue":{"type":"string","description":"A string value to compare against the field value in the condition evaluation."}},"type":"object","required":["stringValue"]},"aws-native:cases:CaseRuleOperandTwo1Properties":{"description":"The right hand operand in the condition.","properties":{"booleanValue":{"type":"boolean","description":"A boolean value to compare against the field value in the condition evaluation."}},"type":"object","required":["booleanValue"]},"aws-native:cases:CaseRuleOperandTwo2Properties":{"description":"The right hand operand in the condition.","properties":{"doubleValue":{"type":"number","description":"A numeric value to compare against the field value in the condition evaluation."}},"type":"object","required":["doubleValue"]},"aws-native:cases:CaseRuleOperandTwo3Properties":{"description":"The right hand operand in the condition.","properties":{"emptyValue":{"$ref":"#/types/aws-native:cases:CaseRuleEmptyOperandValue"}},"type":"object","required":["emptyValue"]},"aws-native:cases:CaseRuleRequiredCaseRule":{"description":"A required rule type, used to indicate whether a field is required.","properties":{"conditions":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:cases:CaseRuleBooleanCondition0Properties"},{"$ref":"#/types/aws-native:cases:CaseRuleBooleanCondition1Properties"}]},"description":"An ordered list of boolean conditions that determine when the field should be required. Conditions are evaluated in order, and the first condition that evaluates to true determines whether the field is required, overriding the default value."},"defaultValue":{"type":"boolean","description":"The default required state for the field when none of the specified conditions are met. If true, the field is required by default; if false, the field is optional by default."}},"type":"object","required":["conditions","defaultValue"]},"aws-native:cases:CaseRuleTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:cases:DomainStatus":{"description":"The current status of the Cases domain. Indicates whether the domain is Active, CreationInProgress, or CreationFailed.","type":"string","enum":[{"name":"Active","value":"Active"},{"name":"CreationInProgress","value":"CreationInProgress"},{"name":"CreationFailed","value":"CreationFailed"}]},"aws-native:cases:DomainTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:cases:FieldAttributes":{"description":"Union of field attributes","properties":{"text":{"$ref":"#/types/aws-native:cases:FieldTextAttributes"}},"type":"object"},"aws-native:cases:FieldNamespace":{"description":"Indicates whether this is a System field (predefined by AWS) or a Custom field (created by your organization). System fields cannot be modified or deleted.","type":"string","enum":[{"name":"System","value":"System"},{"name":"Custom","value":"Custom"}]},"aws-native:cases:FieldTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:cases:FieldTextAttributes":{"description":"Field attributes for Text field type","properties":{"isMultiline":{"type":"boolean","description":"Attribute that defines rendering component and validation"}},"type":"object","required":["isMultiline"]},"aws-native:cases:FieldType":{"description":"The data type of the field, which determines validation rules, input constraints, and display format. Each type has specific constraints: Text (string input), Number (numeric values), Boolean (true/false), DateTime (date/time picker), SingleSelect (dropdown options), Url (URL validation), User (Amazon Connect user selection).","type":"string","enum":[{"name":"Text","value":"Text"},{"name":"Number","value":"Number"},{"name":"Boolean","value":"Boolean"},{"name":"DateTime","value":"DateTime"},{"name":"SingleSelect","value":"SingleSelect"},{"name":"Url","value":"Url"},{"name":"User","value":"User"}]},"aws-native:cases:LayoutBasicLayout":{"description":"Defines the field layout for the agent's case interface. Configures which fields appear in the top panel (immediately visible) and More Info tab (expandable section) of the case view, allowing customization of the agent experience.","properties":{"moreInfo":{"$ref":"#/types/aws-native:cases:LayoutSections"},"topPanel":{"$ref":"#/types/aws-native:cases:LayoutSections"}},"type":"object"},"aws-native:cases:LayoutContent0Properties":{"description":"Defines the layout structure and field organization for the case interface. Specifies which fields appear in the top panel and More Info tab, and their display order.","properties":{"basic":{"$ref":"#/types/aws-native:cases:LayoutBasicLayout"}},"type":"object","required":["basic"]},"aws-native:cases:LayoutContentProperties":{"description":"Defines the layout structure and field organization for the case interface. Specifies which fields appear in the top panel and More Info tab, and their display order.","properties":{"basic":{"$ref":"#/types/aws-native:cases:LayoutBasicLayout"}},"type":"object","required":["basic"]},"aws-native:cases:LayoutFieldGroup":{"description":"Consists of a group of fields and associated properties.","properties":{"fields":{"type":"array","items":{"$ref":"#/types/aws-native:cases:LayoutFieldItem"},"description":"An ordered list of fields to display in this group. The order determines the sequence in which fields appear in the agent interface. Each field is referenced by its unique field ID."},"name":{"type":"string","description":"A descriptive name for the field group. Helps organize related fields together in the layout interface."}},"type":"object","required":["fields"]},"aws-native:cases:LayoutFieldItem":{"description":"Field specific properties.","properties":{"id":{"type":"string","description":"The unique identifier of a field."}},"type":"object","required":["id"]},"aws-native:cases:LayoutSection0Properties":{"description":"A section can be a grouped list of fields.","properties":{"fieldGroup":{"$ref":"#/types/aws-native:cases:LayoutFieldGroup"}},"type":"object","required":["fieldGroup"]},"aws-native:cases:LayoutSectionProperties":{"description":"A section can be a grouped list of fields.","properties":{"fieldGroup":{"$ref":"#/types/aws-native:cases:LayoutFieldGroup"}},"type":"object","required":["fieldGroup"]},"aws-native:cases:LayoutSections":{"description":"Sections within a panel or tab of the page layout.","properties":{"sections":{"type":"array","items":{"$ref":"#/types/aws-native:cases:LayoutSectionProperties"},"description":"Defines the sections within a panel or tab. Contains field groups that organize related fields together."}},"type":"object"},"aws-native:cases:LayoutTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:cases:TemplateLayoutConfiguration":{"description":"Specifies the default layout to use when displaying cases created from this template. The layout determines which fields are visible and their arrangement in the agent interface.","properties":{"defaultLayout":{"type":"string","description":"The unique identifier of a layout."}},"type":"object"},"aws-native:cases:TemplateRequiredField":{"description":"Wrapper object containing a field identifier","properties":{"fieldId":{"type":"string","description":"The unique identifier of a field."}},"type":"object","required":["fieldId"]},"aws-native:cases:TemplateRule":{"description":"Links a case rule to a specific field within this template. When specified, the rule's conditions will be evaluated for the associated field, controlling behavior like required status, visibility, or available options.","properties":{"caseRuleId":{"type":"string","description":"The unique identifier of a case rule."},"fieldId":{"type":"string","description":"The ID of the field that this rule applies to."}},"type":"object","required":["caseRuleId"]},"aws-native:cases:TemplateStatus":{"description":"The current status of the template. Active templates can be used to create new cases, while Inactive templates are disabled but preserved for existing cases.","type":"string","enum":[{"name":"Active","value":"Active"},{"name":"Inactive","value":"Inactive"}]},"aws-native:cases:TemplateTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:cassandra:KeyspaceRegionListItem":{"type":"string","enum":[{"name":"AfSouth1","value":"af-south-1"},{"name":"ApEast1","value":"ap-east-1"},{"name":"ApNortheast1","value":"ap-northeast-1"},{"name":"ApNortheast2","value":"ap-northeast-2"},{"name":"ApSouth1","value":"ap-south-1"},{"name":"ApSoutheast1","value":"ap-southeast-1"},{"name":"ApSoutheast2","value":"ap-southeast-2"},{"name":"CaCentral1","value":"ca-central-1"},{"name":"EuCentral1","value":"eu-central-1"},{"name":"EuNorth1","value":"eu-north-1"},{"name":"EuWest1","value":"eu-west-1"},{"name":"EuWest2","value":"eu-west-2"},{"name":"EuWest3","value":"eu-west-3"},{"name":"MeCentral1","value":"me-central-1"},{"name":"MeSouth1","value":"me-south-1"},{"name":"SaEast1","value":"sa-east-1"},{"name":"UsEast1","value":"us-east-1"},{"name":"UsEast2","value":"us-east-2"},{"name":"UsWest1","value":"us-west-1"},{"name":"UsWest2","value":"us-west-2"}]},"aws-native:cassandra:KeyspaceReplicationSpecification":{"properties":{"regionList":{"type":"array","items":{"$ref":"#/types/aws-native:cassandra:KeyspaceRegionListItem"},"description":"Specifies the AWS Regions that the keyspace is replicated in. You must specify at least two Regions, including the Region that the keyspace is being created in.\n\nTo specify a Region [that's disabled by default](https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#rande-manage-enable) , you must first enable the Region. For more information, see [Multi-Region replication in AWS Regions disabled by default](https://docs.aws.amazon.com/keyspaces/latest/devguide/multiRegion-replication_how-it-works.html#howitworks_mrr_opt_in) in the *Amazon Keyspaces Developer Guide* ."},"replicationStrategy":{"$ref":"#/types/aws-native:cassandra:KeyspaceReplicationSpecificationReplicationStrategy","description":"The options are:\n\n- `SINGLE_REGION` (optional)\n- `MULTI_REGION`\n\nIf no value is specified, the default is `SINGLE_REGION` . If `MULTI_REGION` is specified, `RegionList` is required."}},"type":"object"},"aws-native:cassandra:KeyspaceReplicationSpecificationReplicationStrategy":{"description":"The options are:\n\n- `SINGLE_REGION` (optional)\n- `MULTI_REGION`\n\nIf no value is specified, the default is `SINGLE_REGION` . If `MULTI_REGION` is specified, `RegionList` is required.","type":"string","enum":[{"name":"SingleRegion","value":"SINGLE_REGION"},{"name":"MultiRegion","value":"MULTI_REGION"}]},"aws-native:cassandra:KeyspaceTag":{"properties":{"key":{"type":"string","description":"The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value."},"value":{"type":"string","description":"The value of the tag. Tag values are case-sensitive and can be null."}},"type":"object","required":["key","value"]},"aws-native:cassandra:TableAutoScalingSetting":{"description":"Represents configuration for auto scaling.","properties":{"autoScalingDisabled":{"type":"boolean","description":"This optional parameter enables auto scaling for the table if set to `false` ."},"maximumUnits":{"type":"integer","description":"Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default)."},"minimumUnits":{"type":"integer","description":"The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default)."},"scalingPolicy":{"$ref":"#/types/aws-native:cassandra:TableScalingPolicy","description":"Amazon Keyspaces supports the `target tracking` auto scaling policy. With this policy, Amazon Keyspaces auto scaling ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You define the target value as a percentage between 20 and 90."}},"type":"object"},"aws-native:cassandra:TableAutoScalingSpecification":{"description":"Represents the read and write settings used for AutoScaling.","properties":{"readCapacityAutoScaling":{"$ref":"#/types/aws-native:cassandra:TableAutoScalingSetting","description":"The auto scaling settings for the table's read capacity."},"writeCapacityAutoScaling":{"$ref":"#/types/aws-native:cassandra:TableAutoScalingSetting","description":"The auto scaling settings for the table's write capacity."}},"type":"object"},"aws-native:cassandra:TableBillingMode":{"properties":{"mode":{"$ref":"#/types/aws-native:cassandra:TableMode","description":"The billing mode for the table:\n\n- On-demand mode - `ON_DEMAND`\n- Provisioned mode - `PROVISIONED`\n\n\u003e If you choose `PROVISIONED` mode, then you also need to specify provisioned throughput (read and write capacity) for the table.\n\nValid values: `ON_DEMAND` | `PROVISIONED`"},"provisionedThroughput":{"$ref":"#/types/aws-native:cassandra:TableProvisionedThroughput","description":"The provisioned read capacity and write capacity for the table. For more information, see [Provisioned throughput capacity mode](https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html#ReadWriteCapacityMode.Provisioned) in the *Amazon Keyspaces Developer Guide* ."}},"type":"object","required":["mode"]},"aws-native:cassandra:TableCdcSpecification":{"description":"Represents the CDC configuration for the table","properties":{"status":{"$ref":"#/types/aws-native:cassandra:TableCdcStatus","description":"The status of the CDC stream. You can enable or disable a stream for a table."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:cassandra:TableTag"},"description":"An array of key-value pairs to apply to the CDC stream resource"},"viewType":{"$ref":"#/types/aws-native:cassandra:TableCdcViewType","description":"The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. After you create the stream, you can't make changes to this selection.\n\nThe options are:\n\n- `NEW_AND_OLD_IMAGES` - both versions of the row, before and after the change. This is the default.\n- `NEW_IMAGE` - the version of the row after the change.\n- `OLD_IMAGE` - the version of the row before the change.\n- `KEYS_ONLY` - the partition and clustering keys of the row that was changed."}},"type":"object","required":["status"]},"aws-native:cassandra:TableCdcStatus":{"description":"Indicates whether CDC is enabled or disabled for the table","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:cassandra:TableCdcViewType":{"description":"Specifies what data should be captured in the change data stream","type":"string","enum":[{"name":"NewImage","value":"NEW_IMAGE"},{"name":"OldImage","value":"OLD_IMAGE"},{"name":"KeysOnly","value":"KEYS_ONLY"},{"name":"NewAndOldImages","value":"NEW_AND_OLD_IMAGES"}]},"aws-native:cassandra:TableClusteringKeyColumn":{"properties":{"column":{"$ref":"#/types/aws-native:cassandra:TableColumn","description":"The name and data type of this clustering key column."},"orderBy":{"$ref":"#/types/aws-native:cassandra:TableClusteringKeyColumnOrderBy","description":"The order in which this column's data is stored:\n\n- `ASC` (default) - The column's data is stored in ascending order.\n- `DESC` - The column's data is stored in descending order."}},"type":"object","required":["column"]},"aws-native:cassandra:TableClusteringKeyColumnOrderBy":{"description":"The order in which this column's data is stored:\n\n- `ASC` (default) - The column's data is stored in ascending order.\n- `DESC` - The column's data is stored in descending order.","type":"string","enum":[{"name":"Asc","value":"ASC"},{"name":"Desc","value":"DESC"}]},"aws-native:cassandra:TableColumn":{"properties":{"columnName":{"type":"string","description":"The name of the column. For more information, see [Identifiers](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.elements.identifier) in the *Amazon Keyspaces Developer Guide* ."},"columnType":{"type":"string","description":"The data type of the column. For more information, see [Data types](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) in the *Amazon Keyspaces Developer Guide* ."}},"type":"object","required":["columnName","columnType"]},"aws-native:cassandra:TableEncryptionSpecification":{"description":"Represents the settings used to enable server-side encryption","properties":{"encryptionType":{"$ref":"#/types/aws-native:cassandra:TableEncryptionType","description":"The encryption at rest options for the table.\n\n- *AWS owned key* (default) - `AWS_OWNED_KMS_KEY`\n- *Customer managed key* - `CUSTOMER_MANAGED_KMS_KEY`\n\n\u003e If you choose `CUSTOMER_MANAGED_KMS_KEY` , a `kms_key_identifier` in the format of a key ARN is required.\n\nValid values: `CUSTOMER_MANAGED_KMS_KEY` | `AWS_OWNED_KMS_KEY` ."},"kmsKeyIdentifier":{"type":"string","description":"Requires a `kms_key_identifier` in the format of a key ARN."}},"type":"object","required":["encryptionType"]},"aws-native:cassandra:TableEncryptionType":{"description":"Server-side encryption type","type":"string","enum":[{"name":"AwsOwnedKmsKey","value":"AWS_OWNED_KMS_KEY"},{"name":"CustomerManagedKmsKey","value":"CUSTOMER_MANAGED_KMS_KEY"}]},"aws-native:cassandra:TableMode":{"description":"Capacity mode for the specified table","type":"string","enum":[{"name":"Provisioned","value":"PROVISIONED"},{"name":"OnDemand","value":"ON_DEMAND"}]},"aws-native:cassandra:TableProvisionedThroughput":{"description":"Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits","properties":{"readCapacityUnits":{"type":"integer","description":"The amount of read capacity that's provisioned for the table. For more information, see [Read/write capacity mode](https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) in the *Amazon Keyspaces Developer Guide* ."},"writeCapacityUnits":{"type":"integer","description":"The amount of write capacity that's provisioned for the table. For more information, see [Read/write capacity mode](https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) in the *Amazon Keyspaces Developer Guide* ."}},"type":"object","required":["readCapacityUnits","writeCapacityUnits"]},"aws-native:cassandra:TableReplicaSpecification":{"description":"Represents replica specifications.","properties":{"readCapacityAutoScaling":{"$ref":"#/types/aws-native:cassandra:TableAutoScalingSetting","description":"The read capacity auto scaling settings for the multi-Region table in the specified AWS Region."},"readCapacityUnits":{"type":"integer","description":"The provisioned read capacity units for the multi-Region table in the specified AWS Region."},"region":{"type":"string","description":"The AWS Region."}},"type":"object","required":["region"]},"aws-native:cassandra:TableScalingPolicy":{"description":"Represents scaling policy.","properties":{"targetTrackingScalingPolicyConfiguration":{"$ref":"#/types/aws-native:cassandra:TableTargetTrackingScalingPolicyConfiguration","description":"The auto scaling policy that scales a table based on the ratio of consumed to provisioned capacity."}},"type":"object"},"aws-native:cassandra:TableTag":{"description":"A key-value pair to apply to the resource","properties":{"key":{"type":"string","description":"The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value."},"value":{"type":"string","description":"The value of the tag. Tag values are case-sensitive and can be null."}},"type":"object","required":["key","value"]},"aws-native:cassandra:TableTargetTrackingScalingPolicyConfiguration":{"description":"Represents configuration for target tracking scaling policy.","properties":{"disableScaleIn":{"type":"boolean","description":"Specifies if `scale-in` is enabled.\n\nWhen auto scaling automatically decreases capacity for a table, the table *scales in* . When scaling policies are set, they can't scale in the table lower than its minimum capacity."},"scaleInCooldown":{"type":"integer","description":"Specifies a `scale-in` cool down period.\n\nA cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts."},"scaleOutCooldown":{"type":"integer","description":"Specifies a scale out cool down period.\n\nA cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts."},"targetValue":{"type":"integer","description":"Specifies the target value for the target tracking auto scaling policy.\n\nAmazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define `targetValue` as a percentage. An `integer` between 20 and 90."}},"type":"object","required":["targetValue"]},"aws-native:cassandra:TableWarmThroughput":{"description":"Warm throughput configuration for the table","properties":{"readUnitsPerSecond":{"type":"integer"},"writeUnitsPerSecond":{"type":"integer"}},"type":"object"},"aws-native:cassandra:TypeField":{"properties":{"fieldName":{"type":"string","description":"The name of the field."},"fieldType":{"type":"string","description":"The data type of the field. This can be any Cassandra data type or another user-defined type."}},"type":"object","required":["fieldName","fieldType"]},"aws-native:ce:AnomalyMonitorMonitorDimension":{"description":"The dimensions to evaluate","type":"string","enum":[{"name":"Service","value":"SERVICE"},{"name":"LinkedAccount","value":"LINKED_ACCOUNT"},{"name":"Tag","value":"TAG"},{"name":"CostCategory","value":"COST_CATEGORY"}]},"aws-native:ce:AnomalyMonitorMonitorType":{"description":"The type of the monitor.\n\nSet this to `DIMENSIONAL` for an AWS managed monitor. AWS managed monitors automatically track up to the top 5,000 values by cost within a dimension of your choosing. Each dimension value is evaluated independently. If you start incurring cost in a new value of your chosen dimension, it will automatically be analyzed by an AWS managed monitor.\n\nSet this to `CUSTOM` for a customer managed monitor. Customer managed monitors let you select specific dimension values that get monitored in aggregate.\n\nFor more information about monitor types, see [Monitor types](https://docs.aws.amazon.com/cost-management/latest/userguide/getting-started-ad.html#monitor-type-def) in the *Billing and Cost Management User Guide* .","type":"string","enum":[{"name":"Dimensional","value":"DIMENSIONAL"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:ce:AnomalyMonitorResourceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name for the tag."},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key","value"]},"aws-native:ce:AnomalySubscriptionFrequency":{"description":"The frequency at which anomaly reports are sent over email. ","type":"string","enum":[{"name":"Daily","value":"DAILY"},{"name":"Immediate","value":"IMMEDIATE"},{"name":"Weekly","value":"WEEKLY"}]},"aws-native:ce:AnomalySubscriptionResourceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name for the tag."},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key","value"]},"aws-native:ce:AnomalySubscriptionSubscriber":{"properties":{"address":{"type":"string","description":"The email address or SNS Topic Amazon Resource Name (ARN), depending on the `Type` ."},"status":{"$ref":"#/types/aws-native:ce:AnomalySubscriptionSubscriberStatus","description":"Indicates if the subscriber accepts the notifications."},"type":{"$ref":"#/types/aws-native:ce:AnomalySubscriptionSubscriberType","description":"The notification delivery channel."}},"type":"object","required":["address","type"]},"aws-native:ce:AnomalySubscriptionSubscriberStatus":{"description":"Indicates if the subscriber accepts the notifications.","type":"string","enum":[{"name":"Confirmed","value":"CONFIRMED"},{"name":"Declined","value":"DECLINED"}]},"aws-native:ce:AnomalySubscriptionSubscriberType":{"description":"The notification delivery channel.","type":"string","enum":[{"name":"Email","value":"EMAIL"},{"name":"Sns","value":"SNS"}]},"aws-native:ce:CostCategoryResourceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name for the tag."},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key","value"]},"aws-native:ce:CostCategoryRuleVersion":{"description":"The rule schema version in this particular Cost Category.","type":"string","enum":[{"name":"CostCategoryExpressionV1","value":"CostCategoryExpression.v1"}]},"aws-native:certificatemanager:AccountExpiryEventsConfiguration":{"properties":{"daysBeforeExpiry":{"type":"integer","description":"This option specifies the number of days prior to certificate expiration when ACM starts generating `EventBridge` events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration."}},"type":"object"},"aws-native:chatbot:CustomActionAttachment":{"properties":{"buttonText":{"type":"string","description":"The text of the button that appears on the notification."},"criteria":{"type":"array","items":{"$ref":"#/types/aws-native:chatbot:CustomActionAttachmentCriteria"},"description":"The criteria for when a button should be shown based on values in the notification."},"notificationType":{"type":"string","description":"The type of notification that the custom action should be attached to."},"variables":{"type":"object","additionalProperties":{"type":"string"},"description":"The variables to extract from the notification."}},"type":"object"},"aws-native:chatbot:CustomActionAttachmentCriteria":{"properties":{"operator":{"$ref":"#/types/aws-native:chatbot:CustomActionAttachmentCriteriaOperator","description":"The operation to perform on the named variable."},"value":{"type":"string","description":"A value that is compared with the actual value of the variable based on the behavior of the operator."},"variableName":{"type":"string","description":"The name of the variable to operate on."}},"type":"object","required":["operator","variableName"]},"aws-native:chatbot:CustomActionAttachmentCriteriaOperator":{"type":"string","enum":[{"name":"HasValue","value":"HAS_VALUE"},{"name":"Equals","value":"EQUALS"}]},"aws-native:chatbot:CustomActionDefinition":{"properties":{"commandText":{"type":"string","description":"The command string to run which may include variables by prefixing with a dollar sign ($)."}},"type":"object","required":["commandText"]},"aws-native:chatbot:CustomActionTag":{"properties":{"key":{"type":"string","description":"A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: `aws:` ."},"value":{"type":"string","description":"A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value."}},"type":"object","required":["key","value"]},"aws-native:chatbot:MicrosoftTeamsChannelConfigurationTag":{"properties":{"key":{"type":"string","description":"A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: `aws:` ."},"value":{"type":"string","description":"A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value."}},"type":"object","required":["key","value"]},"aws-native:chatbot:SlackChannelConfigurationTag":{"properties":{"key":{"type":"string","description":"A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: `aws:` ."},"value":{"type":"string","description":"A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value."}},"type":"object","required":["key","value"]},"aws-native:cleanrooms:AnalysisTemplateAnalysisParameter":{"properties":{"defaultValue":{"type":"string","description":"Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor."},"name":{"type":"string","description":"The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen."},"type":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateAnalysisParameterType","description":"The type of parameter."}},"type":"object","required":["name","type"]},"aws-native:cleanrooms:AnalysisTemplateAnalysisParameterType":{"description":"The type of parameter.","type":"string","enum":[{"name":"Smallint","value":"SMALLINT"},{"name":"Integer","value":"INTEGER"},{"name":"Bigint","value":"BIGINT"},{"name":"Decimal","value":"DECIMAL"},{"name":"Real","value":"REAL"},{"name":"DoublePrecision","value":"DOUBLE_PRECISION"},{"name":"Boolean","value":"BOOLEAN"},{"name":"Char","value":"CHAR"},{"name":"Varchar","value":"VARCHAR"},{"name":"Date","value":"DATE"},{"name":"Timestamp","value":"TIMESTAMP"},{"name":"Timestamptz","value":"TIMESTAMPTZ"},{"name":"Time","value":"TIME"},{"name":"Timetz","value":"TIMETZ"},{"name":"Varbyte","value":"VARBYTE"},{"name":"Binary","value":"BINARY"},{"name":"Byte","value":"BYTE"},{"name":"Character","value":"CHARACTER"},{"name":"Double","value":"DOUBLE"},{"name":"Float","value":"FLOAT"},{"name":"Int","value":"INT"},{"name":"Long","value":"LONG"},{"name":"Numeric","value":"NUMERIC"},{"name":"Short","value":"SHORT"},{"name":"String","value":"STRING"},{"name":"TimestampLtz","value":"TIMESTAMP_LTZ"},{"name":"TimestampNtz","value":"TIMESTAMP_NTZ"},{"name":"Tinyint","value":"TINYINT"}]},"aws-native:cleanrooms:AnalysisTemplateAnalysisSchema":{"properties":{"referencedTables":{"type":"array","items":{"type":"string"},"description":"The tables referenced in the analysis schema."}},"type":"object","required":["referencedTables"]},"aws-native:cleanrooms:AnalysisTemplateAnalysisSource0Properties":{"properties":{"text":{"type":"string"}},"type":"object","required":["text"]},"aws-native:cleanrooms:AnalysisTemplateAnalysisSource1Properties":{"properties":{"artifacts":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateArtifacts"}},"type":"object","required":["artifacts"]},"aws-native:cleanrooms:AnalysisTemplateAnalysisSourceMetadata0Properties":{"properties":{"artifacts":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateArtifactMetadata"}},"type":"object","required":["artifacts"]},"aws-native:cleanrooms:AnalysisTemplateAnalysisSourceMetadataProperties":{"properties":{"artifacts":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateArtifactMetadata"}},"type":"object","required":["artifacts"]},"aws-native:cleanrooms:AnalysisTemplateArtifact":{"properties":{"location":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateS3Location"}},"type":"object","required":["location"]},"aws-native:cleanrooms:AnalysisTemplateArtifactMetadata":{"properties":{"additionalArtifactHashes":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateHash"}},"entryPointHash":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateHash"}},"type":"object","required":["entryPointHash"]},"aws-native:cleanrooms:AnalysisTemplateArtifacts":{"properties":{"additionalArtifacts":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateArtifact"}},"entryPoint":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateArtifact"},"roleArn":{"type":"string"}},"type":"object","required":["entryPoint","roleArn"]},"aws-native:cleanrooms:AnalysisTemplateColumnClassificationDetails":{"properties":{"columnMapping":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateSyntheticDataColumnProperties"}}},"type":"object","required":["columnMapping"]},"aws-native:cleanrooms:AnalysisTemplateErrorMessageConfiguration":{"properties":{"type":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateErrorMessageConfigurationType","description":"The level of detail for error messages returned by the PySpark job. When set to DETAILED, error messages include more information to help troubleshoot issues with your PySpark job.\n\nBecause this setting may expose sensitive data, it is recommended for development and testing environments."}},"type":"object","required":["type"]},"aws-native:cleanrooms:AnalysisTemplateErrorMessageConfigurationType":{"description":"The level of detail for error messages returned by the PySpark job. When set to DETAILED, error messages include more information to help troubleshoot issues with your PySpark job.\n\nBecause this setting may expose sensitive data, it is recommended for development and testing environments.","type":"string","enum":[{"name":"Detailed","value":"DETAILED"}]},"aws-native:cleanrooms:AnalysisTemplateFormat":{"description":"The format of the analysis template.","type":"string","enum":[{"name":"Sql","value":"SQL"},{"name":"Pyspark10","value":"PYSPARK_1_0"}]},"aws-native:cleanrooms:AnalysisTemplateHash":{"properties":{"sha256":{"type":"string"}},"type":"object"},"aws-native:cleanrooms:AnalysisTemplateMlSyntheticDataParameters":{"properties":{"columnClassification":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateColumnClassificationDetails"},"epsilon":{"type":"number"},"maxMembershipInferenceAttackScore":{"type":"number"}},"type":"object","required":["columnClassification","epsilon","maxMembershipInferenceAttackScore"]},"aws-native:cleanrooms:AnalysisTemplateS3Location":{"properties":{"bucket":{"type":"string"},"key":{"type":"string"}},"type":"object","required":["bucket","key"]},"aws-native:cleanrooms:AnalysisTemplateSyntheticDataColumnProperties":{"properties":{"columnName":{"type":"string"},"columnType":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateSyntheticDataColumnPropertiesColumnType"},"isPredictiveValue":{"type":"boolean"}},"type":"object","required":["columnName","columnType","isPredictiveValue"]},"aws-native:cleanrooms:AnalysisTemplateSyntheticDataColumnPropertiesColumnType":{"type":"string","enum":[{"name":"Categorical","value":"CATEGORICAL"},{"name":"Numerical","value":"NUMERICAL"}]},"aws-native:cleanrooms:AnalysisTemplateSyntheticDataParameters0Properties":{"properties":{"mlSyntheticDataParameters":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateMlSyntheticDataParameters"}},"type":"object","required":["mlSyntheticDataParameters"]},"aws-native:cleanrooms:AnalysisTemplateSyntheticDataParametersProperties":{"properties":{"mlSyntheticDataParameters":{"$ref":"#/types/aws-native:cleanrooms:AnalysisTemplateMlSyntheticDataParameters"}},"type":"object","required":["mlSyntheticDataParameters"]},"aws-native:cleanrooms:AnalysisTemplateTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:cleanrooms:CollaborationAnalyticsEngine":{"type":"string","enum":[{"name":"CleanRoomsSql","value":"CLEAN_ROOMS_SQL"},{"name":"Spark","value":"SPARK"}]},"aws-native:cleanrooms:CollaborationAutoApprovedChangeType":{"type":"string","enum":[{"name":"AddMember","value":"ADD_MEMBER"},{"name":"GrantReceiveResultsAbility","value":"GRANT_RECEIVE_RESULTS_ABILITY"},{"name":"RevokeReceiveResultsAbility","value":"REVOKE_RECEIVE_RESULTS_ABILITY"}]},"aws-native:cleanrooms:CollaborationCustomMlMemberAbility":{"type":"string","enum":[{"name":"CanReceiveModelOutput","value":"CAN_RECEIVE_MODEL_OUTPUT"},{"name":"CanReceiveInferenceOutput","value":"CAN_RECEIVE_INFERENCE_OUTPUT"}]},"aws-native:cleanrooms:CollaborationDataEncryptionMetadata":{"properties":{"allowCleartext":{"type":"boolean","description":"Indicates whether encrypted tables can contain cleartext data ( `TRUE` ) or are to cryptographically process every column ( `FALSE` )."},"allowDuplicates":{"type":"boolean","description":"Indicates whether Fingerprint columns can contain duplicate entries ( `TRUE` ) or are to contain only non-repeated values ( `FALSE` )."},"allowJoinsOnColumnsWithDifferentNames":{"type":"boolean","description":"Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( `TRUE` ) or can only be joined on Fingerprint columns of the same name ( `FALSE` )."},"preserveNulls":{"type":"boolean","description":"Indicates whether NULL values are to be copied as NULL to encrypted tables ( `TRUE` ) or cryptographically processed ( `FALSE` )."}},"type":"object","required":["allowCleartext","allowDuplicates","allowJoinsOnColumnsWithDifferentNames","preserveNulls"]},"aws-native:cleanrooms:CollaborationJobComputePaymentConfig":{"properties":{"isResponsible":{"type":"boolean","description":"Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs ( `TRUE` ) or has not configured the collaboration member to pay for query and job compute costs ( `FALSE` ).\n\nExactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration.\n\nAn error is returned if the collaboration creator sets a `FALSE` value for the member who can run queries and jobs."}},"type":"object","required":["isResponsible"]},"aws-native:cleanrooms:CollaborationJobLogStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:cleanrooms:CollaborationMemberAbility":{"type":"string","enum":[{"name":"CanQuery","value":"CAN_QUERY"},{"name":"CanRunJob","value":"CAN_RUN_JOB"},{"name":"CanReceiveResults","value":"CAN_RECEIVE_RESULTS"}]},"aws-native:cleanrooms:CollaborationMemberSpecification":{"properties":{"accountId":{"type":"string","description":"The identifier used to reference members of the collaboration. Currently only supports AWS account ID."},"displayName":{"type":"string","description":"The member's display name."},"memberAbilities":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:CollaborationMemberAbility"},"description":"The abilities granted to the collaboration member.\n\n*Allowed Values* : `CAN_QUERY` | `CAN_RECEIVE_RESULTS`"},"mlMemberAbilities":{"$ref":"#/types/aws-native:cleanrooms:CollaborationMlMemberAbilities","description":"The ML abilities granted to the collaboration member."},"paymentConfiguration":{"$ref":"#/types/aws-native:cleanrooms:CollaborationPaymentConfiguration","description":"The collaboration member's payment responsibilities set by the collaboration creator.\n\nIf the collaboration creator hasn't speciﬁed anyone as the member paying for query compute costs, then the member who can query is the default payer."}},"type":"object","required":["accountId","displayName"]},"aws-native:cleanrooms:CollaborationMlMemberAbilities":{"properties":{"customMlMemberAbilities":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:CollaborationCustomMlMemberAbility"},"description":"The custom ML member abilities for a collaboration member."}},"type":"object","required":["customMlMemberAbilities"]},"aws-native:cleanrooms:CollaborationMlPaymentConfig":{"properties":{"modelInference":{"$ref":"#/types/aws-native:cleanrooms:CollaborationModelInferencePaymentConfig","description":"The payment responsibilities accepted by the member for model inference."},"modelTraining":{"$ref":"#/types/aws-native:cleanrooms:CollaborationModelTrainingPaymentConfig","description":"The payment responsibilities accepted by the member for model training."},"syntheticDataGeneration":{"$ref":"#/types/aws-native:cleanrooms:CollaborationSyntheticDataGenerationPaymentConfig","description":"The payment configuration for machine learning synthetic data generation."}},"type":"object"},"aws-native:cleanrooms:CollaborationModelInferencePaymentConfig":{"properties":{"isResponsible":{"type":"boolean","description":"Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( `TRUE` ) or has not configured the collaboration member to pay for model inference costs ( `FALSE` ).\n\nExactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration.\n\nIf the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a `FALSE` value for the member who can query."}},"type":"object","required":["isResponsible"]},"aws-native:cleanrooms:CollaborationModelTrainingPaymentConfig":{"properties":{"isResponsible":{"type":"boolean","description":"Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( `TRUE` ) or has not configured the collaboration member to pay for model training costs ( `FALSE` ).\n\nExactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration.\n\nIf the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a `FALSE` value for the member who can query."}},"type":"object","required":["isResponsible"]},"aws-native:cleanrooms:CollaborationPaymentConfiguration":{"properties":{"jobCompute":{"$ref":"#/types/aws-native:cleanrooms:CollaborationJobComputePaymentConfig","description":"The compute configuration for the job."},"machineLearning":{"$ref":"#/types/aws-native:cleanrooms:CollaborationMlPaymentConfig","description":"An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator."},"queryCompute":{"$ref":"#/types/aws-native:cleanrooms:CollaborationQueryComputePaymentConfig","description":"The collaboration member's payment responsibilities set by the collaboration creator for query compute costs."}},"type":"object","required":["queryCompute"]},"aws-native:cleanrooms:CollaborationQueryComputePaymentConfig":{"properties":{"isResponsible":{"type":"boolean","description":"Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( `TRUE` ) or has not configured the collaboration member to pay for query compute costs ( `FALSE` ).\n\nExactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a `TRUE` value for more than one member in the collaboration.\n\nIf the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a `FALSE` value for the member who can query."}},"type":"object","required":["isResponsible"]},"aws-native:cleanrooms:CollaborationQueryLogStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:cleanrooms:CollaborationSupportedS3Region":{"type":"string","enum":[{"name":"UsWest1","value":"us-west-1"},{"name":"UsWest2","value":"us-west-2"},{"name":"UsEast1","value":"us-east-1"},{"name":"UsEast2","value":"us-east-2"},{"name":"AfSouth1","value":"af-south-1"},{"name":"ApEast1","value":"ap-east-1"},{"name":"ApEast2","value":"ap-east-2"},{"name":"ApSouth2","value":"ap-south-2"},{"name":"ApSoutheast1","value":"ap-southeast-1"},{"name":"ApSoutheast2","value":"ap-southeast-2"},{"name":"ApSoutheast3","value":"ap-southeast-3"},{"name":"ApSoutheast5","value":"ap-southeast-5"},{"name":"ApSoutheast4","value":"ap-southeast-4"},{"name":"ApSoutheast7","value":"ap-southeast-7"},{"name":"ApSouth1","value":"ap-south-1"},{"name":"ApNortheast3","value":"ap-northeast-3"},{"name":"ApNortheast1","value":"ap-northeast-1"},{"name":"ApNortheast2","value":"ap-northeast-2"},{"name":"CaCentral1","value":"ca-central-1"},{"name":"CaWest1","value":"ca-west-1"},{"name":"EuSouth1","value":"eu-south-1"},{"name":"EuWest3","value":"eu-west-3"},{"name":"EuSouth2","value":"eu-south-2"},{"name":"EuCentral2","value":"eu-central-2"},{"name":"EuCentral1","value":"eu-central-1"},{"name":"EuNorth1","value":"eu-north-1"},{"name":"EuWest1","value":"eu-west-1"},{"name":"EuWest2","value":"eu-west-2"},{"name":"MeSouth1","value":"me-south-1"},{"name":"MeCentral1","value":"me-central-1"},{"name":"IlCentral1","value":"il-central-1"},{"name":"SaEast1","value":"sa-east-1"},{"name":"MxCentral1","value":"mx-central-1"}]},"aws-native:cleanrooms:CollaborationSyntheticDataGenerationPaymentConfig":{"properties":{"isResponsible":{"type":"boolean","description":"Indicates who is responsible for paying for synthetic data generation."}},"type":"object","required":["isResponsible"]},"aws-native:cleanrooms:CollaborationTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:cleanrooms:ConfiguredTableAdditionalAnalyses":{"type":"string","enum":[{"name":"Allowed","value":"ALLOWED"},{"name":"Required","value":"REQUIRED"},{"name":"NotAllowed","value":"NOT_ALLOWED"}]},"aws-native:cleanrooms:ConfiguredTableAggregateColumn":{"properties":{"columnNames":{"type":"array","items":{"type":"string"}},"function":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAggregateFunctionName"}},"type":"object","required":["columnNames","function"]},"aws-native:cleanrooms:ConfiguredTableAggregateFunctionName":{"type":"string","enum":[{"name":"Sum","value":"SUM"},{"name":"SumDistinct","value":"SUM_DISTINCT"},{"name":"Count","value":"COUNT"},{"name":"CountDistinct","value":"COUNT_DISTINCT"},{"name":"Avg","value":"AVG"}]},"aws-native:cleanrooms:ConfiguredTableAggregationConstraint":{"properties":{"columnName":{"type":"string"},"minimum":{"type":"number"},"type":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAggregationType"}},"type":"object","required":["columnName","minimum","type"]},"aws-native:cleanrooms:ConfiguredTableAggregationType":{"type":"string","enum":[{"name":"CountDistinct","value":"COUNT_DISTINCT"}]},"aws-native:cleanrooms:ConfiguredTableAnalysisMethod":{"type":"string","enum":[{"name":"DirectQuery","value":"DIRECT_QUERY"},{"name":"DirectJob","value":"DIRECT_JOB"},{"name":"Multiple","value":"MULTIPLE"}]},"aws-native:cleanrooms:ConfiguredTableAnalysisRule":{"properties":{"policy":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAnalysisRulePolicy","description":"A policy that describes the associated data usage limitations."},"type":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAnalysisRuleType","description":"The type of analysis rule."}},"type":"object","required":["policy","type"]},"aws-native:cleanrooms:ConfiguredTableAnalysisRuleAggregation":{"properties":{"additionalAnalyses":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAdditionalAnalyses"},"aggregateColumns":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAggregateColumn"}},"allowedJoinOperators":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableJoinOperator"}},"dimensionColumns":{"type":"array","items":{"type":"string"}},"joinColumns":{"type":"array","items":{"type":"string"}},"joinRequired":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableJoinRequiredOption"},"outputConstraints":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAggregationConstraint"}},"scalarFunctions":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableScalarFunctions"}}},"type":"object","required":["aggregateColumns","dimensionColumns","joinColumns","outputConstraints","scalarFunctions"]},"aws-native:cleanrooms:ConfiguredTableAnalysisRuleCustom":{"properties":{"additionalAnalyses":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAdditionalAnalyses"},"allowedAnalyses":{"type":"array","items":{"type":"string"}},"allowedAnalysisProviders":{"type":"array","items":{"type":"string"}},"differentialPrivacy":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableDifferentialPrivacy"},"disallowedOutputColumns":{"type":"array","items":{"type":"string"}}},"type":"object","required":["allowedAnalyses"]},"aws-native:cleanrooms:ConfiguredTableAnalysisRuleList":{"properties":{"additionalAnalyses":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAdditionalAnalyses"},"allowedJoinOperators":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableJoinOperator"}},"joinColumns":{"type":"array","items":{"type":"string"}},"listColumns":{"type":"array","items":{"type":"string"}}},"type":"object","required":["joinColumns","listColumns"]},"aws-native:cleanrooms:ConfiguredTableAnalysisRulePolicy":{"properties":{"v1":{"oneOf":[{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAnalysisRulePolicyV10Properties"},{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAnalysisRulePolicyV11Properties"},{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAnalysisRulePolicyV12Properties"}],"description":"Controls on the query specifications that can be run on a configured table."}},"type":"object","required":["v1"]},"aws-native:cleanrooms:ConfiguredTableAnalysisRulePolicyV10Properties":{"properties":{"list":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAnalysisRuleList"}},"type":"object","required":["list"]},"aws-native:cleanrooms:ConfiguredTableAnalysisRulePolicyV11Properties":{"properties":{"aggregation":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAnalysisRuleAggregation"}},"type":"object","required":["aggregation"]},"aws-native:cleanrooms:ConfiguredTableAnalysisRulePolicyV12Properties":{"properties":{"custom":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAnalysisRuleCustom"}},"type":"object","required":["custom"]},"aws-native:cleanrooms:ConfiguredTableAnalysisRuleType":{"type":"string","enum":[{"name":"Aggregation","value":"AGGREGATION"},{"name":"List","value":"LIST"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRule":{"properties":{"policy":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRulePolicy","description":"The policy of the configured table association analysis rule."},"type":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRuleType","description":"The type of the configured table association analysis rule."}},"type":"object","required":["policy","type"]},"aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRuleAggregation":{"properties":{"allowedAdditionalAnalyses":{"type":"array","items":{"type":"string"}},"allowedResultReceivers":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRuleCustom":{"properties":{"allowedAdditionalAnalyses":{"type":"array","items":{"type":"string"}},"allowedResultReceivers":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRuleList":{"properties":{"allowedAdditionalAnalyses":{"type":"array","items":{"type":"string"}},"allowedResultReceivers":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRulePolicy":{"properties":{"v1":{"oneOf":[{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRulePolicyV10Properties"},{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRulePolicyV11Properties"},{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRulePolicyV12Properties"}],"description":"The policy for the configured table association analysis rule."}},"type":"object","required":["v1"]},"aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRulePolicyV10Properties":{"properties":{"list":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRuleList"}},"type":"object","required":["list"]},"aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRulePolicyV11Properties":{"properties":{"aggregation":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRuleAggregation"}},"type":"object","required":["aggregation"]},"aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRulePolicyV12Properties":{"properties":{"custom":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRuleCustom"}},"type":"object","required":["custom"]},"aws-native:cleanrooms:ConfiguredTableAssociationAnalysisRuleType":{"type":"string","enum":[{"name":"Aggregation","value":"AGGREGATION"},{"name":"List","value":"LIST"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:cleanrooms:ConfiguredTableAssociationTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:cleanrooms:ConfiguredTableAthenaTableReference":{"properties":{"databaseName":{"type":"string"},"outputLocation":{"type":"string"},"region":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableCommercialRegion"},"tableName":{"type":"string"},"workGroup":{"type":"string"}},"type":"object","required":["databaseName","tableName","workGroup"]},"aws-native:cleanrooms:ConfiguredTableCommercialRegion":{"type":"string","enum":[{"name":"UsWest1","value":"us-west-1"},{"name":"UsWest2","value":"us-west-2"},{"name":"UsEast1","value":"us-east-1"},{"name":"UsEast2","value":"us-east-2"},{"name":"AfSouth1","value":"af-south-1"},{"name":"ApEast1","value":"ap-east-1"},{"name":"ApSouth2","value":"ap-south-2"},{"name":"ApSoutheast1","value":"ap-southeast-1"},{"name":"ApSoutheast2","value":"ap-southeast-2"},{"name":"ApSoutheast5","value":"ap-southeast-5"},{"name":"ApSoutheast4","value":"ap-southeast-4"},{"name":"ApSoutheast7","value":"ap-southeast-7"},{"name":"ApSouth1","value":"ap-south-1"},{"name":"ApNortheast3","value":"ap-northeast-3"},{"name":"ApNortheast1","value":"ap-northeast-1"},{"name":"ApNortheast2","value":"ap-northeast-2"},{"name":"CaCentral1","value":"ca-central-1"},{"name":"CaWest1","value":"ca-west-1"},{"name":"EuSouth1","value":"eu-south-1"},{"name":"EuWest3","value":"eu-west-3"},{"name":"EuSouth2","value":"eu-south-2"},{"name":"EuCentral2","value":"eu-central-2"},{"name":"EuCentral1","value":"eu-central-1"},{"name":"EuNorth1","value":"eu-north-1"},{"name":"EuWest1","value":"eu-west-1"},{"name":"EuWest2","value":"eu-west-2"},{"name":"MeSouth1","value":"me-south-1"},{"name":"MeCentral1","value":"me-central-1"},{"name":"IlCentral1","value":"il-central-1"},{"name":"SaEast1","value":"sa-east-1"},{"name":"MxCentral1","value":"mx-central-1"},{"name":"ApEast2","value":"ap-east-2"}]},"aws-native:cleanrooms:ConfiguredTableDifferentialPrivacy":{"properties":{"columns":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableDifferentialPrivacyColumn"}}},"type":"object","required":["columns"]},"aws-native:cleanrooms:ConfiguredTableDifferentialPrivacyColumn":{"properties":{"name":{"type":"string"}},"type":"object","required":["name"]},"aws-native:cleanrooms:ConfiguredTableGlueTableReference":{"properties":{"databaseName":{"type":"string"},"region":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableCommercialRegion"},"tableName":{"type":"string"}},"type":"object","required":["databaseName","tableName"]},"aws-native:cleanrooms:ConfiguredTableJoinOperator":{"type":"string","enum":[{"name":"Or","value":"OR"},{"name":"And","value":"AND"}]},"aws-native:cleanrooms:ConfiguredTableJoinRequiredOption":{"type":"string","enum":[{"name":"QueryRunner","value":"QUERY_RUNNER"}]},"aws-native:cleanrooms:ConfiguredTableScalarFunctions":{"type":"string","enum":[{"name":"Trunc","value":"TRUNC"},{"name":"Abs","value":"ABS"},{"name":"Ceiling","value":"CEILING"},{"name":"Floor","value":"FLOOR"},{"name":"Ln","value":"LN"},{"name":"Log","value":"LOG"},{"name":"Round","value":"ROUND"},{"name":"Sqrt","value":"SQRT"},{"name":"Cast","value":"CAST"},{"name":"Lower","value":"LOWER"},{"name":"Rtrim","value":"RTRIM"},{"name":"Upper","value":"UPPER"},{"name":"Coalesce","value":"COALESCE"},{"name":"Convert","value":"CONVERT"},{"name":"CurrentDate","value":"CURRENT_DATE"},{"name":"Dateadd","value":"DATEADD"},{"name":"Extract","value":"EXTRACT"},{"name":"Getdate","value":"GETDATE"},{"name":"Substring","value":"SUBSTRING"},{"name":"ToChar","value":"TO_CHAR"},{"name":"ToDate","value":"TO_DATE"},{"name":"ToNumber","value":"TO_NUMBER"},{"name":"ToTimestamp","value":"TO_TIMESTAMP"},{"name":"Trim","value":"TRIM"}]},"aws-native:cleanrooms:ConfiguredTableSelectedAnalysisMethod":{"type":"string","enum":[{"name":"DirectQuery","value":"DIRECT_QUERY"},{"name":"DirectJob","value":"DIRECT_JOB"}]},"aws-native:cleanrooms:ConfiguredTableSnowflakeTableReference":{"properties":{"accountIdentifier":{"type":"string"},"databaseName":{"type":"string"},"schemaName":{"type":"string"},"secretArn":{"type":"string"},"tableName":{"type":"string"},"tableSchema":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableSnowflakeTableSchemaProperties"}},"type":"object","required":["accountIdentifier","databaseName","schemaName","secretArn","tableName","tableSchema"]},"aws-native:cleanrooms:ConfiguredTableSnowflakeTableSchema0Properties":{"properties":{"v1":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableSnowflakeTableSchemaV1"}}},"type":"object","required":["v1"]},"aws-native:cleanrooms:ConfiguredTableSnowflakeTableSchemaProperties":{"properties":{"v1":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableSnowflakeTableSchemaV1"}}},"type":"object","required":["v1"]},"aws-native:cleanrooms:ConfiguredTableSnowflakeTableSchemaV1":{"properties":{"columnName":{"type":"string"},"columnType":{"type":"string"}},"type":"object","required":["columnName","columnType"]},"aws-native:cleanrooms:ConfiguredTableTableReference0Properties":{"properties":{"glue":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableGlueTableReference"}},"type":"object","required":["glue"]},"aws-native:cleanrooms:ConfiguredTableTableReference1Properties":{"properties":{"snowflake":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableSnowflakeTableReference"}},"type":"object","required":["snowflake"]},"aws-native:cleanrooms:ConfiguredTableTableReference2Properties":{"properties":{"athena":{"$ref":"#/types/aws-native:cleanrooms:ConfiguredTableAthenaTableReference"}},"type":"object","required":["athena"]},"aws-native:cleanrooms:ConfiguredTableTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:cleanrooms:IdMappingTableInputReferenceConfig":{"properties":{"inputReferenceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the referenced resource in AWS Entity Resolution . Valid values are ID mapping workflow ARNs."},"manageResourcePolicies":{"type":"boolean","description":"When `TRUE` , AWS Clean Rooms manages permissions for the ID mapping table resource.\n\nWhen `FALSE` , the resource owner manages permissions for the ID mapping table resource."}},"type":"object","required":["inputReferenceArn","manageResourcePolicies"]},"aws-native:cleanrooms:IdMappingTableInputReferenceProperties":{"properties":{"idMappingTableInputSource":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:IdMappingTableInputSource"},"description":"The input source of the ID mapping table."}},"type":"object","required":["idMappingTableInputSource"]},"aws-native:cleanrooms:IdMappingTableInputSource":{"properties":{"idNamespaceAssociationId":{"type":"string","description":"The unique identifier of the ID namespace association."},"type":{"$ref":"#/types/aws-native:cleanrooms:IdMappingTableInputSourceType","description":"The type of the input source of the ID mapping table."}},"type":"object","required":["idNamespaceAssociationId","type"]},"aws-native:cleanrooms:IdMappingTableInputSourceType":{"description":"The type of the input source of the ID mapping table.","type":"string","enum":[{"name":"Source","value":"SOURCE"},{"name":"Target","value":"TARGET"}]},"aws-native:cleanrooms:IdMappingTableTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:cleanrooms:IdNamespaceAssociationDocument":{"type":"object"},"aws-native:cleanrooms:IdNamespaceAssociationIdMappingConfig":{"properties":{"allowUseAsDimensionColumn":{"type":"boolean","description":"An indicator as to whether you can use your column as a dimension column in the ID mapping table ( `TRUE` ) or not ( `FALSE` ).\n\nDefault is `FALSE` ."}},"type":"object","required":["allowUseAsDimensionColumn"]},"aws-native:cleanrooms:IdNamespaceAssociationInputReferenceConfig":{"properties":{"inputReferenceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the AWS Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own."},"manageResourcePolicies":{"type":"boolean","description":"When `TRUE` , AWS Clean Rooms manages permissions for the ID namespace association resource.\n\nWhen `FALSE` , the resource owner manages permissions for the ID namespace association resource."}},"type":"object","required":["inputReferenceArn","manageResourcePolicies"]},"aws-native:cleanrooms:IdNamespaceAssociationInputReferenceProperties":{"properties":{"idMappingWorkflowsSupported":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:IdNamespaceAssociationDocument"},"description":"Defines how ID mapping workflows are supported for this ID namespace association."},"idNamespaceType":{"$ref":"#/types/aws-native:cleanrooms:IdNamespaceAssociationInputReferencePropertiesIdNamespaceType","description":"The ID namespace type for this ID namespace association."}},"type":"object"},"aws-native:cleanrooms:IdNamespaceAssociationInputReferencePropertiesIdNamespaceType":{"description":"The ID namespace type for this ID namespace association.","type":"string","enum":[{"name":"Source","value":"SOURCE"},{"name":"Target","value":"TARGET"}]},"aws-native:cleanrooms:IdNamespaceAssociationTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:cleanrooms:MembershipJobComputePaymentConfig":{"properties":{"isResponsible":{"type":"boolean","description":"Indicates whether the collaboration member has accepted to pay for job compute costs ( `TRUE` ) or has not accepted to pay for query and job compute costs ( `FALSE` ).\n\nThere is only one member who pays for queries and jobs.\n\nAn error message is returned for the following reasons:\n\n- If you set the value to `FALSE` but you are responsible to pay for query and job compute costs.\n- If you set the value to `TRUE` but you are not responsible to pay for query and job compute costs."}},"type":"object","required":["isResponsible"]},"aws-native:cleanrooms:MembershipJobLogStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:cleanrooms:MembershipMlPaymentConfig":{"properties":{"modelInference":{"$ref":"#/types/aws-native:cleanrooms:MembershipModelInferencePaymentConfig","description":"The payment responsibilities accepted by the member for model inference."},"modelTraining":{"$ref":"#/types/aws-native:cleanrooms:MembershipModelTrainingPaymentConfig","description":"The payment responsibilities accepted by the member for model training."},"syntheticDataGeneration":{"$ref":"#/types/aws-native:cleanrooms:MembershipSyntheticDataGenerationPaymentConfig","description":"The payment configuration for synthetic data generation for this machine learning membership."}},"type":"object"},"aws-native:cleanrooms:MembershipModelInferencePaymentConfig":{"properties":{"isResponsible":{"type":"boolean","description":"Indicates whether the collaboration member has accepted to pay for model inference costs ( `TRUE` ) or has not accepted to pay for model inference costs ( `FALSE` ).\n\nIf the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer.\n\nAn error message is returned for the following reasons:\n\n- If you set the value to `FALSE` but you are responsible to pay for model inference costs.\n- If you set the value to `TRUE` but you are not responsible to pay for model inference costs."}},"type":"object","required":["isResponsible"]},"aws-native:cleanrooms:MembershipModelTrainingPaymentConfig":{"properties":{"isResponsible":{"type":"boolean","description":"Indicates whether the collaboration member has accepted to pay for model training costs ( `TRUE` ) or has not accepted to pay for model training costs ( `FALSE` ).\n\nIf the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer.\n\nAn error message is returned for the following reasons:\n\n- If you set the value to `FALSE` but you are responsible to pay for model training costs.\n- If you set the value to `TRUE` but you are not responsible to pay for model training costs."}},"type":"object","required":["isResponsible"]},"aws-native:cleanrooms:MembershipPaymentConfiguration":{"properties":{"jobCompute":{"$ref":"#/types/aws-native:cleanrooms:MembershipJobComputePaymentConfig","description":"The payment responsibilities accepted by the collaboration member for job compute costs."},"machineLearning":{"$ref":"#/types/aws-native:cleanrooms:MembershipMlPaymentConfig","description":"The payment responsibilities accepted by the collaboration member for machine learning costs."},"queryCompute":{"$ref":"#/types/aws-native:cleanrooms:MembershipQueryComputePaymentConfig","description":"The payment responsibilities accepted by the collaboration member for query compute costs."}},"type":"object","required":["queryCompute"]},"aws-native:cleanrooms:MembershipProtectedJobOutputConfiguration":{"properties":{"s3":{"$ref":"#/types/aws-native:cleanrooms:MembershipProtectedJobS3OutputConfigurationInput","description":"Contains the configuration to write the job results to S3."}},"type":"object","required":["s3"]},"aws-native:cleanrooms:MembershipProtectedJobResultConfiguration":{"properties":{"outputConfiguration":{"$ref":"#/types/aws-native:cleanrooms:MembershipProtectedJobOutputConfiguration","description":"The output configuration for a protected job result."},"roleArn":{"type":"string","description":"The unique ARN for an IAM role that is used by AWS Clean Rooms to write protected job results to the result location, given by the member who can receive results."}},"type":"object","required":["outputConfiguration","roleArn"]},"aws-native:cleanrooms:MembershipProtectedJobS3OutputConfigurationInput":{"properties":{"bucket":{"type":"string","description":"The S3 bucket for job output."},"keyPrefix":{"type":"string","description":"The S3 prefix to unload the protected job results."}},"type":"object","required":["bucket"]},"aws-native:cleanrooms:MembershipProtectedQueryOutputConfiguration":{"properties":{"s3":{"$ref":"#/types/aws-native:cleanrooms:MembershipProtectedQueryS3OutputConfiguration","description":"Required configuration for a protected query with an `s3` output type."}},"type":"object","required":["s3"]},"aws-native:cleanrooms:MembershipProtectedQueryResultConfiguration":{"properties":{"outputConfiguration":{"$ref":"#/types/aws-native:cleanrooms:MembershipProtectedQueryOutputConfiguration","description":"Configuration for protected query results."},"roleArn":{"type":"string","description":"The unique ARN for an IAM role that is used by AWS Clean Rooms to write protected query results to the result location, given by the member who can receive results."}},"type":"object","required":["outputConfiguration"]},"aws-native:cleanrooms:MembershipProtectedQueryS3OutputConfiguration":{"properties":{"bucket":{"type":"string","description":"The S3 bucket to unload the protected query results."},"keyPrefix":{"type":"string","description":"The S3 prefix to unload the protected query results."},"resultFormat":{"$ref":"#/types/aws-native:cleanrooms:MembershipResultFormat","description":"Intended file format of the result."},"singleFileOutput":{"type":"boolean","description":"Indicates whether files should be output as a single file ( `TRUE` ) or output as multiple files ( `FALSE` ). This parameter is only supported for analyses with the Spark analytics engine."}},"type":"object","required":["bucket","resultFormat"]},"aws-native:cleanrooms:MembershipQueryComputePaymentConfig":{"properties":{"isResponsible":{"type":"boolean","description":"Indicates whether the collaboration member has accepted to pay for query compute costs ( `TRUE` ) or has not accepted to pay for query compute costs ( `FALSE` ).\n\nIf the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.\n\nAn error message is returned for the following reasons:\n\n- If you set the value to `FALSE` but you are responsible to pay for query compute costs.\n- If you set the value to `TRUE` but you are not responsible to pay for query compute costs."}},"type":"object","required":["isResponsible"]},"aws-native:cleanrooms:MembershipQueryLogStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:cleanrooms:MembershipResultFormat":{"type":"string","enum":[{"name":"Csv","value":"CSV"},{"name":"Parquet","value":"PARQUET"}]},"aws-native:cleanrooms:MembershipSyntheticDataGenerationPaymentConfig":{"properties":{"isResponsible":{"type":"boolean","description":"Indicates if this membership is responsible for paying for synthetic data generation."}},"type":"object","required":["isResponsible"]},"aws-native:cleanrooms:MembershipTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:cleanrooms:ParametersProperties":{"description":"Specifies the epsilon and noise parameters for the privacy budget template.","properties":{"budgetParameters":{"type":"array","items":{"$ref":"#/types/aws-native:cleanrooms:PrivacyBudgetTemplateBudgetParameter"}},"epsilon":{"type":"integer","description":"The epsilon value that you want to use."},"resourceArn":{"type":"string"},"usersNoisePerQuery":{"type":"integer","description":"Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted."}},"type":"object"},"aws-native:cleanrooms:PrivacyBudgetTemplateAutoRefresh":{"description":"How often the privacy budget refreshes.\n\n\u003e If you plan to regularly bring new data into the collaboration, use `CALENDAR_MONTH` to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.","type":"string","enum":[{"name":"CalendarMonth","value":"CALENDAR_MONTH"},{"name":"None","value":"NONE"}]},"aws-native:cleanrooms:PrivacyBudgetTemplateBudgetParameter":{"properties":{"autoRefresh":{"$ref":"#/types/aws-native:cleanrooms:PrivacyBudgetTemplateBudgetParameterAutoRefresh","description":"Whether this individual budget parameter automatically refreshes when the budget period resets."},"budget":{"type":"integer","description":"The budget allocation amount for this specific parameter."},"type":{"$ref":"#/types/aws-native:cleanrooms:PrivacyBudgetTemplateBudgetParameterType","description":"The type of budget parameter being configured."}},"type":"object","required":["budget","type"]},"aws-native:cleanrooms:PrivacyBudgetTemplateBudgetParameterAutoRefresh":{"description":"Whether this individual budget parameter automatically refreshes when the budget period resets.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:cleanrooms:PrivacyBudgetTemplateBudgetParameterType":{"description":"The type of budget parameter being configured.","type":"string","enum":[{"name":"CalendarDay","value":"CALENDAR_DAY"},{"name":"CalendarMonth","value":"CALENDAR_MONTH"},{"name":"CalendarWeek","value":"CALENDAR_WEEK"},{"name":"Lifetime","value":"LIFETIME"}]},"aws-native:cleanrooms:PrivacyBudgetTemplatePrivacyBudgetType":{"description":"Specifies the type of the privacy budget template.","type":"string","enum":[{"name":"DifferentialPrivacy","value":"DIFFERENTIAL_PRIVACY"},{"name":"AccessBudget","value":"ACCESS_BUDGET"}]},"aws-native:cleanrooms:PrivacyBudgetTemplateTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with `aws:` . digits, whitespace, `_` , `.` , `:` , `/` , `=` , `+` , `@` , `-` , and `\"` .\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)"},"value":{"type":"string","description":"The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_` , `.` , `/` , `=` , `+` , and `-` .\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) ."}},"type":"object","required":["key","value"]},"aws-native:cleanroomsml:TrainingDatasetColumnSchema":{"properties":{"columnName":{"type":"string","description":"The name of a column."},"columnTypes":{"type":"array","items":{"$ref":"#/types/aws-native:cleanroomsml:TrainingDatasetColumnType"},"description":"The data type of column."}},"type":"object","required":["columnName","columnTypes"]},"aws-native:cleanroomsml:TrainingDatasetColumnType":{"type":"string","enum":[{"name":"UserId","value":"USER_ID"},{"name":"ItemId","value":"ITEM_ID"},{"name":"Timestamp","value":"TIMESTAMP"},{"name":"CategoricalFeature","value":"CATEGORICAL_FEATURE"},{"name":"NumericalFeature","value":"NUMERICAL_FEATURE"}]},"aws-native:cleanroomsml:TrainingDatasetDataSource":{"properties":{"glueDataSource":{"$ref":"#/types/aws-native:cleanroomsml:TrainingDatasetGlueDataSource","description":"A GlueDataSource object that defines the catalog ID, database name, and table name for the training data."}},"type":"object","required":["glueDataSource"]},"aws-native:cleanroomsml:TrainingDatasetDataset":{"properties":{"inputConfig":{"$ref":"#/types/aws-native:cleanroomsml:TrainingDatasetDatasetInputConfig","description":"A DatasetInputConfig object that defines the data source and schema mapping."},"type":{"$ref":"#/types/aws-native:cleanroomsml:TrainingDatasetDatasetType","description":"What type of information is found in the dataset."}},"type":"object","required":["inputConfig","type"]},"aws-native:cleanroomsml:TrainingDatasetDatasetInputConfig":{"properties":{"dataSource":{"$ref":"#/types/aws-native:cleanroomsml:TrainingDatasetDataSource","description":"A DataSource object that specifies the Glue data source for the training data."},"schema":{"type":"array","items":{"$ref":"#/types/aws-native:cleanroomsml:TrainingDatasetColumnSchema"},"description":"The schema information for the training data."}},"type":"object","required":["dataSource","schema"]},"aws-native:cleanroomsml:TrainingDatasetDatasetType":{"type":"string","enum":[{"name":"Interactions","value":"INTERACTIONS"}]},"aws-native:cleanroomsml:TrainingDatasetGlueDataSource":{"properties":{"catalogId":{"type":"string","description":"The Glue catalog that contains the training data."},"databaseName":{"type":"string","description":"The Glue database that contains the training data."},"tableName":{"type":"string","description":"The Glue table that contains the training data."}},"type":"object","required":["databaseName","tableName"]},"aws-native:cleanroomsml:TrainingDatasetStatus":{"type":"string","enum":[{"name":"Active","value":"ACTIVE"}]},"aws-native:cleanroomsml:TrainingDatasetTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with `aws:` . digits, whitespace, `_` , `.` , `:` , `/` , `=` , `+` , `@` , `-` , and `\"` .\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)"},"value":{"type":"string","description":"The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_` , `.` , `/` , `=` , `+` , and `-` .\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) ."}},"type":"object","required":["key","value"]},"aws-native:cloudformation:GuardHookAction":{"description":"Target actions are the type of operation hooks will be executed at.","type":"string","enum":[{"name":"Create","value":"CREATE"},{"name":"Update","value":"UPDATE"},{"name":"Delete","value":"DELETE"}]},"aws-native:cloudformation:GuardHookFailureMode":{"description":"Attribute to specify CloudFormation behavior on hook failure.","type":"string","enum":[{"name":"Fail","value":"FAIL"},{"name":"Warn","value":"WARN"}]},"aws-native:cloudformation:GuardHookHookStatus":{"description":"Attribute to specify which stacks this hook applies to or should get invoked for","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:cloudformation:GuardHookHookTarget":{"description":"Hook targets are the destination where hooks will be invoked against.","properties":{"action":{"$ref":"#/types/aws-native:cloudformation:GuardHookAction"},"invocationPoint":{"$ref":"#/types/aws-native:cloudformation:GuardHookInvocationPoint"},"targetName":{"type":"string"}},"type":"object","required":["action","invocationPoint","targetName"]},"aws-native:cloudformation:GuardHookInvocationPoint":{"description":"Invocation points are the point in provisioning workflow where hooks will be executed.","type":"string","enum":[{"name":"PreProvision","value":"PRE_PROVISION"}]},"aws-native:cloudformation:GuardHookS3Location":{"description":"S3 Source Location for the Guard files.","properties":{"uri":{"type":"string","description":"S3 uri of Guard files."},"versionId":{"type":"string","description":"S3 object version"}},"type":"object","required":["uri"]},"aws-native:cloudformation:GuardHookStackFiltersPropertiesFilteringCriteria":{"description":"Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match","type":"string","enum":[{"name":"All","value":"ALL"},{"name":"Any","value":"ANY"}]},"aws-native:cloudformation:GuardHookTargetOperation":{"description":"Which operations should this Hook run against? Resource changes, stacks or change sets.","type":"string","enum":[{"name":"Resource","value":"RESOURCE"},{"name":"Stack","value":"STACK"},{"name":"ChangeSet","value":"CHANGE_SET"},{"name":"CloudControl","value":"CLOUD_CONTROL"}]},"aws-native:cloudformation:HookTypeConfigConfigurationAlias":{"description":"An alias by which to refer to this extension configuration data.","type":"string","enum":[{"name":"Default","value":"default"}]},"aws-native:cloudformation:HookVersionLoggingConfig":{"properties":{"logGroupName":{"type":"string","description":"The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers."},"logRoleArn":{"type":"string","description":"The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs."}},"type":"object"},"aws-native:cloudformation:HookVersionVisibility":{"description":"The scope at which the type is visible and usable in CloudFormation operations.\n\nValid values include:\n\nPRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.\n\nPUBLIC: The type is publically visible and usable within any Amazon account.","type":"string","enum":[{"name":"Public","value":"PUBLIC"},{"name":"Private","value":"PRIVATE"}]},"aws-native:cloudformation:LambdaHookAction":{"description":"Target actions are the type of operation hooks will be executed at.","type":"string","enum":[{"name":"Create","value":"CREATE"},{"name":"Update","value":"UPDATE"},{"name":"Delete","value":"DELETE"}]},"aws-native:cloudformation:LambdaHookFailureMode":{"description":"Attribute to specify CloudFormation behavior on hook failure.","type":"string","enum":[{"name":"Fail","value":"FAIL"},{"name":"Warn","value":"WARN"}]},"aws-native:cloudformation:LambdaHookHookStatus":{"description":"Attribute to specify which stacks this hook applies to or should get invoked for","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:cloudformation:LambdaHookHookTarget":{"description":"Hook targets are the destination where hooks will be invoked against.","properties":{"action":{"$ref":"#/types/aws-native:cloudformation:LambdaHookAction"},"invocationPoint":{"$ref":"#/types/aws-native:cloudformation:LambdaHookInvocationPoint"},"targetName":{"type":"string"}},"type":"object","required":["action","invocationPoint","targetName"]},"aws-native:cloudformation:LambdaHookInvocationPoint":{"description":"Invocation points are the point in provisioning workflow where hooks will be executed.","type":"string","enum":[{"name":"PreProvision","value":"PRE_PROVISION"}]},"aws-native:cloudformation:LambdaHookStackFiltersPropertiesFilteringCriteria":{"description":"Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match","type":"string","enum":[{"name":"All","value":"ALL"},{"name":"Any","value":"ANY"}]},"aws-native:cloudformation:LambdaHookTargetOperation":{"description":"Which operations should this Hook run against? Resource changes, stacks or change sets.","type":"string","enum":[{"name":"Resource","value":"RESOURCE"},{"name":"Stack","value":"STACK"},{"name":"ChangeSet","value":"CHANGE_SET"},{"name":"CloudControl","value":"CLOUD_CONTROL"}]},"aws-native:cloudformation:ManagedExecutionProperties":{"description":"Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.","properties":{"active":{"type":"boolean","description":"When `true` , CloudFormation performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, CloudFormation starts queued operations in request order.\n\n\u003e If there are already running or queued operations, CloudFormation queues all incoming operations even if they are non-conflicting.\n\u003e \n\u003e You can't modify your StackSet's execution configuration while there are running or queued operations for that StackSet. \n\nWhen `false` (default), StackSets performs one operation at a time in request order."}},"type":"object"},"aws-native:cloudformation:ModuleVersionVisibility":{"description":"The scope at which the type is visible and usable in CloudFormation operations.\n\nThe only allowed value at present is:\n\nPRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.","type":"string","enum":[{"name":"Private","value":"PRIVATE"}]},"aws-native:cloudformation:OptionsProperties":{"description":"Specifies the S3 location of your input parameters.","properties":{"inputParams":{"$ref":"#/types/aws-native:cloudformation:GuardHookS3Location","description":"Specifies the S3 location where your input parameters are located."}},"type":"object"},"aws-native:cloudformation:PublicTypeVersionType":{"description":"The kind of extension","type":"string","enum":[{"name":"Resource","value":"RESOURCE"},{"name":"Module","value":"MODULE"},{"name":"Hook","value":"HOOK"}]},"aws-native:cloudformation:PublisherIdentityProvider":{"description":"The type of account used as the identity provider when registering this publisher with CloudFormation.","type":"string","enum":[{"name":"AwsMarketplace","value":"AWS_Marketplace"},{"name":"GitHub","value":"GitHub"},{"name":"Bitbucket","value":"Bitbucket"}]},"aws-native:cloudformation:PublisherStatus":{"description":"Whether the publisher is verified.","type":"string","enum":[{"name":"Verified","value":"VERIFIED"},{"name":"Unverified","value":"UNVERIFIED"}]},"aws-native:cloudformation:ResourceVersionLoggingConfig":{"properties":{"logGroupName":{"type":"string","description":"The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers."},"logRoleArn":{"type":"string","description":"The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs."}},"type":"object"},"aws-native:cloudformation:ResourceVersionProvisioningType":{"description":"The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.","type":"string","enum":[{"name":"NonProvisionable","value":"NON_PROVISIONABLE"},{"name":"Immutable","value":"IMMUTABLE"},{"name":"FullyMutable","value":"FULLY_MUTABLE"}]},"aws-native:cloudformation:ResourceVersionVisibility":{"description":"The scope at which the type is visible and usable in CloudFormation operations.\n\nValid values include:\n\nPRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.\n\nPUBLIC: The type is publically visible and usable within any Amazon account.","type":"string","enum":[{"name":"Public","value":"PUBLIC"},{"name":"Private","value":"PRIVATE"}]},"aws-native:cloudformation:StackCapabilitiesItem":{"type":"string","enum":[{"name":"CapabilityIam","value":"CAPABILITY_IAM"},{"name":"CapabilityNamedIam","value":"CAPABILITY_NAMED_IAM"},{"name":"CapabilityAutoExpand","value":"CAPABILITY_AUTO_EXPAND"}]},"aws-native:cloudformation:StackFiltersProperties":{"description":"Filters to allow hooks to target specific stack attributes","properties":{"filteringCriteria":{"$ref":"#/types/aws-native:cloudformation:LambdaHookStackFiltersPropertiesFilteringCriteria","description":"Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match"},"stackNames":{"$ref":"#/types/aws-native:cloudformation:StackFiltersPropertiesStackNamesProperties","description":"List of stack names as filters"},"stackRoles":{"$ref":"#/types/aws-native:cloudformation:StackFiltersPropertiesStackRolesProperties","description":"List of stack roles that are performing the stack operations."}},"type":"object","required":["filteringCriteria"]},"aws-native:cloudformation:StackFiltersPropertiesStackNamesProperties":{"description":"List of stack names as filters","properties":{"exclude":{"type":"array","items":{"type":"string"},"description":"List of stack names that the hook is going to be excluded from"},"include":{"type":"array","items":{"type":"string"},"description":"List of stack names that the hook is going to target"}},"type":"object"},"aws-native:cloudformation:StackFiltersPropertiesStackRolesProperties":{"description":"List of stack roles that are performing the stack operations.","properties":{"exclude":{"type":"array","items":{"type":"string"},"description":"List of stack roles that the hook is going to be excluded from"},"include":{"type":"array","items":{"type":"string"},"description":"List of stack roles that the hook is going to target"}},"type":"object"},"aws-native:cloudformation:StackOutput":{"properties":{"description":{"type":"string","description":"User defined description associated with the output."},"exportName":{"type":"string","description":"The name of the export associated with the output."},"outputKey":{"type":"string","description":"The key associated with the output."},"outputValue":{"type":"string","description":"The value associated with the output."}},"type":"object"},"aws-native:cloudformation:StackSetAutoDeployment":{"properties":{"dependsOn":{"type":"array","items":{"type":"string"},"description":"A list of StackSet ARNs that this StackSet depends on for auto-deployment operations. When auto-deployment is triggered, operations will be sequenced to ensure all dependencies complete successfully before this StackSet's operation begins."},"enabled":{"type":"boolean","description":"If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions."},"retainStacksOnAccountRemoval":{"type":"boolean","description":"If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True."}},"type":"object"},"aws-native:cloudformation:StackSetCallAs":{"description":"Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.","type":"string","enum":[{"name":"Self","value":"SELF"},{"name":"DelegatedAdmin","value":"DELEGATED_ADMIN"}]},"aws-native:cloudformation:StackSetCapability":{"type":"string","enum":[{"name":"CapabilityIam","value":"CAPABILITY_IAM"},{"name":"CapabilityNamedIam","value":"CAPABILITY_NAMED_IAM"},{"name":"CapabilityAutoExpand","value":"CAPABILITY_AUTO_EXPAND"}]},"aws-native:cloudformation:StackSetConcurrencyMode":{"description":"Specifies how the concurrency level behaves during the operation execution.","type":"string","enum":[{"name":"StrictFailureTolerance","value":"STRICT_FAILURE_TOLERANCE"},{"name":"SoftFailureTolerance","value":"SOFT_FAILURE_TOLERANCE"}]},"aws-native:cloudformation:StackSetDeploymentTargets":{"description":" The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.","properties":{"accountFilterType":{"$ref":"#/types/aws-native:cloudformation:StackSetDeploymentTargetsAccountFilterType","description":"The filter type you want to apply on organizational units and accounts."},"accounts":{"type":"array","items":{"type":"string"},"description":"AWS accounts that you want to create stack instances in the specified Region(s) for."},"accountsUrl":{"type":"string","description":"Returns the value of the AccountsUrl property."},"organizationalUnitIds":{"type":"array","items":{"type":"string"},"description":"The organization root ID or organizational unit (OU) IDs to which StackSets deploys."}},"type":"object"},"aws-native:cloudformation:StackSetDeploymentTargetsAccountFilterType":{"description":"The filter type you want to apply on organizational units and accounts.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Union","value":"UNION"},{"name":"Intersection","value":"INTERSECTION"},{"name":"Difference","value":"DIFFERENCE"}]},"aws-native:cloudformation:StackSetOperationPreferences":{"description":"The user-specified preferences for how AWS CloudFormation performs a stack set operation.","properties":{"concurrencyMode":{"$ref":"#/types/aws-native:cloudformation:StackSetConcurrencyMode","description":"Specifies how the concurrency level behaves during the operation execution.\n\n- `STRICT_FAILURE_TOLERANCE` : This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of `FailureToleranceCount` +1. The initial actual concurrency is set to the lower of either the value of the `MaxConcurrentCount` , or the value of `FailureToleranceCount` +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.\n\nIf failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.\n- `SOFT_FAILURE_TOLERANCE` : This option decouples `FailureToleranceCount` from the actual concurrency. This allows StackSet operations to run at the concurrency level set by the `MaxConcurrentCount` value, or `MaxConcurrentPercentage` , regardless of the number of failures."},"failureToleranceCount":{"type":"integer","description":"The number of accounts per Region this operation can fail in before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.\n\nConditional: You must specify either `FailureToleranceCount` or `FailureTolerancePercentage` (but not both)."},"failureTolerancePercentage":{"type":"integer","description":"The percentage of accounts per Region this stack operation can fail in before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.\n\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds *down* to the next whole number.\n\nConditional: You must specify either `FailureToleranceCount` or `FailureTolerancePercentage` , but not both."},"maxConcurrentCount":{"type":"integer","description":"The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of `FailureToleranceCount` . `MaxConcurrentCount` is at most one more than the `FailureToleranceCount` .\n\nNote that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.\n\nConditional: You must specify either `MaxConcurrentCount` or `MaxConcurrentPercentage` , but not both."},"maxConcurrentPercentage":{"type":"integer","description":"The maximum percentage of accounts in which to perform this operation at one time.\n\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.\n\nNote that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.\n\nConditional: You must specify either `MaxConcurrentCount` or `MaxConcurrentPercentage` , but not both."},"regionConcurrencyType":{"$ref":"#/types/aws-native:cloudformation:StackSetRegionConcurrencyType","description":"The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time."},"regionOrder":{"type":"array","items":{"type":"string"},"description":"The order of the Regions where you want to perform the stack operation."}},"type":"object"},"aws-native:cloudformation:StackSetParameter":{"properties":{"parameterKey":{"type":"string","description":"The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template."},"parameterValue":{"type":"string","description":"The input value associated with the parameter."}},"type":"object","required":["parameterKey","parameterValue"]},"aws-native:cloudformation:StackSetPermissionModel":{"description":"Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.","type":"string","enum":[{"name":"ServiceManaged","value":"SERVICE_MANAGED"},{"name":"SelfManaged","value":"SELF_MANAGED"}]},"aws-native:cloudformation:StackSetRegionConcurrencyType":{"description":"The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time","type":"string","enum":[{"name":"Sequential","value":"SEQUENTIAL"},{"name":"Parallel","value":"PARALLEL"}]},"aws-native:cloudformation:StackSetStackInstances":{"description":"Stack instances in some specific accounts and Regions.","properties":{"deploymentTargets":{"$ref":"#/types/aws-native:cloudformation:StackSetDeploymentTargets","description":"The AWS Organizations accounts or AWS accounts to deploy stacks to in the specified Regions."},"parameterOverrides":{"type":"array","items":{"$ref":"#/types/aws-native:cloudformation:StackSetParameter"},"description":"A list of stack set parameters whose values you want to override in the selected stack instances."},"regions":{"type":"array","items":{"type":"string"},"description":"The names of one or more Regions where you want to create stack instances using the specified AWS account(s)."}},"type":"object","required":["deploymentTargets","regions"]},"aws-native:cloudformation:StackSetTag":{"description":"Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation StackSet.","properties":{"key":{"type":"string","description":"A string used to identify this tag. You can specify a maximum of 127 characters for a tag key."},"value":{"type":"string","description":"A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value."}},"type":"object","required":["key","value"]},"aws-native:cloudformation:StackStatus":{"description":"Returns a success or failure message associated with the stack status.","type":"string","enum":[{"name":"CreateInProgress","value":"CREATE_IN_PROGRESS"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"CreateComplete","value":"CREATE_COMPLETE"},{"name":"RollbackInProgress","value":"ROLLBACK_IN_PROGRESS"},{"name":"RollbackFailed","value":"ROLLBACK_FAILED"},{"name":"RollbackComplete","value":"ROLLBACK_COMPLETE"},{"name":"DeleteInProgress","value":"DELETE_IN_PROGRESS"},{"name":"DeleteFailed","value":"DELETE_FAILED"},{"name":"DeleteComplete","value":"DELETE_COMPLETE"},{"name":"UpdateInProgress","value":"UPDATE_IN_PROGRESS"},{"name":"UpdateCompleteCleanupInProgress","value":"UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"},{"name":"UpdateComplete","value":"UPDATE_COMPLETE"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"UpdateRollbackInProgress","value":"UPDATE_ROLLBACK_IN_PROGRESS"},{"name":"UpdateRollbackFailed","value":"UPDATE_ROLLBACK_FAILED"},{"name":"UpdateRollbackCompleteCleanupInProgress","value":"UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"},{"name":"UpdateRollbackComplete","value":"UPDATE_ROLLBACK_COMPLETE"},{"name":"ReviewInProgress","value":"REVIEW_IN_PROGRESS"},{"name":"ImportInProgress","value":"IMPORT_IN_PROGRESS"},{"name":"ImportComplete","value":"IMPORT_COMPLETE"},{"name":"ImportRollbackInProgress","value":"IMPORT_ROLLBACK_IN_PROGRESS"},{"name":"ImportRollbackFailed","value":"IMPORT_ROLLBACK_FAILED"},{"name":"ImportRollbackComplete","value":"IMPORT_ROLLBACK_COMPLETE"}]},"aws-native:cloudformation:StackTag":{"properties":{"key":{"type":"string","description":"A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by AWS have the reserved prefix: `aws:` ."},"value":{"type":"string","description":"A string that contains the value for this tag. You can specify a maximum of 256 characters for a tag value."}},"type":"object","required":["key","value"]},"aws-native:cloudformation:TargetFilters0Properties":{"description":"Attribute to specify which targets should invoke the hook","properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:cloudformation:LambdaHookAction"},"description":"List of actions that the hook is going to target"},"invocationPoints":{"type":"array","items":{"$ref":"#/types/aws-native:cloudformation:LambdaHookInvocationPoint"},"description":"List of invocation points that the hook is going to target"},"targetNames":{"type":"array","items":{"type":"string"},"description":"List of type names that the hook is going to target"}},"type":"object"},"aws-native:cloudformation:TargetFilters1Properties":{"description":"Attribute to specify which targets should invoke the hook","properties":{"targets":{"type":"array","items":{"$ref":"#/types/aws-native:cloudformation:LambdaHookHookTarget"},"description":"List of hook targets"}},"type":"object","required":["targets"]},"aws-native:cloudformation:TypeActivationLoggingConfig":{"properties":{"logGroupName":{"type":"string","description":"The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers."},"logRoleArn":{"type":"string","description":"The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs."}},"type":"object"},"aws-native:cloudformation:TypeActivationType":{"description":"The kind of extension","type":"string","enum":[{"name":"Resource","value":"RESOURCE"},{"name":"Module","value":"MODULE"},{"name":"Hook","value":"HOOK"}]},"aws-native:cloudformation:TypeActivationVersionBump":{"description":"Manually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled","type":"string","enum":[{"name":"Major","value":"MAJOR"},{"name":"Minor","value":"MINOR"}]},"aws-native:cloudfront:CachePolicyConfig":{"description":"A cache policy configuration.\n This configuration determines the following:\n  +  The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.\n  +  The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.\n  If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the ``Cache-Control: no-cache``, ``no-store``, or ``private`` directives are present in the origin headers.\n   \n The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use ``OriginRequestPolicy``.","properties":{"comment":{"type":"string","description":"A comment to describe the cache policy. The comment cannot be longer than 128 characters."},"defaultTtl":{"type":"number","description":"The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object's time to live (TTL) only when the origin does *not* send ``Cache-Control`` or ``Expires`` headers with the object. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\n The default value for this field is 86400 seconds (one day). If the value of ``MinTTL`` is more than 86400 seconds, then the default value for this field is the same as the value of ``MinTTL``."},"maxTtl":{"type":"number","description":"The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends ``Cache-Control`` or ``Expires`` headers with the object. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\n The default value for this field is 31536000 seconds (one year). If the value of ``MinTTL`` or ``DefaultTTL`` is more than 31536000 seconds, then the default value for this field is the same as the value of ``DefaultTTL``."},"minTtl":{"type":"number","description":"The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*."},"name":{"type":"string","description":"A unique name to identify the cache policy."},"parametersInCacheKeyAndForwardedToOrigin":{"$ref":"#/types/aws-native:cloudfront:CachePolicyParametersInCacheKeyAndForwardedToOrigin","description":"The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin."}},"type":"object","required":["defaultTtl","maxTtl","minTtl","name","parametersInCacheKeyAndForwardedToOrigin"]},"aws-native:cloudfront:CachePolicyCookiesConfig":{"description":"An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.","properties":{"cookieBehavior":{"type":"string","description":"Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:\n  +  ``none`` – No cookies in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any cookies that are listed in an ``OriginRequestPolicy``*are* included in origin requests.\n  +  ``whitelist`` – Only the cookies in viewer requests that are listed in the ``CookieNames`` type are included in the cache key and in requests that CloudFront sends to the origin.\n  +  ``allExcept`` – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, *except* for those that are listed in the ``CookieNames`` type, which are not included.\n  +  ``all`` – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin."},"cookies":{"type":"array","items":{"type":"string"},"description":"Contains a list of cookie names."}},"type":"object","required":["cookieBehavior"]},"aws-native:cloudfront:CachePolicyHeadersConfig":{"description":"An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.","properties":{"headerBehavior":{"type":"string","description":"Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:\n  +  ``none`` – No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any headers that are listed in an ``OriginRequestPolicy``*are* included in origin requests.\n  +  ``whitelist`` – Only the HTTP headers that are listed in the ``Headers`` type are included in the cache key and in requests that CloudFront sends to the origin."},"headers":{"type":"array","items":{"type":"string"},"description":"Contains a list of HTTP header names."}},"type":"object","required":["headerBehavior"]},"aws-native:cloudfront:CachePolicyParametersInCacheKeyAndForwardedToOrigin":{"description":"This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.\n The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use ``OriginRequestPolicy``.","properties":{"cookiesConfig":{"$ref":"#/types/aws-native:cloudfront:CachePolicyCookiesConfig","description":"An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin."},"enableAcceptEncodingBrotli":{"type":"boolean","description":"A flag that can affect whether the ``Accept-Encoding`` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.\n This field is related to the ``EnableAcceptEncodingGzip`` field. If one or both of these fields is ``true``*and* the viewer request includes the ``Accept-Encoding`` header, then CloudFront does the following:\n  +  Normalizes the value of the viewer's ``Accept-Encoding`` header\n  +  Includes the normalized header in the cache key\n  +  Includes the normalized header in the request to the origin, if a request is necessary\n  \n For more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*.\n If you set this value to ``true``, and this cache behavior also has an origin request policy attached, do not include the ``Accept-Encoding`` header in the origin request policy. CloudFront always includes the ``Accept-Encoding`` header in origin requests when the value of this field is ``true``, so including this header in an origin request policy has no effect.\n If both of these fields are ``false``, then CloudFront treats the ``Accept-Encoding`` header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add ``Accept-Encoding`` to the headers whitelist like any other HTTP header."},"enableAcceptEncodingGzip":{"type":"boolean","description":"A flag that can affect whether the ``Accept-Encoding`` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.\n This field is related to the ``EnableAcceptEncodingBrotli`` field. If one or both of these fields is ``true``*and* the viewer request includes the ``Accept-Encoding`` header, then CloudFront does the following:\n  +  Normalizes the value of the viewer's ``Accept-Encoding`` header\n  +  Includes the normalized header in the cache key\n  +  Includes the normalized header in the request to the origin, if a request is necessary\n  \n For more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*.\n If you set this value to ``true``, and this cache behavior also has an origin request policy attached, do not include the ``Accept-Encoding`` header in the origin request policy. CloudFront always includes the ``Accept-Encoding`` header in origin requests when the value of this field is ``true``, so including this header in an origin request policy has no effect.\n If both of these fields are ``false``, then CloudFront treats the ``Accept-Encoding`` header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add ``Accept-Encoding`` to the headers whitelist like any other HTTP header."},"headersConfig":{"$ref":"#/types/aws-native:cloudfront:CachePolicyHeadersConfig","description":"An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin."},"queryStringsConfig":{"$ref":"#/types/aws-native:cloudfront:CachePolicyQueryStringsConfig","description":"An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin."}},"type":"object","required":["cookiesConfig","enableAcceptEncodingGzip","headersConfig","queryStringsConfig"]},"aws-native:cloudfront:CachePolicyQueryStringsConfig":{"description":"An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.","properties":{"queryStringBehavior":{"type":"string","description":"Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:\n  +  ``none`` – No query strings in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any query strings that are listed in an ``OriginRequestPolicy``*are* included in origin requests.\n  +  ``whitelist`` – Only the query strings in viewer requests that are listed in the ``QueryStringNames`` type are included in the cache key and in requests that CloudFront sends to the origin.\n  +  ``allExcept`` – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, *except* those that are listed in the ``QueryStringNames`` type, which are not included.\n  +  ``all`` – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin."},"queryStrings":{"type":"array","items":{"type":"string"},"description":"Contains a list of query string names."}},"type":"object","required":["queryStringBehavior"]},"aws-native:cloudfront:CloudFrontOriginAccessIdentityConfig":{"description":"Origin access identity configuration. Send a ``GET`` request to the ``/CloudFront API version/CloudFront/identity ID/config`` resource.","properties":{"comment":{"type":"string","description":"A comment to describe the origin access identity. The comment cannot be longer than 128 characters."}},"type":"object","required":["comment"]},"aws-native:cloudfront:ConnectionFunctionConfig":{"description":"Contains configuration information about a CloudFront function.","properties":{"comment":{"type":"string","description":"A comment to describe the function."},"keyValueStoreAssociations":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:ConnectionFunctionKeyValueStoreAssociation"},"description":"The configuration for the key value store associations."},"runtime":{"$ref":"#/types/aws-native:cloudfront:ConnectionFunctionConfigRuntime","description":"The function's runtime environment version.","replaceOnChanges":true}},"type":"object","required":["comment","runtime"]},"aws-native:cloudfront:ConnectionFunctionConfigRuntime":{"description":"The function's runtime environment version.","type":"string","enum":[{"name":"CloudfrontJs20","value":"cloudfront-js-2.0"}]},"aws-native:cloudfront:ConnectionFunctionKeyValueStoreAssociation":{"description":"The key value store association.","properties":{"keyValueStoreArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the key value store association."}},"type":"object","required":["keyValueStoreArn"]},"aws-native:cloudfront:ConnectionFunctionStage":{"description":"The connection function stage.","type":"string","enum":[{"name":"Development","value":"DEVELOPMENT"},{"name":"Live","value":"LIVE"}]},"aws-native:cloudfront:ConnectionFunctionStatus":{"description":"The connection function status.","type":"string","enum":[{"name":"Unpublished","value":"UNPUBLISHED"},{"name":"Deployed","value":"DEPLOYED"},{"name":"Unassociated","value":"UNASSOCIATED"},{"name":"Publishing","value":"PUBLISHING"},{"name":"InProgress","value":"IN_PROGRESS"}]},"aws-native:cloudfront:ConnectionFunctionTag":{"description":"A complex type that contains ``Tag`` key and ``Tag`` value.","properties":{"key":{"type":"string","description":"A string that contains ``Tag`` key.\n The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``."},"value":{"type":"string","description":"A string that contains an optional ``Tag`` value.\n The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``."}},"type":"object","required":["key","value"]},"aws-native:cloudfront:ConnectionGroupTag":{"description":"A complex type that contains ``Tag`` key and ``Tag`` value.","properties":{"key":{"type":"string","description":"A string that contains ``Tag`` key.\n The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``."},"value":{"type":"string","description":"A string that contains an optional ``Tag`` value.\n The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``."}},"type":"object","required":["key","value"]},"aws-native:cloudfront:ContinuousDeploymentPolicyConfig":{"description":"Contains the configuration for a continuous deployment policy.","properties":{"enabled":{"type":"boolean","description":"A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is ``true``, this policy is enabled and in effect. When this value is ``false``, this policy is not enabled and has no effect."},"singleHeaderPolicyConfig":{"$ref":"#/types/aws-native:cloudfront:ContinuousDeploymentPolicyConfigSingleHeaderPolicyConfigProperties","description":"This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution."},"singleWeightPolicyConfig":{"$ref":"#/types/aws-native:cloudfront:ContinuousDeploymentPolicyConfigSingleWeightPolicyConfigProperties","description":"This configuration determines the percentage of HTTP requests that are sent to the staging distribution."},"stagingDistributionDnsNames":{"type":"array","items":{"type":"string"},"description":"The CloudFront domain name of the staging distribution. For example: ``d111111abcdef8.cloudfront.net``."},"trafficConfig":{"$ref":"#/types/aws-native:cloudfront:ContinuousDeploymentPolicyTrafficConfig","description":"Contains the parameters for routing production traffic from your primary to staging distributions."},"type":{"$ref":"#/types/aws-native:cloudfront:ContinuousDeploymentPolicyConfigType","description":"The type of traffic configuration."}},"type":"object","required":["enabled","stagingDistributionDnsNames"]},"aws-native:cloudfront:ContinuousDeploymentPolicyConfigSingleHeaderPolicyConfigProperties":{"description":"This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.","properties":{"header":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["header","value"]},"aws-native:cloudfront:ContinuousDeploymentPolicyConfigSingleWeightPolicyConfigProperties":{"description":"This configuration determines the percentage of HTTP requests that are sent to the staging distribution.","properties":{"sessionStickinessConfig":{"$ref":"#/types/aws-native:cloudfront:ContinuousDeploymentPolicySessionStickinessConfig"},"weight":{"type":"number"}},"type":"object","required":["weight"]},"aws-native:cloudfront:ContinuousDeploymentPolicyConfigType":{"description":"The type of traffic configuration.","type":"string","enum":[{"name":"SingleWeight","value":"SingleWeight"},{"name":"SingleHeader","value":"SingleHeader"}]},"aws-native:cloudfront:ContinuousDeploymentPolicySessionStickinessConfig":{"description":"Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.","properties":{"idleTtl":{"type":"integer","description":"The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes)."},"maximumTtl":{"type":"integer","description":"The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes)."}},"type":"object","required":["idleTtl","maximumTtl"]},"aws-native:cloudfront:ContinuousDeploymentPolicySingleHeaderConfig":{"description":"Determines which HTTP requests are sent to the staging distribution.","properties":{"header":{"type":"string","description":"The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix ``aws-cf-cd-``."},"value":{"type":"string","description":"The request header value."}},"type":"object","required":["header","value"]},"aws-native:cloudfront:ContinuousDeploymentPolicySingleWeightConfig":{"description":"This configuration determines the percentage of HTTP requests that are sent to the staging distribution.","properties":{"sessionStickinessConfig":{"$ref":"#/types/aws-native:cloudfront:ContinuousDeploymentPolicySessionStickinessConfig","description":"Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values."},"weight":{"type":"number","description":"The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution."}},"type":"object","required":["weight"]},"aws-native:cloudfront:ContinuousDeploymentPolicyTrafficConfig":{"description":"The traffic configuration of your continuous deployment.","properties":{"singleHeaderConfig":{"$ref":"#/types/aws-native:cloudfront:ContinuousDeploymentPolicySingleHeaderConfig","description":"Determines which HTTP requests are sent to the staging distribution."},"singleWeightConfig":{"$ref":"#/types/aws-native:cloudfront:ContinuousDeploymentPolicySingleWeightConfig","description":"Contains the percentage of traffic to send to the staging distribution."},"type":{"$ref":"#/types/aws-native:cloudfront:ContinuousDeploymentPolicyTrafficConfigType","description":"The type of traffic configuration."}},"type":"object","required":["type"]},"aws-native:cloudfront:ContinuousDeploymentPolicyTrafficConfigType":{"description":"The type of traffic configuration.","type":"string","enum":[{"name":"SingleWeight","value":"SingleWeight"},{"name":"SingleHeader","value":"SingleHeader"}]},"aws-native:cloudfront:DistributionCacheBehavior":{"description":"A complex type that describes how CloudFront processes requests.\n You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.\n For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see [Quotas](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html) in the *Amazon CloudFront Developer Guide*.\n If you don't want to specify any cache behaviors, include only an empty ``CacheBehaviors`` element. Don't specify an empty individual ``CacheBehavior`` element, because this is invalid. For more information, see [CacheBehaviors](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CacheBehaviors.html). \n To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty ``CacheBehaviors`` element.\n To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.\n  If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the ``Cache-Control: no-cache``, ``no-store``, or ``private`` directives are present in the origin headers.\n  For more information about cache behaviors, see [Cache Behavior Settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior) in the *Amazon CloudFront Developer Guide*.","properties":{"allowedMethods":{"type":"array","items":{"type":"string"},"description":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:\n  +  CloudFront forwards only ``GET`` and ``HEAD`` requests.\n  +  CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n  +  CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests.\n  \n If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin."},"cachePolicyId":{"type":"string","description":"The unique identifier of the cache policy that is attached to this cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``."},"cachedMethods":{"type":"array","items":{"type":"string"},"description":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:\n  +  CloudFront caches responses to ``GET`` and ``HEAD`` requests.\n  +  CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n  \n If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly."},"compress":{"type":"boolean","description":"Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*."},"defaultTtl":{"type":"number","description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*."},"fieldLevelEncryptionId":{"type":"string","description":"The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior."},"forwardedValues":{"$ref":"#/types/aws-native:cloudfront:DistributionForwardedValues","description":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers."},"functionAssociations":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:DistributionFunctionAssociation"},"description":"A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior."},"grpcConfig":{"$ref":"#/types/aws-native:cloudfront:DistributionGrpcConfig","description":"The gRPC configuration for your cache behavior."},"lambdaFunctionAssociations":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:DistributionLambdaFunctionAssociation"},"description":"A complex type that contains zero or more Lambda@Edge function associations for a cache behavior."},"maxTtl":{"type":"number","description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*."},"minTtl":{"type":"number","description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\n You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``)."},"originRequestPolicyId":{"type":"string","description":"The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*."},"pathPattern":{"type":"string","description":"The pattern (for example, ``images/*.jpg``) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.\n  You can optionally include a slash (``/``) at the beginning of the path pattern. For example, ``/images/*.jpg``. CloudFront behavior is the same with or without the leading ``/``.\n  The path pattern for the default cache behavior is ``*`` and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.\n For more information, see [Path Pattern](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) in the *Amazon CloudFront Developer Guide*."},"realtimeLogConfigArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*."},"responseHeadersPolicyId":{"type":"string","description":"The identifier for a response headers policy."},"smoothStreaming":{"type":"boolean","description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``."},"targetOriginId":{"type":"string","description":"The value of ``ID`` for the origin that you want CloudFront to route requests to when they match this cache behavior."},"trustedKeyGroups":{"type":"array","items":{"type":"string"},"description":"A list of key groups that CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*."},"trustedSigners":{"type":"array","items":{"type":"string"},"description":"We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``.\n   This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*."},"viewerProtocolPolicy":{"type":"string","description":"The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options:\n  +  ``allow-all``: Viewers can use HTTP or HTTPS.\n  +  ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.\n  +  ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).\n  \n For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*.\n  The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*."}},"type":"object","required":["pathPattern","targetOriginId","viewerProtocolPolicy"]},"aws-native:cloudfront:DistributionConfig":{"description":"A distribution configuration.","properties":{"aliases":{"type":"array","items":{"type":"string"},"description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution."},"anycastIpListId":{"type":"string","description":"To use this field for a multi-tenant distribution, use a connection group instead. For more information, see [ConnectionGroup](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ConnectionGroup.html).\n  ID of the Anycast static IP list that is associated with the distribution."},"cacheBehaviors":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:DistributionCacheBehavior"},"description":"A complex type that contains zero or more ``CacheBehavior`` elements."},"cnames":{"type":"array","items":{"type":"string"},"description":"An alias for the CF distribution's domain name.\n  This property is legacy. We recommend that you use [Aliases](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-aliases) instead."},"comment":{"type":"string","description":"A comment to describe the distribution. The comment cannot be longer than 128 characters."},"connectionFunctionAssociation":{"$ref":"#/types/aws-native:cloudfront:DistributionConnectionFunctionAssociation","description":"The distribution's connection function association."},"connectionMode":{"$ref":"#/types/aws-native:cloudfront:DistributionConnectionMode","description":"This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only)."},"continuousDeploymentPolicyId":{"type":"string","description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``."},"customErrorResponses":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:DistributionCustomErrorResponse"},"description":"A complex type that controls the following:\n  +  Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.\n  +  How long CloudFront caches HTTP status codes in the 4xx and 5xx range.\n  \n For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*."},"customOrigin":{"$ref":"#/types/aws-native:cloudfront:DistributionLegacyCustomOrigin","description":"The user-defined HTTP server that serves as the origin for content that CF distributes.\n  This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead."},"defaultCacheBehavior":{"$ref":"#/types/aws-native:cloudfront:DistributionDefaultCacheBehavior","description":"A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior."},"defaultRootObject":{"type":"string","description":"When a viewer requests the root URL for your distribution, the default root object is the object that you want CloudFront to request from your origin. For example, if your root URL is ``https://www.example.com``, you can specify CloudFront to return the ``index.html`` file as the default root object. You can specify a default root object so that viewers see a specific file or object, instead of another object in your distribution (for example, ``https://www.example.com/product-description.html``). A default root object avoids exposing the contents of your distribution.\n You can specify the object name or a path to the object name (for example, ``index.html`` or ``exampleFolderName/index.html``). Your string can't begin with a forward slash (``/``). Only specify the object name or the path to the object.\n If you don't want to specify a default root object when you create a distribution, include an empty ``DefaultRootObject`` element.\n To delete the default root object from an existing distribution, update the distribution configuration and include an empty ``DefaultRootObject`` element.\n To replace the default root object, update the distribution configuration and specify the new object.\n For more information about the default root object, see [Specify a default root object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*."},"enabled":{"type":"boolean","description":"From this field, you can enable or disable the selected distribution."},"httpVersion":{"type":"string","description":"(Optional) Specify the HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``.\n For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI).\n For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://docs.aws.amazon.com/https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html)."},"ipv6Enabled":{"type":"boolean","description":"To use this field for a multi-tenant distribution, use a connection group instead. For more information, see [ConnectionGroup](https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ConnectionGroup.html).\n  If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.\n In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*.\n If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:\n  +  You enable IPv6 for the distribution\n  +  You're using alternate domain names in the URLs for your objects\n  \n For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Developer Guide*.\n If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request."},"logging":{"$ref":"#/types/aws-native:cloudfront:DistributionLogging","description":"A complex type that controls whether access logs are written for the distribution.\n For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*."},"originGroups":{"$ref":"#/types/aws-native:cloudfront:DistributionOriginGroups","description":"A complex type that contains information about origin groups for this distribution.\n Specify a value for either the ``Origins`` or ``OriginGroups`` property."},"origins":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:DistributionOrigin"},"description":"A complex type that contains information about origins for this distribution.\n Specify a value for either the ``Origins`` or ``OriginGroups`` property."},"priceClass":{"type":"string","description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations.\n If you specify a price class other than ``PriceClass_All``, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.\n For more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see [Amazon CloudFront Pricing](https://docs.aws.amazon.com/cloudfront/pricing/)."},"restrictions":{"$ref":"#/types/aws-native:cloudfront:DistributionRestrictions","description":"A complex type that identifies ways in which you want to restrict distribution of your content."},"s3Origin":{"$ref":"#/types/aws-native:cloudfront:DistributionLegacyS3Origin","description":"The origin as an S3 bucket.\n  This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead."},"staging":{"type":"boolean","description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution."},"tenantConfig":{"$ref":"#/types/aws-native:cloudfront:DistributionConfigTenantConfigProperties","description":"This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  A distribution tenant configuration."},"viewerCertificate":{"$ref":"#/types/aws-native:cloudfront:DistributionViewerCertificate","description":"A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers."},"viewerMtlsConfig":{"$ref":"#/types/aws-native:cloudfront:DistributionViewerMtlsConfig","description":"The distribution's viewer mTLS configuration."},"webAclId":{"type":"string","description":"Multi-tenant distributions only support WAF V2 web ACLs.\n  A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``a1b2c3d4-5678-90ab-cdef-EXAMPLE11111``.\n WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html)."}},"type":"object","required":["defaultCacheBehavior","enabled"]},"aws-native:cloudfront:DistributionConfigTenantConfigProperties":{"description":"This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  A distribution tenant configuration.","properties":{"parameterDefinitions":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:DistributionParameterDefinition"}}},"type":"object"},"aws-native:cloudfront:DistributionConnectionFunctionAssociation":{"description":"A connection function association.","properties":{"id":{"type":"string","description":"The association's ID."}},"type":"object","required":["id"]},"aws-native:cloudfront:DistributionConnectionMode":{"type":"string","enum":[{"name":"Direct","value":"direct"},{"name":"TenantOnly","value":"tenant-only"}]},"aws-native:cloudfront:DistributionCookies":{"description":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*.","properties":{"forward":{"type":"string","description":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the ``WhitelistedNames`` complex type.\n Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the ``Forward`` element."},"whitelistedNames":{"type":"array","items":{"type":"string"},"description":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Required if you specify ``whitelist`` for the value of ``Forward``. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.\n If you specify ``all`` or ``none`` for the value of ``Forward``, omit ``WhitelistedNames``. If you change the value of ``Forward`` from ``whitelist`` to ``all`` or ``none`` and you don't delete the ``WhitelistedNames`` element and its child elements, CloudFront deletes them automatically.\n For the current limit on the number of cookie names that you can whitelist for each cache behavior, see [CloudFront Limits](https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront) in the *General Reference*."}},"type":"object","required":["forward"]},"aws-native:cloudfront:DistributionCustomErrorResponse":{"description":"A complex type that controls:\n  +  Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.\n  +  How long CloudFront caches HTTP status codes in the 4xx and 5xx range.\n  \n For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.","properties":{"errorCachingMinTtl":{"type":"number","description":"The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ``ErrorCode``. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.\n For more information, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*."},"errorCode":{"type":"integer","description":"The HTTP status code for which you want to specify a custom error page and/or a caching duration."},"responseCode":{"type":"integer","description":"The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:\n  +  Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute ``200``, the response typically won't be intercepted.\n  +  If you don't care about distinguishing among different client errors or server errors, you can specify ``400`` or ``500`` as the ``ResponseCode`` for all 4xx or 5xx errors.\n  +  You might want to return a ``200`` status code (OK) and static website so your customers don't know that your website is down.\n  \n If you specify a value for ``ResponseCode``, you must also specify a value for ``ResponsePagePath``."},"responsePagePath":{"type":"string","description":"The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ``ErrorCode``, for example, ``/4xx-errors/403-forbidden.html``. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:\n  +  The value of ``PathPattern`` matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named ``/4xx-errors``. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, ``/4xx-errors/*``.\n  +  The value of ``TargetOriginId`` specifies the value of the ``ID`` element for the origin that contains your custom error pages.\n  \n If you specify a value for ``ResponsePagePath``, you must also specify a value for ``ResponseCode``.\n We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable."}},"type":"object","required":["errorCode"]},"aws-native:cloudfront:DistributionCustomOriginConfig":{"description":"A custom origin. A custom origin is any origin that is *not* an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)*is* a custom origin.","properties":{"httpPort":{"type":"integer","description":"The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on."},"httpsPort":{"type":"integer","description":"The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on."},"ipAddressType":{"$ref":"#/types/aws-native:cloudfront:DistributionCustomOriginConfigIpAddressType","description":"Specifies which IP protocol CloudFront uses when connecting to your origin. If your origin uses both IPv4 and IPv6 protocols, you can choose ``dualstack`` to help optimize reliability."},"originKeepaliveTimeout":{"type":"integer","description":"Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds.\n For more information, see [Keep-alive timeout (custom origins only)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*."},"originMtlsConfig":{"$ref":"#/types/aws-native:cloudfront:DistributionOriginMtlsConfig","description":"Configures mutual TLS authentication between CloudFront and your origin server."},"originProtocolPolicy":{"type":"string","description":"Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:\n  +  ``http-only`` – CloudFront always uses HTTP to connect to the origin.\n  +  ``match-viewer`` – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.\n  +  ``https-only`` – CloudFront always uses HTTPS to connect to the origin."},"originReadTimeout":{"type":"integer","description":"Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.\n For more information, see [Response timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*."},"originSslProtocols":{"type":"array","items":{"type":"string"},"description":"Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``.\n For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*."}},"type":"object","required":["originProtocolPolicy"]},"aws-native:cloudfront:DistributionCustomOriginConfigIpAddressType":{"description":"Specifies which IP protocol CloudFront uses when connecting to your origin. If your origin uses both IPv4 and IPv6 protocols, you can choose ``dualstack`` to help optimize reliability.","type":"string","enum":[{"name":"Ipv4","value":"ipv4"},{"name":"Ipv6","value":"ipv6"},{"name":"Dualstack","value":"dualstack"}]},"aws-native:cloudfront:DistributionDefaultCacheBehavior":{"description":"A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if request URLs don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior.\n  If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the ``Cache-Control: no-cache``, ``no-store``, or ``private`` directives are present in the origin headers.","properties":{"allowedMethods":{"type":"array","items":{"type":"string"},"description":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:\n  +  CloudFront forwards only ``GET`` and ``HEAD`` requests.\n  +  CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n  +  CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests.\n  \n If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin."},"cachePolicyId":{"type":"string","description":"The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``."},"cachedMethods":{"type":"array","items":{"type":"string"},"description":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:\n  +  CloudFront caches responses to ``GET`` and ``HEAD`` requests.\n  +  CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests.\n  \n If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly."},"compress":{"type":"boolean","description":"Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify ``true``; if not, specify ``false``. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*."},"defaultTtl":{"type":"number","description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*."},"fieldLevelEncryptionId":{"type":"string","description":"The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior."},"forwardedValues":{"$ref":"#/types/aws-native:cloudfront:DistributionForwardedValues","description":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.\n A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers."},"functionAssociations":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:DistributionFunctionAssociation"},"description":"A list of CloudFront functions that are associated with this cache behavior. Your functions must be published to the ``LIVE`` stage to associate them with a cache behavior."},"grpcConfig":{"$ref":"#/types/aws-native:cloudfront:DistributionGrpcConfig","description":"The gRPC configuration for your cache behavior."},"lambdaFunctionAssociations":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:DistributionLambdaFunctionAssociation"},"description":"A complex type that contains zero or more Lambda@Edge function associations for a cache behavior."},"maxTtl":{"type":"number","description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*."},"minTtl":{"type":"number","description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*.\n The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.\n You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``)."},"originRequestPolicyId":{"type":"string","description":"The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*."},"realtimeLogConfigArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*."},"responseHeadersPolicyId":{"type":"string","description":"The identifier for a response headers policy."},"smoothStreaming":{"type":"boolean","description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``."},"targetOriginId":{"type":"string","description":"The value of ``ID`` for the origin that you want CloudFront to route requests to when they use the default cache behavior."},"trustedKeyGroups":{"type":"array","items":{"type":"string"},"description":"A list of key groups that CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*."},"trustedSigners":{"type":"array","items":{"type":"string"},"description":"We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``.\n   This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.\n When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*."},"viewerProtocolPolicy":{"type":"string","description":"The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options:\n  +  ``allow-all``: Viewers can use HTTP or HTTPS.\n  +  ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.\n  +  ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).\n  \n For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*.\n  The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*."}},"type":"object","required":["targetOriginId","viewerProtocolPolicy"]},"aws-native:cloudfront:DistributionForwardedValues":{"description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n  This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.","properties":{"cookies":{"$ref":"#/types/aws-native:cloudfront:DistributionCookies","description":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*."},"headers":{"type":"array","items":{"type":"string"},"description":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include headers in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.\n For more information, see [Caching Content Based on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*."},"queryString":{"type":"boolean","description":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of ``QueryString`` and on the values that you specify for ``QueryStringCacheKeys``, if any:\n If you specify true for ``QueryString`` and you don't specify any values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.\n If you specify true for ``QueryString`` and you specify one or more values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.\n If you specify false for ``QueryString``, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.\n For more information, see [Configuring CloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*."},"queryStringCacheKeys":{"type":"array","items":{"type":"string"},"description":"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.\n If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*.\n If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.\n A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior."}},"type":"object","required":["queryString"]},"aws-native:cloudfront:DistributionFunctionAssociation":{"description":"A CloudFront function that is associated with a cache behavior in a CloudFront distribution.","properties":{"eventType":{"type":"string","description":"The event type of the function, either ``viewer-request`` or ``viewer-response``. You cannot use origin-facing event types (``origin-request`` and ``origin-response``) with a CloudFront function."},"functionArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the function."}},"type":"object"},"aws-native:cloudfront:DistributionGeoRestriction":{"description":"A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template.","properties":{"locations":{"type":"array","items":{"type":"string"},"description":"A complex type that contains a ``Location`` element for each country in which you want CloudFront either to distribute your content (``whitelist``) or not distribute your content (``blacklist``).\n The ``Location`` element is a two-letter, uppercase country code for a country that you want to include in your ``blacklist`` or ``whitelist``. Include one ``Location`` element for each country.\n CloudFront and ``MaxMind`` both use ``ISO 3166`` country codes. For the current list of countries and the corresponding codes, see ``ISO 3166-1-alpha-2`` code on the *International Organization for Standardization* website. You can also refer to the country list on the CloudFront console, which includes both country names and codes."},"restrictionType":{"type":"string","description":"The method that you want to use to restrict distribution of your content by country:\n  +  ``none``: No geo restriction is enabled, meaning access to content is not restricted by client geo location.\n  +  ``blacklist``: The ``Location`` elements specify the countries in which you don't want CloudFront to distribute your content.\n  +  ``whitelist``: The ``Location`` elements specify the countries in which you want CloudFront to distribute your content."}},"type":"object","required":["restrictionType"]},"aws-native:cloudfront:DistributionGrpcConfig":{"description":"Amazon CloudFront supports gRPC, an open-source remote procedure call (RPC) framework built on HTTP/2. gRPC offers bi-directional streaming and binary protocol that buffers payloads, making it suitable for applications that require low latency communications.\n To enable your distribution to handle gRPC requests, you must include HTTP/2 as one of the supported ``HTTP`` versions and allow ``HTTP`` methods, including ``POST``.\n For more information, see [Using gRPC with CloudFront distributions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-using-grpc.html) in the *Amazon CloudFront Developer Guide*.","properties":{"enabled":{"type":"boolean","description":"Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins."}},"type":"object","required":["enabled"]},"aws-native:cloudfront:DistributionLambdaFunctionAssociation":{"description":"A complex type that contains a Lambda@Edge function association.","properties":{"eventType":{"type":"string","description":"Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values:\n  +  ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.\n  +  ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute.\n  +  ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.\n  +  ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.\n If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute."},"includeBody":{"type":"boolean","description":"A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see [Accessing the Request Body by Choosing the Include Body Option](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide."},"lambdaFunctionArn":{"type":"string","description":"The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST."}},"type":"object"},"aws-native:cloudfront:DistributionLegacyCustomOrigin":{"description":"A custom origin. A custom origin is any origin that is *not* an S3 bucket, with one exception. An S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)*is* a custom origin.\n  This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.","properties":{"dnsName":{"type":"string","description":"The domain name assigned to your CF distribution."},"httpPort":{"type":"integer","description":"The HTTP port that CF uses to connect to the origin. Specify the HTTP port that the origin listens on."},"httpsPort":{"type":"integer","description":"The HTTPS port that CF uses to connect to the origin. Specify the HTTPS port that the origin listens on."},"originProtocolPolicy":{"type":"string","description":"Specifies the protocol (HTTP or HTTPS) that CF uses to connect to the origin."},"originSslProtocols":{"type":"array","items":{"type":"string"},"description":"The minimum SSL/TLS protocol version that CF uses when communicating with your origin server over HTTPs.\n For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Developer Guide*."}},"type":"object","required":["dnsName","originProtocolPolicy","originSslProtocols"]},"aws-native:cloudfront:DistributionLegacyS3Origin":{"description":"The origin as an S3 bucket. \n  This property is legacy. We recommend that you use [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) instead.","properties":{"dnsName":{"type":"string","description":"The domain name assigned to your CF distribution."},"originAccessIdentity":{"type":"string","description":"The CF origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an S3 through CF.\n  This property is legacy. We recommend that you use [OriginAccessControl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html) instead."}},"type":"object","required":["dnsName"]},"aws-native:cloudfront:DistributionLogging":{"description":"A complex type that specifies whether access logs are written for the distribution.\n  If you already enabled standard logging (legacy) and you want to enable standard logging (v2) to send your access logs to Amazon S3, we recommend that you specify a *different* Amazon S3 bucket or use a *separate path* in the same bucket (for example, use a log prefix or partitioning). This helps you keep track of which log files are associated with which logging subscription and prevents log files from overwriting each other. For more information, see [Standard logging (access logs)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*.","properties":{"bucket":{"type":"string","description":"The Amazon S3 bucket to store the access logs in, for example, ``amzn-s3-demo-bucket.s3.amazonaws.com``."},"includeCookies":{"type":"boolean","description":"Specifies whether you want CloudFront to include cookies in access logs, specify ``true`` for ``IncludeCookies``. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify ``false`` for ``IncludeCookies``."},"prefix":{"type":"string","description":"An optional string that you want CloudFront to prefix to the access log ``filenames`` for this distribution, for example, ``myprefix/``. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty ``Prefix`` element in the ``Logging`` element."}},"type":"object"},"aws-native:cloudfront:DistributionOrigin":{"description":"An origin.\n An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:\n  +  Use ``S3OriginConfig`` to specify an Amazon S3 bucket that is not configured with static website hosting.\n  +  Use ``VpcOriginConfig`` to specify a VPC origin.\n  +  Use ``CustomOriginConfig`` to specify all other kinds of origins, including:\n  +  An Amazon S3 bucket that is configured with static website hosting\n  +  An Elastic Load Balancing load balancer\n  +  An EMPlong endpoint\n  +  An EMSlong container\n  +  Any other HTTP server, running on an Amazon EC2 instance or any other kind of host\n  \n  \n For the current maximum number of origins that you can specify per distribution, see [General Quotas on Web Distributions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions) in the *Amazon CloudFront Developer Guide* (quotas were formerly referred to as limits).","properties":{"connectionAttempts":{"type":"integer","description":"The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.\n For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout).\n For more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*."},"connectionTimeout":{"type":"integer","description":"The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.\n For more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*."},"customOriginConfig":{"$ref":"#/types/aws-native:cloudfront:DistributionCustomOriginConfig","description":"Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the ``S3OriginConfig`` type instead."},"domainName":{"type":"string","description":"The domain name for the origin.\n For more information, see [Origin Domain Name](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName) in the *Amazon CloudFront Developer Guide*."},"id":{"type":"string","description":"A unique identifier for the origin. This value must be unique within the distribution.\n Use this value to specify the ``TargetOriginId`` in a ``CacheBehavior`` or ``DefaultCacheBehavior``."},"originAccessControlId":{"type":"string","description":"The unique identifier of an origin access control for this origin.\n For more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*."},"originCustomHeaders":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:DistributionOriginCustomHeader"},"description":"A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.\n For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) in the *Amazon CloudFront Developer Guide*."},"originPath":{"type":"string","description":"An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.\n For more information, see [Origin Path](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) in the *Amazon CloudFront Developer Guide*."},"originShield":{"$ref":"#/types/aws-native:cloudfront:DistributionOriginShield","description":"CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.\n For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*."},"responseCompletionTimeout":{"type":"integer","description":"The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection.\n The value for ``ResponseCompletionTimeout`` must be equal to or greater than the value for ``OriginReadTimeout``. If you don't set a value for ``ResponseCompletionTimeout``, CloudFront doesn't enforce a maximum value.\n For more information, see [Response completion timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#response-completion-timeout) in the *Amazon CloudFront Developer Guide*."},"s3OriginConfig":{"$ref":"#/types/aws-native:cloudfront:DistributionS3OriginConfig","description":"Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the ``CustomOriginConfig`` type instead."},"vpcOriginConfig":{"$ref":"#/types/aws-native:cloudfront:DistributionVpcOriginConfig","description":"The VPC origin configuration."}},"type":"object","required":["domainName","id"]},"aws-native:cloudfront:DistributionOriginCustomHeader":{"description":"A complex type that contains ``HeaderName`` and ``HeaderValue`` elements, if any, for this distribution.","properties":{"headerName":{"type":"string","description":"The name of a header that you want CloudFront to send to your origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) in the *Amazon CloudFront Developer Guide*."},"headerValue":{"type":"string","description":"The value for the header that you specified in the ``HeaderName`` field."}},"type":"object","required":["headerName","headerValue"]},"aws-native:cloudfront:DistributionOriginGroup":{"description":"An origin group includes two origins (a primary origin and a secondary origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the secondary origin under the failover conditions that you've chosen.\n Optionally, you can choose selection criteria for your origin group to specify how your origins are selected when your distribution routes viewer requests.","properties":{"failoverCriteria":{"$ref":"#/types/aws-native:cloudfront:DistributionOriginGroupFailoverCriteria","description":"A complex type that contains information about the failover criteria for an origin group."},"id":{"type":"string","description":"The origin group's ID."},"members":{"$ref":"#/types/aws-native:cloudfront:DistributionOriginGroupMembers","description":"A complex type that contains information about the origins in an origin group."},"selectionCriteria":{"$ref":"#/types/aws-native:cloudfront:DistributionOriginGroupSelectionCriteria","description":"The selection criteria for the origin group. For more information, see [Create an origin group](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/high_availability_origin_failover.html#concept_origin_groups.creating) in the *Amazon CloudFront Developer Guide*."}},"type":"object","required":["failoverCriteria","id","members"]},"aws-native:cloudfront:DistributionOriginGroupFailoverCriteria":{"description":"A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.","properties":{"statusCodes":{"$ref":"#/types/aws-native:cloudfront:DistributionStatusCodes","description":"The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin."}},"type":"object","required":["statusCodes"]},"aws-native:cloudfront:DistributionOriginGroupMember":{"description":"An origin in an origin group.","properties":{"originId":{"type":"string","description":"The ID for an origin in an origin group."}},"type":"object","required":["originId"]},"aws-native:cloudfront:DistributionOriginGroupMembers":{"description":"A complex data type for the origins included in an origin group.","properties":{"items":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:DistributionOriginGroupMember"},"description":"Items (origins) in an origin group."},"quantity":{"type":"integer","description":"The number of origins in an origin group."}},"type":"object","required":["items","quantity"]},"aws-native:cloudfront:DistributionOriginGroupSelectionCriteria":{"type":"string","enum":[{"name":"Default","value":"default"},{"name":"MediaQualityBased","value":"media-quality-based"}]},"aws-native:cloudfront:DistributionOriginGroups":{"description":"A complex data type for the origin groups specified for a distribution.","properties":{"items":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:DistributionOriginGroup"},"description":"The items (origin groups) in a distribution."},"quantity":{"type":"integer","description":"The number of origin groups."}},"type":"object","required":["quantity"]},"aws-native:cloudfront:DistributionOriginMtlsConfig":{"description":"Configures mutual TLS authentication between CloudFront and your origin server.","properties":{"clientCertificateArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the client certificate stored in AWS Certificate Manager (ACM) that CloudFront uses to authenticate with your origin using Mutual TLS."}},"type":"object","required":["clientCertificateArn"]},"aws-native:cloudfront:DistributionOriginShield":{"description":"CloudFront Origin Shield.\n Using Origin Shield can help reduce the load on your origin. For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*.","properties":{"enabled":{"type":"boolean","description":"A flag that specifies whether Origin Shield is enabled.\n When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches."},"originShieldRegion":{"type":"string","description":"The AWS-Region for Origin Shield.\n Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as ``us-east-2``.\n When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see [Choosing the for Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) in the *Amazon CloudFront Developer Guide*."}},"type":"object"},"aws-native:cloudfront:DistributionParameterDefinition":{"description":"A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.","properties":{"definition":{"$ref":"#/types/aws-native:cloudfront:DistributionParameterDefinitionDefinitionProperties","description":"The value that you assigned to the parameter."},"name":{"type":"string","description":"The name of the parameter."}},"type":"object","required":["definition","name"]},"aws-native:cloudfront:DistributionParameterDefinitionDefinitionProperties":{"description":"The value that you assigned to the parameter.","properties":{"stringSchema":{"$ref":"#/types/aws-native:cloudfront:DistributionParameterDefinitionDefinitionPropertiesStringSchemaProperties"}},"type":"object"},"aws-native:cloudfront:DistributionParameterDefinitionDefinitionPropertiesStringSchemaProperties":{"properties":{"comment":{"type":"string"},"defaultValue":{"type":"string"},"required":{"type":"boolean"}},"type":"object","required":["required"]},"aws-native:cloudfront:DistributionRestrictions":{"description":"A complex type that identifies ways in which you want to restrict distribution of your content.","properties":{"geoRestriction":{"$ref":"#/types/aws-native:cloudfront:DistributionGeoRestriction","description":"A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template."}},"type":"object","required":["geoRestriction"]},"aws-native:cloudfront:DistributionS3OriginConfig":{"description":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the ``CustomOriginConfig`` element instead.","properties":{"originAccessIdentity":{"type":"string","description":"If you're using origin access control (OAC) instead of origin access identity, specify an empty ``OriginAccessIdentity`` element. For more information, see [Restricting access to an](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*.\n  The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is:\n  ``origin-access-identity/cloudfront/ID-of-origin-access-identity`` \n The ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity.\n If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ``OriginAccessIdentity`` element.\n To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ``OriginAccessIdentity`` element.\n To replace the origin access identity, update the distribution configuration and specify the new origin access identity.\n For more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*."},"originReadTimeout":{"type":"integer","description":"Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.\n For more information, see [Response timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*."}},"type":"object"},"aws-native:cloudfront:DistributionStatusCodes":{"description":"A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.","properties":{"items":{"type":"array","items":{"type":"integer"},"description":"The items (status codes) for an origin group."},"quantity":{"type":"integer","description":"The number of status codes."}},"type":"object","required":["items","quantity"]},"aws-native:cloudfront:DistributionTag":{"description":"A complex type that contains ``Tag`` key and ``Tag`` value.","properties":{"key":{"type":"string","description":"A string that contains ``Tag`` key.\n The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``."},"value":{"type":"string","description":"A string that contains an optional ``Tag`` value.\n The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``."}},"type":"object","required":["key","value"]},"aws-native:cloudfront:DistributionTenantCertificate":{"description":"The ACMlong (ACM) certificate associated with your distribution.","properties":{"arn":{"type":"string","description":"The Amazon Resource Name (ARN) of the ACM certificate."}},"type":"object"},"aws-native:cloudfront:DistributionTenantCustomizations":{"description":"Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.","properties":{"certificate":{"$ref":"#/types/aws-native:cloudfront:DistributionTenantCertificate","description":"The ACMlong (ACM) certificate."},"geoRestrictions":{"$ref":"#/types/aws-native:cloudfront:DistributionTenantGeoRestrictionCustomization","description":"The geographic restrictions."},"webAcl":{"$ref":"#/types/aws-native:cloudfront:DistributionTenantWebAclCustomization","description":"The WAF web ACL."}},"type":"object"},"aws-native:cloudfront:DistributionTenantDomainResult":{"description":"The details about the domain result.","properties":{"domain":{"type":"string","description":"The specified domain."},"status":{"$ref":"#/types/aws-native:cloudfront:DistributionTenantDomainResultStatus","description":"Whether the domain is active or inactive."}},"type":"object"},"aws-native:cloudfront:DistributionTenantDomainResultStatus":{"description":"Whether the domain is active or inactive.","type":"string","enum":[{"name":"Active","value":"active"},{"name":"Inactive","value":"inactive"}]},"aws-native:cloudfront:DistributionTenantGeoRestrictionCustomization":{"description":"The customizations that you specified for the distribution tenant for geographic restrictions.","properties":{"locations":{"type":"array","items":{"type":"string"},"description":"The locations for geographic restrictions."},"restrictionType":{"$ref":"#/types/aws-native:cloudfront:DistributionTenantGeoRestrictionCustomizationRestrictionType","description":"The method that you want to use to restrict distribution of your content by country:\n  +  ``none``: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.\n  +  ``blacklist``: The ``Location`` elements specify the countries in which you don't want CloudFront to distribute your content.\n  +  ``whitelist``: The ``Location`` elements specify the countries in which you want CloudFront to distribute your content."}},"type":"object"},"aws-native:cloudfront:DistributionTenantGeoRestrictionCustomizationRestrictionType":{"description":"The method that you want to use to restrict distribution of your content by country:\n  +  ``none``: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.\n  +  ``blacklist``: The ``Location`` elements specify the countries in which you don't want CloudFront to distribute your content.\n  +  ``whitelist``: The ``Location`` elements specify the countries in which you want CloudFront to distribute your content.","type":"string","enum":[{"name":"Blacklist","value":"blacklist"},{"name":"Whitelist","value":"whitelist"},{"name":"None","value":"none"}]},"aws-native:cloudfront:DistributionTenantManagedCertificateRequest":{"description":"An object that represents the request for the Amazon CloudFront managed ACM certificate.","properties":{"certificateTransparencyLoggingPreference":{"$ref":"#/types/aws-native:cloudfront:DistributionTenantManagedCertificateRequestCertificateTransparencyLoggingPreference","description":"You can opt out of certificate transparency logging by specifying the ``disabled`` option. Opt in by specifying ``enabled``. For more information, see [Certificate Transparency Logging](https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency) in the *User Guide*."},"primaryDomainName":{"type":"string","description":"The primary domain name associated with the CloudFront managed ACM certificate."},"validationTokenHost":{"$ref":"#/types/aws-native:cloudfront:DistributionTenantManagedCertificateRequestValidationTokenHost","description":"Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.\n  +  For ``cloudfront``, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.\n  +  For ``self-hosted``, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront."}},"type":"object"},"aws-native:cloudfront:DistributionTenantManagedCertificateRequestCertificateTransparencyLoggingPreference":{"description":"You can opt out of certificate transparency logging by specifying the ``disabled`` option. Opt in by specifying ``enabled``. For more information, see [Certificate Transparency Logging](https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency) in the *User Guide*.","type":"string","enum":[{"name":"Enabled","value":"enabled"},{"name":"Disabled","value":"disabled"}]},"aws-native:cloudfront:DistributionTenantManagedCertificateRequestValidationTokenHost":{"description":"Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.\n  +  For ``cloudfront``, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.\n  +  For ``self-hosted``, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.","type":"string","enum":[{"name":"Cloudfront","value":"cloudfront"},{"name":"SelfHosted","value":"self-hosted"}]},"aws-native:cloudfront:DistributionTenantParameter":{"description":"A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.","properties":{"name":{"type":"string","description":"The parameter name."},"value":{"type":"string","description":"The parameter value."}},"type":"object"},"aws-native:cloudfront:DistributionTenantTag":{"description":"A complex type that contains ``Tag`` key and ``Tag`` value.","properties":{"key":{"type":"string","description":"A string that contains ``Tag`` key.\n The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``."},"value":{"type":"string","description":"A string that contains an optional ``Tag`` value.\n The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``."}},"type":"object","required":["key","value"]},"aws-native:cloudfront:DistributionTenantWebAclCustomization":{"description":"The WAF web ACL customization specified for the distribution tenant.","properties":{"action":{"$ref":"#/types/aws-native:cloudfront:DistributionTenantWebAclCustomizationAction","description":"The action for the WAF web ACL customization. You can specify ``override`` to specify a separate WAF web ACL for the distribution tenant. If you specify ``disable``, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution."},"arn":{"type":"string","description":"The Amazon Resource Name (ARN) of the WAF web ACL."}},"type":"object"},"aws-native:cloudfront:DistributionTenantWebAclCustomizationAction":{"description":"The action for the WAF web ACL customization. You can specify ``override`` to specify a separate WAF web ACL for the distribution tenant. If you specify ``disable``, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.","type":"string","enum":[{"name":"Override","value":"override"},{"name":"Disable","value":"disable"}]},"aws-native:cloudfront:DistributionTrustStoreConfig":{"description":"A trust store configuration.","properties":{"advertiseTrustStoreCaNames":{"type":"boolean","description":"The configuration to use to advertise trust store CA names."},"ignoreCertificateExpiry":{"type":"boolean","description":"The configuration to use to ignore certificate expiration."},"trustStoreId":{"type":"string","description":"The trust store ID."}},"type":"object","required":["trustStoreId"]},"aws-native:cloudfront:DistributionViewerCertificate":{"description":"A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.\n If the distribution doesn't use ``Aliases`` (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``—set ``CloudFrontDefaultCertificate`` to ``true`` and leave all other fields empty.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:\n  +  Which viewers the distribution accepts HTTPS connections from: only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers including those that don't support SNI.\n  +  To accept HTTPS connections from only viewers that support SNI, set ``SSLSupportMethod`` to ``sni-only``. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n  +  To accept HTTPS connections from all viewers, including those that don't support SNI, set ``SSLSupportMethod`` to ``vip``. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n  \n  +  The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for ``MinimumProtocolVersion``. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) in the *Amazon CloudFront Developer Guide*.\n  +  The location of the SSL/TLS certificate, [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by setting a value in one of the following fields (not both):\n  +  ``ACMCertificateArn`` (In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.)\n  +  ``IAMCertificateId`` (In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.)\n  \n  \n All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ``ViewerProtocolPolicy`` in the ``CacheBehavior`` or ``DefaultCacheBehavior``. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use ``CustomOriginConfig``.\n For more information, see [Using HTTPS with CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) and [Using Alternate Domain Names and HTTPS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the *Amazon CloudFront Developer Guide*.","properties":{"acmCertificateArn":{"type":"string","description":"In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.\n  If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (``us-east-1``).\n If you specify an ACM certificate ARN, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)"},"cloudFrontDefaultCertificate":{"type":"boolean","description":"If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, set this field to ``true``.\n If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), omit this field and specify values for the following fields:\n  +  ``AcmCertificateArn`` or ``IamCertificateId`` (specify a value for one, not both) \n  +   ``MinimumProtocolVersion`` \n  +   ``SslSupportMethod``"},"iamCertificateId":{"type":"string","description":"This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see [Unsupported features for SaaS Manager for Amazon CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html#unsupported-saas) in the *Amazon CloudFront Developer Guide*.\n   In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.\n  If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), provide the ID of the IAM certificate.\n If you specify an IAM certificate ID, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)"},"minimumProtocolVersion":{"type":"string","description":"If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:\n  +  The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.\n  +  The ciphers that CloudFront can use to encrypt the content that it returns to viewers.\n  \n For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*.\n  On the CloudFront console, this setting is called *Security Policy*.\n  When you're using SNI only (you set ``SSLSupportMethod`` to ``sni-only``), you must specify ``TLSv1`` or higher. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)\n If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net`` (you set ``CloudFrontDefaultCertificate`` to ``true``), CloudFront automatically sets the security policy to ``TLSv1`` regardless of the value that you set here."},"sslSupportMethod":{"type":"string","description":"In CloudFormation, this field name is ``SslSupportMethod``. Note the different capitalization.\n  If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.\n  +  ``sni-only`` – The distribution accepts HTTPS connections from only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication). This is recommended. Most browsers and clients support SNI.\n  +  ``vip`` – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.\n  +  ``static-ip`` - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [Center](https://docs.aws.amazon.com/support/home).\n  \n If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, don't set a value for this field."}},"type":"object"},"aws-native:cloudfront:DistributionViewerMtlsConfig":{"description":"A viewer mTLS configuration.","properties":{"mode":{"$ref":"#/types/aws-native:cloudfront:DistributionViewerMtlsMode","description":"The viewer mTLS mode."},"trustStoreConfig":{"$ref":"#/types/aws-native:cloudfront:DistributionTrustStoreConfig","description":"The trust store configuration associated with the viewer mTLS configuration."}},"type":"object"},"aws-native:cloudfront:DistributionViewerMtlsMode":{"type":"string","enum":[{"name":"Required","value":"required"},{"name":"Optional","value":"optional"}]},"aws-native:cloudfront:DistributionVpcOriginConfig":{"description":"An Amazon CloudFront VPC origin configuration.","properties":{"originKeepaliveTimeout":{"type":"integer","description":"Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds.\n For more information, see [Keep-alive timeout (custom origins only)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*."},"originReadTimeout":{"type":"integer","description":"Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.\n For more information, see [Response timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*."},"ownerAccountId":{"type":"string","description":"The account ID of the AWS-account that owns the VPC origin."},"vpcOriginId":{"type":"string","description":"The VPC origin ID."}},"type":"object","required":["vpcOriginId"]},"aws-native:cloudfront:FunctionConfig":{"description":"Contains configuration information about a CloudFront function.","properties":{"comment":{"type":"string","description":"A comment to describe the function."},"keyValueStoreAssociations":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:FunctionKeyValueStoreAssociation"},"description":"The configuration for the key value store associations."},"runtime":{"type":"string","description":"The function's runtime environment version."}},"type":"object","required":["comment","runtime"]},"aws-native:cloudfront:FunctionKeyValueStoreAssociation":{"description":"The key value store association.","properties":{"keyValueStoreArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the key value store association."}},"type":"object","required":["keyValueStoreArn"]},"aws-native:cloudfront:FunctionMetadata":{"description":"Contains metadata about a CloudFront function.","properties":{"functionArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function."}},"type":"object"},"aws-native:cloudfront:KeyGroupConfig":{"description":"A key group configuration.\n A key group contains a list of public keys that you can use with [CloudFront signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html).","properties":{"comment":{"type":"string","description":"A comment to describe the key group. The comment cannot be longer than 128 characters."},"items":{"type":"array","items":{"type":"string"},"description":"A list of the identifiers of the public keys in the key group."},"name":{"type":"string","description":"A name to identify the key group."}},"type":"object","required":["items","name"]},"aws-native:cloudfront:KeyValueStoreImportSource":{"description":"The import source for the key value store.","properties":{"sourceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the import source for the key value store."},"sourceType":{"type":"string","description":"The source type of the import source for the key value store."}},"type":"object","required":["sourceArn","sourceType"]},"aws-native:cloudfront:KeyValueStoreTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:cloudfront:MonitoringSubscription":{"description":"A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.","properties":{"realtimeMetricsSubscriptionConfig":{"$ref":"#/types/aws-native:cloudfront:MonitoringSubscriptionRealtimeMetricsSubscriptionConfig","description":"A subscription configuration for additional CloudWatch metrics."}},"type":"object"},"aws-native:cloudfront:MonitoringSubscriptionRealtimeMetricsSubscriptionConfig":{"description":"A subscription configuration for additional CloudWatch metrics.","properties":{"realtimeMetricsSubscriptionStatus":{"$ref":"#/types/aws-native:cloudfront:MonitoringSubscriptionRealtimeMetricsSubscriptionConfigRealtimeMetricsSubscriptionStatus","description":"A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution."}},"type":"object","required":["realtimeMetricsSubscriptionStatus"]},"aws-native:cloudfront:MonitoringSubscriptionRealtimeMetricsSubscriptionConfigRealtimeMetricsSubscriptionStatus":{"description":"A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution.","type":"string","enum":[{"name":"Enabled","value":"Enabled"},{"name":"Disabled","value":"Disabled"}]},"aws-native:cloudfront:OriginAccessControlConfig":{"description":"Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.\n This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.\n For more information about using a CloudFront origin access control, see [Restricting access to an origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html) in the *Amazon CloudFront Developer Guide*.","properties":{"description":{"type":"string","description":"A description of the origin access control."},"name":{"type":"string","description":"A name to identify the origin access control. You can specify up to 64 characters."},"originAccessControlOriginType":{"type":"string","description":"The type of origin that this origin access control is for."},"signingBehavior":{"type":"string","description":"Specifies which requests CloudFront signs (adds authentication information to). Specify ``always`` for the most common use case. For more information, see [origin access control advanced settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings) in the *Amazon CloudFront Developer Guide*.\n This field can have one of the following values:\n  +  ``always`` – CloudFront signs all origin requests, overwriting the ``Authorization`` header from the viewer request if one exists.\n  +  ``never`` – CloudFront doesn't sign any origin requests. This value turns off origin access control for all origins in all distributions that use this origin access control.\n  +  ``no-override`` – If the viewer request doesn't contain the ``Authorization`` header, then CloudFront signs the origin request. If the viewer request contains the ``Authorization`` header, then CloudFront doesn't sign the origin request and instead passes along the ``Authorization`` header from the viewer request. *WARNING: To pass along the Authorization header from the viewer request, you must add the Authorization header to a cache policy for all cache behaviors that use origins associated with this origin access control.*"},"signingProtocol":{"type":"string","description":"The signing protocol of the origin access control, which determines how CloudFront signs (authenticates) requests. The only valid value is ``sigv4``."}},"type":"object","required":["name","originAccessControlOriginType","signingBehavior","signingProtocol"]},"aws-native:cloudfront:OriginRequestPolicyConfig":{"description":"An origin request policy configuration.\n This configuration determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:\n  +  The request body and the URL path (without the domain name) from the viewer request.\n  +  The headers that CloudFront automatically includes in every origin request, including ``Host``, ``User-Agent``, and ``X-Amz-Cf-Id``.\n  +  All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.\n  \n CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use ``CachePolicy``.","properties":{"comment":{"type":"string","description":"A comment to describe the origin request policy. The comment cannot be longer than 128 characters."},"cookiesConfig":{"$ref":"#/types/aws-native:cloudfront:OriginRequestPolicyCookiesConfig","description":"The cookies from viewer requests to include in origin requests."},"headersConfig":{"$ref":"#/types/aws-native:cloudfront:OriginRequestPolicyHeadersConfig","description":"The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront."},"name":{"type":"string","description":"A unique name to identify the origin request policy."},"queryStringsConfig":{"$ref":"#/types/aws-native:cloudfront:OriginRequestPolicyQueryStringsConfig","description":"The URL query strings from viewer requests to include in origin requests."}},"type":"object","required":["cookiesConfig","headersConfig","name","queryStringsConfig"]},"aws-native:cloudfront:OriginRequestPolicyCookiesConfig":{"description":"An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in requests that CloudFront sends to the origin.","properties":{"cookieBehavior":{"type":"string","description":"Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:\n  +  ``none`` – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any cookies that are listed in a ``CachePolicy``*are* included in origin requests.\n  +  ``whitelist`` – Only the cookies in viewer requests that are listed in the ``CookieNames`` type are included in requests that CloudFront sends to the origin.\n  +  ``all`` – All cookies in viewer requests are included in requests that CloudFront sends to the origin.\n  +  ``allExcept`` – All cookies in viewer requests are included in requests that CloudFront sends to the origin, *except* for those listed in the ``CookieNames`` type, which are not included."},"cookies":{"type":"array","items":{"type":"string"},"description":"Contains a list of cookie names."}},"type":"object","required":["cookieBehavior"]},"aws-native:cloudfront:OriginRequestPolicyHeadersConfig":{"description":"An object that determines whether any HTTP headers (and if so, which headers) are included in requests that CloudFront sends to the origin.","properties":{"headerBehavior":{"type":"string","description":"Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:\n  +  ``none`` – No HTTP headers in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any headers that are listed in a ``CachePolicy``*are* included in origin requests.\n  +  ``whitelist`` – Only the HTTP headers that are listed in the ``Headers`` type are included in requests that CloudFront sends to the origin.\n  +  ``allViewer`` – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.\n  +  ``allViewerAndWhitelistCloudFront`` – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the ``Headers`` type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.\n  +  ``allExcept`` – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, *except* for those listed in the ``Headers`` type, which are not included."},"headers":{"type":"array","items":{"type":"string"},"description":"Contains a list of HTTP header names."}},"type":"object","required":["headerBehavior"]},"aws-native:cloudfront:OriginRequestPolicyQueryStringsConfig":{"description":"An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in requests that CloudFront sends to the origin.","properties":{"queryStringBehavior":{"type":"string","description":"Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:\n  +  ``none`` – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to ``none``, any query strings that are listed in a ``CachePolicy``*are* included in origin requests.\n  +  ``whitelist`` – Only the query strings in viewer requests that are listed in the ``QueryStringNames`` type are included in requests that CloudFront sends to the origin.\n  +  ``all`` – All query strings in viewer requests are included in requests that CloudFront sends to the origin.\n  +  ``allExcept`` – All query strings in viewer requests are included in requests that CloudFront sends to the origin, *except* for those listed in the ``QueryStringNames`` type, which are not included."},"queryStrings":{"type":"array","items":{"type":"string"},"description":"Contains a list of query string names."}},"type":"object","required":["queryStringBehavior"]},"aws-native:cloudfront:PublicKeyConfig":{"description":"Configuration information about a public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html).\n CloudFront supports signed URLs and signed cookies with RSA 2048 or ECDSA 256 key signatures. Field-level encryption is only compatible with RSA 2048 key signatures.","properties":{"callerReference":{"type":"string","description":"A string included in the request to help make sure that the request can't be replayed."},"comment":{"type":"string","description":"A comment to describe the public key. The comment cannot be longer than 128 characters."},"encodedKey":{"type":"string","description":"The public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html)."},"name":{"type":"string","description":"A name to help identify the public key."}},"type":"object","required":["callerReference","encodedKey","name"]},"aws-native:cloudfront:RealtimeLogConfigEndPoint":{"description":"Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.","properties":{"kinesisStreamConfig":{"$ref":"#/types/aws-native:cloudfront:RealtimeLogConfigKinesisStreamConfig","description":"Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration."},"streamType":{"type":"string","description":"The type of data stream where you are sending real-time log data. The only valid value is ``Kinesis``."}},"type":"object","required":["kinesisStreamConfig","streamType"]},"aws-native:cloudfront:RealtimeLogConfigKinesisStreamConfig":{"description":"Contains information about the Amazon Kinesis data stream where you are sending real-time log data.","properties":{"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an IAMlong (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.\n For more information the IAM role, see [Real-time log configuration IAM role](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-iam-role) in the *Amazon CloudFront Developer Guide*."},"streamArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data."}},"type":"object","required":["roleArn","streamArn"]},"aws-native:cloudfront:ResponseHeadersPolicyAccessControlAllowHeaders":{"description":"A list of HTTP header names that CloudFront includes as values for the ``Access-Control-Allow-Headers`` HTTP response header.\n For more information about the ``Access-Control-Allow-Headers`` HTTP response header, see [Access-Control-Allow-Headers](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) in the MDN Web Docs.","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The list of HTTP header names. You can specify ``*`` to allow all headers."}},"type":"object","required":["items"]},"aws-native:cloudfront:ResponseHeadersPolicyAccessControlAllowMethods":{"description":"A list of HTTP methods that CloudFront includes as values for the ``Access-Control-Allow-Methods`` HTTP response header.\n For more information about the ``Access-Control-Allow-Methods`` HTTP response header, see [Access-Control-Allow-Methods](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) in the MDN Web Docs.","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The list of HTTP methods. Valid values are:\n  +   ``GET`` \n  +   ``DELETE`` \n  +   ``HEAD`` \n  +   ``OPTIONS`` \n  +   ``PATCH`` \n  +   ``POST`` \n  +   ``PUT`` \n  +   ``ALL`` \n  \n ``ALL`` is a special value that includes all of the listed HTTP methods."}},"type":"object","required":["items"]},"aws-native:cloudfront:ResponseHeadersPolicyAccessControlAllowOrigins":{"description":"A list of origins (domain names) that CloudFront can use as the value for the ``Access-Control-Allow-Origin`` HTTP response header.\n For more information about the ``Access-Control-Allow-Origin`` HTTP response header, see [Access-Control-Allow-Origin](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) in the MDN Web Docs.","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The list of origins (domain names). You can specify ``*`` to allow all origins."}},"type":"object","required":["items"]},"aws-native:cloudfront:ResponseHeadersPolicyAccessControlExposeHeaders":{"description":"A list of HTTP headers that CloudFront includes as values for the ``Access-Control-Expose-Headers`` HTTP response header.\n For more information about the ``Access-Control-Expose-Headers`` HTTP response header, see [Access-Control-Expose-Headers](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) in the MDN Web Docs.","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The list of HTTP headers. You can specify ``*`` to expose all headers."}},"type":"object","required":["items"]},"aws-native:cloudfront:ResponseHeadersPolicyConfig":{"description":"A response headers policy configuration.\n A response headers policy configuration contains metadata about the response headers policy, and configurations for sets of HTTP response headers.","properties":{"comment":{"type":"string","description":"A comment to describe the response headers policy.\n The comment cannot be longer than 128 characters."},"corsConfig":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyCorsConfig","description":"A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS)."},"customHeadersConfig":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyCustomHeadersConfig","description":"A configuration for a set of custom HTTP response headers."},"name":{"type":"string","description":"A name to identify the response headers policy.\n The name must be unique for response headers policies in this AWS-account."},"removeHeadersConfig":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyRemoveHeadersConfig","description":"A configuration for a set of HTTP headers to remove from the HTTP response."},"securityHeadersConfig":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicySecurityHeadersConfig","description":"A configuration for a set of security-related HTTP response headers."},"serverTimingHeadersConfig":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyServerTimingHeadersConfig","description":"A configuration for enabling the ``Server-Timing`` header in HTTP responses sent from CloudFront."}},"type":"object","required":["name"]},"aws-native:cloudfront:ResponseHeadersPolicyContentSecurityPolicy":{"description":"The policy directives and their values that CloudFront includes as values for the ``Content-Security-Policy`` HTTP response header.\n For more information about the ``Content-Security-Policy`` HTTP response header, see [Content-Security-Policy](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) in the MDN Web Docs.","properties":{"contentSecurityPolicy":{"type":"string","description":"The policy directives and their values that CloudFront includes as values for the ``Content-Security-Policy`` HTTP response header.\n For more information about the ``Content-Security-Policy`` HTTP response header, see [Content-Security-Policy](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) in the MDN Web Docs."},"override":{"type":"boolean","description":"A Boolean that determines whether CloudFront overrides the ``Content-Security-Policy`` HTTP response header received from the origin with the one specified in this response headers policy."}},"type":"object","required":["contentSecurityPolicy","override"]},"aws-native:cloudfront:ResponseHeadersPolicyContentTypeOptions":{"description":"Determines whether CloudFront includes the ``X-Content-Type-Options`` HTTP response header with its value set to ``nosniff``.\n For more information about the ``X-Content-Type-Options`` HTTP response header, see [X-Content-Type-Options](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options) in the MDN Web Docs.","properties":{"override":{"type":"boolean","description":"A Boolean that determines whether CloudFront overrides the ``X-Content-Type-Options`` HTTP response header received from the origin with the one specified in this response headers policy."}},"type":"object","required":["override"]},"aws-native:cloudfront:ResponseHeadersPolicyCorsConfig":{"description":"A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS). CloudFront adds these headers to HTTP responses that it sends for CORS requests that match a cache behavior associated with this response headers policy.\n For more information about CORS, see [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) in the MDN Web Docs.","properties":{"accessControlAllowCredentials":{"type":"boolean","description":"A Boolean that CloudFront uses as the value for the ``Access-Control-Allow-Credentials`` HTTP response header.\n For more information about the ``Access-Control-Allow-Credentials`` HTTP response header, see [Access-Control-Allow-Credentials](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials) in the MDN Web Docs."},"accessControlAllowHeaders":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyAccessControlAllowHeaders","description":"A list of HTTP header names that CloudFront includes as values for the ``Access-Control-Allow-Headers`` HTTP response header.\n For more information about the ``Access-Control-Allow-Headers`` HTTP response header, see [Access-Control-Allow-Headers](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers) in the MDN Web Docs."},"accessControlAllowMethods":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyAccessControlAllowMethods","description":"A list of HTTP methods that CloudFront includes as values for the ``Access-Control-Allow-Methods`` HTTP response header.\n For more information about the ``Access-Control-Allow-Methods`` HTTP response header, see [Access-Control-Allow-Methods](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods) in the MDN Web Docs."},"accessControlAllowOrigins":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyAccessControlAllowOrigins","description":"A list of origins (domain names) that CloudFront can use as the value for the ``Access-Control-Allow-Origin`` HTTP response header.\n For more information about the ``Access-Control-Allow-Origin`` HTTP response header, see [Access-Control-Allow-Origin](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) in the MDN Web Docs."},"accessControlExposeHeaders":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyAccessControlExposeHeaders","description":"A list of HTTP headers that CloudFront includes as values for the ``Access-Control-Expose-Headers`` HTTP response header.\n For more information about the ``Access-Control-Expose-Headers`` HTTP response header, see [Access-Control-Expose-Headers](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers) in the MDN Web Docs."},"accessControlMaxAgeSec":{"type":"integer","description":"A number that CloudFront uses as the value for the ``Access-Control-Max-Age`` HTTP response header.\n For more information about the ``Access-Control-Max-Age`` HTTP response header, see [Access-Control-Max-Age](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age) in the MDN Web Docs."},"originOverride":{"type":"boolean","description":"A Boolean that determines whether CloudFront overrides HTTP response headers received from the origin with the ones specified in this response headers policy."}},"type":"object","required":["accessControlAllowCredentials","accessControlAllowHeaders","accessControlAllowMethods","accessControlAllowOrigins","originOverride"]},"aws-native:cloudfront:ResponseHeadersPolicyCustomHeader":{"description":"An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that's associated with this response headers policy.","properties":{"header":{"type":"string","description":"The HTTP response header name."},"override":{"type":"boolean","description":"A Boolean that determines whether CloudFront overrides a response header with the same name received from the origin with the header specified here."},"value":{"type":"string","description":"The value for the HTTP response header."}},"type":"object","required":["header","override","value"]},"aws-native:cloudfront:ResponseHeadersPolicyCustomHeadersConfig":{"description":"A list of HTTP response header names and their values. CloudFront includes these headers in HTTP responses that it sends for requests that match a cache behavior that's associated with this response headers policy.","properties":{"items":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyCustomHeader"},"description":"The list of HTTP response headers and their values."}},"type":"object","required":["items"]},"aws-native:cloudfront:ResponseHeadersPolicyFrameOptions":{"description":"Determines whether CloudFront includes the ``X-Frame-Options`` HTTP response header and the header's value.\n For more information about the ``X-Frame-Options`` HTTP response header, see [X-Frame-Options](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs.","properties":{"frameOption":{"type":"string","description":"The value of the ``X-Frame-Options`` HTTP response header. Valid values are ``DENY`` and ``SAMEORIGIN``.\n For more information about these values, see [X-Frame-Options](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs."},"override":{"type":"boolean","description":"A Boolean that determines whether CloudFront overrides the ``X-Frame-Options`` HTTP response header received from the origin with the one specified in this response headers policy."}},"type":"object","required":["frameOption","override"]},"aws-native:cloudfront:ResponseHeadersPolicyReferrerPolicy":{"description":"Determines whether CloudFront includes the ``Referrer-Policy`` HTTP response header and the header's value.\n For more information about the ``Referrer-Policy`` HTTP response header, see [Referrer-Policy](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs.","properties":{"override":{"type":"boolean","description":"A Boolean that determines whether CloudFront overrides the ``Referrer-Policy`` HTTP response header received from the origin with the one specified in this response headers policy."},"referrerPolicy":{"type":"string","description":"Determines whether CloudFront includes the ``Referrer-Policy`` HTTP response header and the header's value.\n For more information about the ``Referrer-Policy`` HTTP response header, see [Referrer-Policy](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs."}},"type":"object","required":["override","referrerPolicy"]},"aws-native:cloudfront:ResponseHeadersPolicyRemoveHeader":{"description":"The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to.","properties":{"header":{"type":"string","description":"The HTTP header name."}},"type":"object","required":["header"]},"aws-native:cloudfront:ResponseHeadersPolicyRemoveHeadersConfig":{"description":"A list of HTTP header names that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to.","properties":{"items":{"type":"array","items":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyRemoveHeader"},"description":"The list of HTTP header names."}},"type":"object","required":["items"]},"aws-native:cloudfront:ResponseHeadersPolicySecurityHeadersConfig":{"description":"A configuration for a set of security-related HTTP response headers. CloudFront adds these headers to HTTP responses that it sends for requests that match a cache behavior associated with this response headers policy.","properties":{"contentSecurityPolicy":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyContentSecurityPolicy","description":"The policy directives and their values that CloudFront includes as values for the ``Content-Security-Policy`` HTTP response header.\n For more information about the ``Content-Security-Policy`` HTTP response header, see [Content-Security-Policy](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) in the MDN Web Docs."},"contentTypeOptions":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyContentTypeOptions","description":"Determines whether CloudFront includes the ``X-Content-Type-Options`` HTTP response header with its value set to ``nosniff``.\n For more information about the ``X-Content-Type-Options`` HTTP response header, see [X-Content-Type-Options](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options) in the MDN Web Docs."},"frameOptions":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyFrameOptions","description":"Determines whether CloudFront includes the ``X-Frame-Options`` HTTP response header and the header's value.\n For more information about the ``X-Frame-Options`` HTTP response header, see [X-Frame-Options](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs."},"referrerPolicy":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyReferrerPolicy","description":"Determines whether CloudFront includes the ``Referrer-Policy`` HTTP response header and the header's value.\n For more information about the ``Referrer-Policy`` HTTP response header, see [Referrer-Policy](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs."},"strictTransportSecurity":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyStrictTransportSecurity","description":"Determines whether CloudFront includes the ``Strict-Transport-Security`` HTTP response header and the header's value.\n For more information about the ``Strict-Transport-Security`` HTTP response header, see [Security headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/understanding-response-headers-policies.html#understanding-response-headers-policies-security) in the *Amazon CloudFront Developer Guide* and [Strict-Transport-Security](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs."},"xssProtection":{"$ref":"#/types/aws-native:cloudfront:ResponseHeadersPolicyXssProtection","description":"Determines whether CloudFront includes the ``X-XSS-Protection`` HTTP response header and the header's value.\n For more information about the ``X-XSS-Protection`` HTTP response header, see [X-XSS-Protection](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs."}},"type":"object"},"aws-native:cloudfront:ResponseHeadersPolicyServerTimingHeadersConfig":{"description":"A configuration for enabling the ``Server-Timing`` header in HTTP responses sent from CloudFront.","properties":{"enabled":{"type":"boolean","description":"A Boolean that determines whether CloudFront adds the ``Server-Timing`` header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy."},"samplingRate":{"type":"number","description":"A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the ``Server-Timing`` header to. When you set the sampling rate to 100, CloudFront adds the ``Server-Timing`` header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places."}},"type":"object","required":["enabled"]},"aws-native:cloudfront:ResponseHeadersPolicyStrictTransportSecurity":{"description":"Determines whether CloudFront includes the ``Strict-Transport-Security`` HTTP response header and the header's value.\n For more information about the ``Strict-Transport-Security`` HTTP response header, see [Strict-Transport-Security](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs.","properties":{"accessControlMaxAgeSec":{"type":"integer","description":"A number that CloudFront uses as the value for the ``max-age`` directive in the ``Strict-Transport-Security`` HTTP response header."},"includeSubdomains":{"type":"boolean","description":"A Boolean that determines whether CloudFront includes the ``includeSubDomains`` directive in the ``Strict-Transport-Security`` HTTP response header."},"override":{"type":"boolean","description":"A Boolean that determines whether CloudFront overrides the ``Strict-Transport-Security`` HTTP response header received from the origin with the one specified in this response headers policy."},"preload":{"type":"boolean","description":"A Boolean that determines whether CloudFront includes the ``preload`` directive in the ``Strict-Transport-Security`` HTTP response header."}},"type":"object","required":["accessControlMaxAgeSec","override"]},"aws-native:cloudfront:ResponseHeadersPolicyXssProtection":{"description":"Determines whether CloudFront includes the ``X-XSS-Protection`` HTTP response header and the header's value.\n For more information about the ``X-XSS-Protection`` HTTP response header, see [X-XSS-Protection](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs.","properties":{"modeBlock":{"type":"boolean","description":"A Boolean that determines whether CloudFront includes the ``mode=block`` directive in the ``X-XSS-Protection`` header.\n For more information about this directive, see [X-XSS-Protection](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs."},"override":{"type":"boolean","description":"A Boolean that determines whether CloudFront overrides the ``X-XSS-Protection`` HTTP response header received from the origin with the one specified in this response headers policy."},"protection":{"type":"boolean","description":"A Boolean that determines the value of the ``X-XSS-Protection`` HTTP response header. When this setting is ``true``, the value of the ``X-XSS-Protection`` header is ``1``. When this setting is ``false``, the value of the ``X-XSS-Protection`` header is ``0``.\n For more information about these settings, see [X-XSS-Protection](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs."},"reportUri":{"type":"string","description":"A reporting URI, which CloudFront uses as the value of the ``report`` directive in the ``X-XSS-Protection`` header.\n You cannot specify a ``ReportUri`` when ``ModeBlock`` is ``true``.\n For more information about using a reporting URL, see [X-XSS-Protection](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs."}},"type":"object","required":["override","protection"]},"aws-native:cloudfront:TrustStoreCaCertificatesBundleS3Location":{"description":"The CA certificates bundle location in Amazon S3.","properties":{"bucket":{"type":"string","description":"The S3 bucket."},"key":{"type":"string","description":"The location's key."},"region":{"type":"string","description":"The location's Region."},"version":{"type":"string","description":"The location's version."}},"type":"object","required":["bucket","key","region"]},"aws-native:cloudfront:TrustStoreCaCertificatesBundleSource":{"description":"A CA certificates bundle source.","properties":{"caCertificatesBundleS3Location":{"$ref":"#/types/aws-native:cloudfront:TrustStoreCaCertificatesBundleS3Location","description":"The CA certificates bundle location in Amazon S3."}},"type":"object","required":["caCertificatesBundleS3Location"]},"aws-native:cloudfront:TrustStoreStatus":{"description":"The trust store's status.","type":"string","enum":[{"name":"Pending","value":"PENDING"},{"name":"Active","value":"ACTIVE"},{"name":"Failed","value":"FAILED"}]},"aws-native:cloudfront:TrustStoreTag":{"description":"A complex type that contains ``Tag`` key and ``Tag`` value.","properties":{"key":{"type":"string","description":"A string that contains ``Tag`` key.\n The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``."},"value":{"type":"string","description":"A string that contains an optional ``Tag`` value.\n The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``."}},"type":"object","required":["key","value"]},"aws-native:cloudfront:VpcOriginEndpointConfig":{"description":"An Amazon CloudFront VPC origin endpoint configuration.","properties":{"arn":{"type":"string","description":"The ARN of the CloudFront VPC origin endpoint configuration."},"httpPort":{"type":"integer","description":"The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is ``80``."},"httpsPort":{"type":"integer","description":"The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is ``443``."},"name":{"type":"string","description":"The name of the CloudFront VPC origin endpoint configuration."},"originProtocolPolicy":{"type":"string","description":"The origin protocol policy for the CloudFront VPC origin endpoint configuration."},"originSslProtocols":{"type":"array","items":{"type":"string"},"description":"Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``.\n For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DownloadDistValuesOrigin.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*."}},"type":"object","required":["arn","name"]},"aws-native:cloudfront:VpcOriginTag":{"description":"A complex type that contains ``Tag`` key and ``Tag`` value.","properties":{"key":{"type":"string","description":"A string that contains ``Tag`` key.\n The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``."},"value":{"type":"string","description":"A string that contains an optional ``Tag`` value.\n The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``."}},"type":"object","required":["key","value"]},"aws-native:cloudtrail:ChannelDestination":{"description":"The resource that receives events arriving from a channel.","properties":{"location":{"type":"string","description":"The ARN of a resource that receives events from a channel."},"type":{"$ref":"#/types/aws-native:cloudtrail:ChannelDestinationType","description":"The type of destination for events arriving from a channel."}},"type":"object","required":["location","type"]},"aws-native:cloudtrail:ChannelDestinationType":{"description":"The type of destination for events arriving from a channel.","type":"string","enum":[{"name":"EventDataStore","value":"EVENT_DATA_STORE"}]},"aws-native:cloudtrail:ChannelTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:cloudtrail:DashboardRefreshSchedule":{"description":"Configures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule.","properties":{"frequency":{"$ref":"#/types/aws-native:cloudtrail:DashboardRefreshScheduleFrequencyProperties","description":"The frequency at which you want the dashboard refreshed."},"status":{"$ref":"#/types/aws-native:cloudtrail:DashboardRefreshScheduleStatus","description":"The status of the schedule. Supported values are ENABLED and DISABLED."},"timeOfDay":{"type":"string","description":"StartTime of the automatic schedule refresh."}},"type":"object"},"aws-native:cloudtrail:DashboardRefreshScheduleFrequencyProperties":{"description":"The frequency at which you want the dashboard refreshed.","properties":{"unit":{"$ref":"#/types/aws-native:cloudtrail:DashboardRefreshScheduleFrequencyPropertiesUnit","description":"The frequency unit. Supported values are HOURS and DAYS."},"value":{"type":"integer","description":"The frequency value."}},"type":"object","required":["unit","value"]},"aws-native:cloudtrail:DashboardRefreshScheduleFrequencyPropertiesUnit":{"description":"The frequency unit. Supported values are HOURS and DAYS.","type":"string","enum":[{"name":"Hours","value":"HOURS"},{"name":"Days","value":"DAYS"}]},"aws-native:cloudtrail:DashboardRefreshScheduleStatus":{"description":"The status of the schedule. Supported values are ENABLED and DISABLED.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:cloudtrail:DashboardStatus":{"description":"The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Created","value":"CREATED"},{"name":"Updating","value":"UPDATING"},{"name":"Updated","value":"UPDATED"},{"name":"Deleting","value":"DELETING"}]},"aws-native:cloudtrail:DashboardTag":{"description":"An arbitrary set of tags (key-value pairs) for this dashboard.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:cloudtrail:DashboardType":{"description":"The type of the dashboard. Values are CUSTOM and MANAGED.","type":"string","enum":[{"name":"Managed","value":"MANAGED"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:cloudtrail:DashboardWidget":{"description":"The dashboard widget","properties":{"queryParameters":{"type":"array","items":{"type":"string"},"description":"The placeholder keys in the QueryStatement. For example: $StartTime$, $EndTime$, $Period$."},"queryStatement":{"type":"string","description":"The SQL query statement on one or more event data stores."},"viewProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"The view properties of the widget."}},"type":"object","required":["queryStatement"]},"aws-native:cloudtrail:EventDataStoreAdvancedEventSelector":{"description":"Advanced event selectors let you create fine-grained selectors for the following AWS CloudTrail event record ﬁelds. They help you control costs by logging only those events that are important to you.","properties":{"fieldSelectors":{"type":"array","items":{"$ref":"#/types/aws-native:cloudtrail:EventDataStoreAdvancedFieldSelector"},"description":"Contains all selector statements in an advanced event selector."},"name":{"type":"string","description":"An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\"."}},"type":"object","required":["fieldSelectors"]},"aws-native:cloudtrail:EventDataStoreAdvancedFieldSelector":{"description":"A single selector statement in an advanced event selector.","properties":{"endsWith":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the last few characters of the event record field specified as the value of Field."},"equals":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields."},"field":{"type":"string","description":"A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN."},"notEndsWith":{"type":"array","items":{"type":"string"},"description":"An operator that excludes events that match the last few characters of the event record field specified as the value of Field."},"notEquals":{"type":"array","items":{"type":"string"},"description":"An operator that excludes events that match the exact value of the event record field specified as the value of Field."},"notStartsWith":{"type":"array","items":{"type":"string"},"description":"An operator that excludes events that match the first few characters of the event record field specified as the value of Field."},"startsWith":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the first few characters of the event record field specified as the value of Field."}},"type":"object","required":["field"]},"aws-native:cloudtrail:EventDataStoreContextKeySelector":{"description":"An object that contains information types to be included in CloudTrail enriched events.","properties":{"equals":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the exact value of the event record field specified in Type."},"type":{"$ref":"#/types/aws-native:cloudtrail:EventDataStoreContextKeySelectorType","description":"Specifies the type of the event record field in ContextKeySelector. Valid values include RequestContext, TagContext."}},"type":"object","required":["equals","type"]},"aws-native:cloudtrail:EventDataStoreContextKeySelectorType":{"description":"Specifies the type of the event record field in ContextKeySelector. Valid values include RequestContext, TagContext.","type":"string","enum":[{"name":"RequestContext","value":"RequestContext"},{"name":"TagContext","value":"TagContext"}]},"aws-native:cloudtrail:EventDataStoreInsightSelector":{"description":"A string that contains Insights types that are logged on an event data store.","properties":{"insightType":{"type":"string","description":"The type of Insights to log on an event data store."}},"type":"object"},"aws-native:cloudtrail:EventDataStoreMaxEventSize":{"description":"Specifies the maximum size allowed for the event. Valid values are Standard and Large. If you add ContextKeySelectors, this value must be set to Large.","type":"string","enum":[{"name":"Standard","value":"Standard"},{"name":"Large","value":"Large"}]},"aws-native:cloudtrail:EventDataStoreTag":{"description":"An arbitrary set of tags (key-value pairs) for this event data store.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:cloudtrail:TrailAdvancedEventSelector":{"description":"Advanced event selectors let you create fine-grained selectors for the following AWS CloudTrail event record fields. They help you control costs by logging only those events that are important to you.","properties":{"fieldSelectors":{"type":"array","items":{"$ref":"#/types/aws-native:cloudtrail:TrailAdvancedFieldSelector"},"description":"Contains all selector statements in an advanced event selector."},"name":{"type":"string","description":"An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\"."}},"type":"object","required":["fieldSelectors"]},"aws-native:cloudtrail:TrailAdvancedFieldSelector":{"description":"A single selector statement in an advanced event selector.","properties":{"endsWith":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the last few characters of the event record field specified as the value of Field."},"equals":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields."},"field":{"type":"string","description":"A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN."},"notEndsWith":{"type":"array","items":{"type":"string"},"description":"An operator that excludes events that match the last few characters of the event record field specified as the value of Field."},"notEquals":{"type":"array","items":{"type":"string"},"description":"An operator that excludes events that match the exact value of the event record field specified as the value of Field."},"notStartsWith":{"type":"array","items":{"type":"string"},"description":"An operator that excludes events that match the first few characters of the event record field specified as the value of Field."},"startsWith":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the first few characters of the event record field specified as the value of Field."}},"type":"object","required":["field"]},"aws-native:cloudtrail:TrailAggregationConfiguration":{"description":"Configure to add aggregation rules to aggregate CloudTrail Events.","properties":{"eventCategory":{"$ref":"#/types/aws-native:cloudtrail:TrailAggregationConfigurationEventCategory","description":"The category of events to be aggregated."},"templates":{"type":"array","items":{"$ref":"#/types/aws-native:cloudtrail:TrailTemplate"},"description":"Contains all templates in an aggregation configuration."}},"type":"object","required":["eventCategory","templates"]},"aws-native:cloudtrail:TrailAggregationConfigurationEventCategory":{"description":"The category of events to be aggregated.","type":"string","enum":[{"name":"Data","value":"Data"}]},"aws-native:cloudtrail:TrailDataResource":{"description":"CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.","properties":{"type":{"type":"string","description":"The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources."},"values":{"type":"array","items":{"type":"string"},"description":"An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects."}},"type":"object","required":["type"]},"aws-native:cloudtrail:TrailEventSelector":{"description":"The type of email sending events to publish to the event destination.","properties":{"dataResources":{"type":"array","items":{"$ref":"#/types/aws-native:cloudtrail:TrailDataResource"},"description":"CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, AWS Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.\n\nFor more information, see [Data Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) and [Limits in AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the *AWS CloudTrail User Guide* .\n\n\u003e To log data events for all other resource types including objects stored in [directory buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html) , you must use [AdvancedEventSelectors](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html) . You must also use `AdvancedEventSelectors` if you want to filter on the `eventName` field."},"excludeManagementEventSources":{"type":"array","items":{"type":"string"},"description":"An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service events by containing \"kms.amazonaws.com\". By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail."},"includeManagementEvents":{"type":"boolean","description":"Specify if you want your event selector to include management events for your trail."},"readWriteType":{"$ref":"#/types/aws-native:cloudtrail:TrailEventSelectorReadWriteType","description":"Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation."}},"type":"object"},"aws-native:cloudtrail:TrailEventSelectorReadWriteType":{"description":"Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.","type":"string","enum":[{"name":"All","value":"All"},{"name":"ReadOnly","value":"ReadOnly"},{"name":"WriteOnly","value":"WriteOnly"}]},"aws-native:cloudtrail:TrailInsightSelector":{"description":"A string that contains insight types that are logged on a trail.","properties":{"eventCategories":{"type":"array","items":{"$ref":"#/types/aws-native:cloudtrail:TrailSourceEventCategory"},"description":"The categories of events for which to log insights. By default, insights are logged for management events only."},"insightType":{"type":"string","description":"The type of insight to log on a trail."}},"type":"object"},"aws-native:cloudtrail:TrailSourceEventCategory":{"description":"Event category for an insight selector.","type":"string","enum":[{"name":"Management","value":"Management"},{"name":"Data","value":"Data"}]},"aws-native:cloudtrail:TrailTag":{"description":"An arbitrary set of tags (key-value pairs) for this trail.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:cloudtrail:TrailTemplate":{"description":"A template used to configure aggregation rules.","type":"string","enum":[{"name":"ApiActivity","value":"API_ACTIVITY"},{"name":"ResourceAccess","value":"RESOURCE_ACCESS"},{"name":"UserActions","value":"USER_ACTIONS"}]},"aws-native:cloudwatch:AlarmDimension":{"description":"Dimension is an embedded property of the ``AWS::CloudWatch::Alarm`` type. Dimensions are name/value pairs that can be associated with a CW metric. You can specify a maximum of 30 dimensions for a given metric.","properties":{"name":{"type":"string","description":"The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published."},"value":{"type":"string","description":"The value for the dimension, from 1–255 characters in length."}},"type":"object","required":["name","value"]},"aws-native:cloudwatch:AlarmMetric":{"description":"The ``Metric`` property type represents a specific metric. ``Metric`` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.","properties":{"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:cloudwatch:AlarmDimension"},"description":"The metric dimensions that you want to be used for the metric that the alarm will watch."},"metricName":{"type":"string","description":"The name of the metric that you want the alarm to watch. This is a required field."},"namespace":{"type":"string","description":"The namespace of the metric that the alarm will watch."}},"type":"object"},"aws-native:cloudwatch:AlarmMetricDataQuery":{"description":"The ``MetricDataQuery`` property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. \n Any expression used must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.","properties":{"accountId":{"type":"string","description":"The ID of the account where the metrics are located, if this is a cross-account alarm."},"expression":{"type":"string","description":"The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.\n Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both."},"id":{"type":"string","description":"A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter."},"label":{"type":"string","description":"A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default."},"metricStat":{"$ref":"#/types/aws-native:cloudwatch:AlarmMetricStat","description":"The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.\n Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both."},"period":{"type":"integer","description":"The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``."},"returnData":{"type":"boolean","description":"This option indicates whether to return the timestamps and raw data values of this metric.\n When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm.\n This field is required."}},"type":"object","required":["id"]},"aws-native:cloudwatch:AlarmMetricStat":{"description":"This structure defines the metric to be returned, along with the statistics, period, and units.\n ``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.","properties":{"metric":{"$ref":"#/types/aws-native:cloudwatch:AlarmMetric","description":"The metric to return, including the metric name, namespace, and dimensions."},"period":{"type":"integer","description":"The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second.\n If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:\n  +  Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).\n  +  Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).\n  +  Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour)."},"stat":{"type":"string","description":"The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*."},"unit":{"type":"string","description":"The unit to use for the returned data points. \n Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None."}},"type":"object","required":["metric","period","stat"]},"aws-native:cloudwatch:AlarmMuteRuleStatus":{"description":"The current status of the AlarmMuteRule","type":"string","enum":[{"name":"Scheduled","value":"SCHEDULED"},{"name":"Active","value":"ACTIVE"},{"name":"Expired","value":"EXPIRED"}]},"aws-native:cloudwatch:AlarmMuteRuleTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:cloudwatch:AlarmTag":{"description":"One of the key-value pairs associated with the alarm. Tags can help you organize and categorize your resources.","properties":{"key":{"type":"string","description":"A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:cloudwatch:CompositeAlarmTag":{"description":"Metadata that you can assign to a composite alarm, Tags can help you organize and categorize your resources.","properties":{"key":{"type":"string","description":"A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:cloudwatch:MetricStreamFilter":{"description":"This structure defines the metrics that will be streamed.","properties":{"metricNames":{"type":"array","items":{"type":"string"},"description":"Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace."},"namespace":{"type":"string","description":"Only metrics with Namespace matching this value will be streamed."}},"type":"object","required":["namespace"]},"aws-native:cloudwatch:MetricStreamStatisticsConfiguration":{"description":"This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for. All metrics that match the combination of metric name and namespace will be streamed with the extended statistics, no matter their dimensions.","properties":{"additionalStatistics":{"type":"array","items":{"type":"string"},"description":"The additional statistics to stream for the metrics listed in IncludeMetrics."},"includeMetrics":{"type":"array","items":{"$ref":"#/types/aws-native:cloudwatch:MetricStreamStatisticsMetric"},"description":"An array that defines the metrics that are to have additional statistics streamed."}},"type":"object","required":["additionalStatistics","includeMetrics"]},"aws-native:cloudwatch:MetricStreamStatisticsMetric":{"description":"A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.","properties":{"metricName":{"type":"string","description":"The name of the metric."},"namespace":{"type":"string","description":"The namespace of the metric."}},"type":"object","required":["metricName","namespace"]},"aws-native:cloudwatch:MetricStreamTag":{"description":"Metadata that you can assign to a Metric Stream, consisting of a key-value pair.","properties":{"key":{"type":"string","description":"A unique identifier for the tag."},"value":{"type":"string","description":"String which you can use to describe or define the tag."}},"type":"object","required":["key","value"]},"aws-native:cloudwatch:MuteTargetsProperties":{"description":"Targets to be muted","properties":{"alarmNames":{"type":"array","items":{"type":"string"},"description":"The alarm names to be mute by the AlarmMuteRule"}},"type":"object","required":["alarmNames"]},"aws-native:cloudwatch:RuleProperties":{"description":"The rule for the mute","properties":{"schedule":{"$ref":"#/types/aws-native:cloudwatch:RulePropertiesScheduleProperties","description":"Schedule for the mute to be active"}},"type":"object","required":["schedule"]},"aws-native:cloudwatch:RulePropertiesScheduleProperties":{"description":"Schedule for the mute to be active","properties":{"duration":{"type":"string","description":"The duration of the schedule when it triggers"},"expression":{"type":"string","description":"The expression of the schedule"},"timezone":{"type":"string","description":"The timezone of the schedule"}},"type":"object","required":["duration","expression"]},"aws-native:codeartifact:DomainTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:codeartifact:PackageGroupOriginConfiguration":{"properties":{"restrictions":{"$ref":"#/types/aws-native:codeartifact:PackageGroupRestrictions","description":"The origin configuration that is applied to the package group."}},"type":"object","required":["restrictions"]},"aws-native:codeartifact:PackageGroupRestrictionType":{"properties":{"repositories":{"type":"array","items":{"type":"string"}},"restrictionMode":{"$ref":"#/types/aws-native:codeartifact:PackageGroupRestrictionTypeRestrictionMode"}},"type":"object","required":["restrictionMode"]},"aws-native:codeartifact:PackageGroupRestrictionTypeRestrictionMode":{"type":"string","enum":[{"name":"Allow","value":"ALLOW"},{"name":"Block","value":"BLOCK"},{"name":"AllowSpecificRepositories","value":"ALLOW_SPECIFIC_REPOSITORIES"},{"name":"Inherit","value":"INHERIT"}]},"aws-native:codeartifact:PackageGroupRestrictions":{"properties":{"externalUpstream":{"$ref":"#/types/aws-native:codeartifact:PackageGroupRestrictionType","description":"The external upstream restriction determines if new package versions can be ingested or retained from external connections."},"internalUpstream":{"$ref":"#/types/aws-native:codeartifact:PackageGroupRestrictionType","description":"The internal upstream restriction determines if new package versions can be ingested or retained from upstream repositories."},"publish":{"$ref":"#/types/aws-native:codeartifact:PackageGroupRestrictionType","description":"The publish restriction determines if new package versions can be published."}},"type":"object"},"aws-native:codeartifact:PackageGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:codeartifact:RepositoryTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:codebuild:FleetComputeConfiguration":{"properties":{"disk":{"type":"integer","description":"The amount of disk space of the instance type included in your fleet."},"instanceType":{"type":"string","description":"The EC2 instance type to be launched in your fleet."},"machineType":{"$ref":"#/types/aws-native:codebuild:FleetComputeConfigurationmachineType","description":"The machine type of the instance type included in your fleet."},"memory":{"type":"integer","description":"The amount of memory of the instance type included in your fleet."},"vCpu":{"type":"integer","description":"The number of vCPUs of the instance type included in your fleet."}},"type":"object"},"aws-native:codebuild:FleetComputeConfigurationmachineType":{"description":"The machine type of the instance type included in your fleet.","type":"string","enum":[{"name":"General","value":"GENERAL"},{"name":"Nvme","value":"NVME"}]},"aws-native:codebuild:FleetComputeType":{"description":"Information about the compute resources the compute fleet uses. Available values include:\n\n- `ATTRIBUTE_BASED_COMPUTE` : Specify the amount of vCPUs, memory, disk space, and the type of machine.\n\n\u003e If you use `ATTRIBUTE_BASED_COMPUTE` , you must define your attributes by using `computeConfiguration` . AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see [Reserved capacity environment types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment-reserved-capacity.types) in the *AWS CodeBuild User Guide* .\n- `BUILD_GENERAL1_SMALL` : Use up to 4 GiB memory and 2 vCPUs for builds.\n- `BUILD_GENERAL1_MEDIUM` : Use up to 8 GiB memory and 4 vCPUs for builds.\n- `BUILD_GENERAL1_LARGE` : Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.\n- `BUILD_GENERAL1_XLARGE` : Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.\n- `BUILD_GENERAL1_2XLARGE` : Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.\n- `BUILD_LAMBDA_1GB` : Use up to 1 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER` .\n- `BUILD_LAMBDA_2GB` : Use up to 2 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER` .\n- `BUILD_LAMBDA_4GB` : Use up to 4 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER` .\n- `BUILD_LAMBDA_8GB` : Use up to 8 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER` .\n- `BUILD_LAMBDA_10GB` : Use up to 10 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER` .\n\nIf you use `BUILD_GENERAL1_SMALL` :\n\n- For environment type `LINUX_CONTAINER` , you can use up to 4 GiB memory and 2 vCPUs for builds.\n- For environment type `LINUX_GPU_CONTAINER` , you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.\n- For environment type `ARM_CONTAINER` , you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.\n\nIf you use `BUILD_GENERAL1_LARGE` :\n\n- For environment type `LINUX_CONTAINER` , you can use up to 16 GiB memory and 8 vCPUs for builds.\n- For environment type `LINUX_GPU_CONTAINER` , you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.\n- For environment type `ARM_CONTAINER` , you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.\n\nFor more information, see [On-demand environment types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment.types) in the *AWS CodeBuild User Guide.*","type":"string","enum":[{"name":"BuildGeneral1Small","value":"BUILD_GENERAL1_SMALL"},{"name":"BuildGeneral1Medium","value":"BUILD_GENERAL1_MEDIUM"},{"name":"BuildGeneral1Large","value":"BUILD_GENERAL1_LARGE"},{"name":"BuildGeneral1Xlarge","value":"BUILD_GENERAL1_XLARGE"},{"name":"BuildGeneral12xlarge","value":"BUILD_GENERAL1_2XLARGE"},{"name":"AttributeBasedCompute","value":"ATTRIBUTE_BASED_COMPUTE"},{"name":"CustomInstanceType","value":"CUSTOM_INSTANCE_TYPE"}]},"aws-native:codebuild:FleetEnvironmentType":{"description":"The environment type of the compute fleet.\n\n- The environment type `ARM_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).\n- The environment type `ARM_EC2` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).\n- The environment type `LINUX_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).\n- The environment type `LINUX_EC2` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).\n- The environment type `LINUX_GPU_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).\n- The environment type `MAC_ARM` is available only in regions US East (Ohio), US East (N. Virginia), US West (Oregon), Europe (Frankfurt), and Asia Pacific (Sydney).\n- The environment type `WINDOWS_EC2` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).\n- The environment type `WINDOWS_SERVER_2019_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).\n- The environment type `WINDOWS_SERVER_2022_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).\n\nFor more information, see [Build environment compute types](https://docs.aws.amazon.com//codebuild/latest/userguide/build-env-ref-compute-types.html) in the *AWS CodeBuild user guide* .","type":"string","enum":[{"name":"WindowsServer2019Container","value":"WINDOWS_SERVER_2019_CONTAINER"},{"name":"WindowsServer2022Container","value":"WINDOWS_SERVER_2022_CONTAINER"},{"name":"LinuxContainer","value":"LINUX_CONTAINER"},{"name":"LinuxGpuContainer","value":"LINUX_GPU_CONTAINER"},{"name":"ArmContainer","value":"ARM_CONTAINER"},{"name":"MacArm","value":"MAC_ARM"},{"name":"LinuxEc2","value":"LINUX_EC2"},{"name":"ArmEc2","value":"ARM_EC2"},{"name":"WindowsEc2","value":"WINDOWS_EC2"}]},"aws-native:codebuild:FleetOverflowBehavior":{"description":"The compute fleet overflow behavior.\n\n- For overflow behavior `QUEUE` , your overflow builds need to wait on the existing fleet instance to become available.\n- For overflow behavior `ON_DEMAND` , your overflow builds run on CodeBuild on-demand.\n\n\u003e If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see [Example policy statement to allow CodeBuild access to AWS services required to create a VPC network interface](https://docs.aws.amazon.com/codebuild/latest/userguide/auth-and-access-control-iam-identity-based-access-control.html#customer-managed-policies-example-create-vpc-network-interface) .","type":"string","enum":[{"name":"Queue","value":"QUEUE"},{"name":"OnDemand","value":"ON_DEMAND"}]},"aws-native:codebuild:FleetProxyConfiguration":{"properties":{"defaultBehavior":{"$ref":"#/types/aws-native:codebuild:FleetProxyConfigurationDefaultBehavior","description":"The default behavior of outgoing traffic."},"orderedProxyRules":{"type":"array","items":{"$ref":"#/types/aws-native:codebuild:FleetProxyRule"},"description":"An array of `FleetProxyRule` objects that represent the specified destination domains or IPs to allow or deny network access control to."}},"type":"object"},"aws-native:codebuild:FleetProxyConfigurationDefaultBehavior":{"description":"The default behavior of outgoing traffic.","type":"string","enum":[{"name":"AllowAll","value":"ALLOW_ALL"},{"name":"DenyAll","value":"DENY_ALL"}]},"aws-native:codebuild:FleetProxyRule":{"properties":{"effect":{"$ref":"#/types/aws-native:codebuild:FleetProxyRuleEffect","description":"The behavior of the proxy rule."},"entities":{"type":"array","items":{"type":"string"},"description":"The destination of the proxy rule."},"type":{"$ref":"#/types/aws-native:codebuild:FleetProxyRuleType","description":"The type of proxy rule."}},"type":"object"},"aws-native:codebuild:FleetProxyRuleEffect":{"description":"The behavior of the proxy rule.","type":"string","enum":[{"name":"Allow","value":"ALLOW"},{"name":"Deny","value":"DENY"}]},"aws-native:codebuild:FleetProxyRuleType":{"description":"The type of proxy rule.","type":"string","enum":[{"name":"Domain","value":"DOMAIN"},{"name":"Ip","value":"IP"}]},"aws-native:codebuild:FleetScalingConfigurationInput":{"properties":{"maxCapacity":{"type":"integer","description":"The maximum number of instances in the ﬂeet when auto-scaling."},"scalingType":{"$ref":"#/types/aws-native:codebuild:FleetScalingConfigurationInputScalingType","description":"The scaling type for a compute fleet."},"targetTrackingScalingConfigs":{"type":"array","items":{"$ref":"#/types/aws-native:codebuild:FleetTargetTrackingScalingConfiguration"},"description":"A list of `TargetTrackingScalingConfiguration` objects."}},"type":"object"},"aws-native:codebuild:FleetScalingConfigurationInputScalingType":{"description":"The scaling type for a compute fleet.","type":"string","enum":[{"name":"TargetTrackingScaling","value":"TARGET_TRACKING_SCALING"}]},"aws-native:codebuild:FleetTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:codebuild:FleetTargetTrackingScalingConfiguration":{"properties":{"metricType":{"$ref":"#/types/aws-native:codebuild:FleetTargetTrackingScalingConfigurationMetricType","description":"The metric type to determine auto-scaling."},"targetValue":{"type":"number","description":"The value of `metricType` when to start scaling."}},"type":"object"},"aws-native:codebuild:FleetTargetTrackingScalingConfigurationMetricType":{"description":"The metric type to determine auto-scaling.","type":"string","enum":[{"name":"FleetUtilizationRate","value":"FLEET_UTILIZATION_RATE"}]},"aws-native:codebuild:FleetVpcConfig":{"properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"A list of one or more security groups IDs in your Amazon VPC."},"subnets":{"type":"array","items":{"type":"string"},"description":"A list of one or more subnet IDs in your Amazon VPC."},"vpcId":{"type":"string","description":"The ID of the Amazon VPC."}},"type":"object"},"aws-native:codeconnections:ConnectionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:codedeploy:ApplicationTag":{"properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:codedeploy:DeploymentConfigMinimumHealthyHosts":{"properties":{"type":{"type":"string","description":"The minimum healthy instance type:\n\n- HOST_COUNT: The minimum number of healthy instance as an absolute value.\n- FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment.\n\nIn an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment is successful if four or more instance are deployed to successfully. Otherwise, the deployment fails.\n\n\u003e In a call to `GetDeploymentConfig` , CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful. \n\nFor more information, see [AWS CodeDeploy Instance Health](https://docs.aws.amazon.com//codedeploy/latest/userguide/instances-health.html) in the *AWS CodeDeploy User Guide* ."},"value":{"type":"integer","description":"The minimum healthy instance value."}},"type":"object","required":["type","value"]},"aws-native:codedeploy:DeploymentConfigMinimumHealthyHostsPerZone":{"properties":{"type":{"type":"string","description":"The `type` associated with the `MinimumHealthyHostsPerZone` option."},"value":{"type":"integer","description":"The `value` associated with the `MinimumHealthyHostsPerZone` option."}},"type":"object","required":["type","value"]},"aws-native:codedeploy:DeploymentConfigTimeBasedCanary":{"properties":{"canaryInterval":{"type":"integer","description":"The number of minutes between the first and second traffic shifts of a `TimeBasedCanary` deployment."},"canaryPercentage":{"type":"integer","description":"The percentage of traffic to shift in the first increment of a `TimeBasedCanary` deployment."}},"type":"object","required":["canaryInterval","canaryPercentage"]},"aws-native:codedeploy:DeploymentConfigTimeBasedLinear":{"properties":{"linearInterval":{"type":"integer","description":"The number of minutes between each incremental traffic shift of a `TimeBasedLinear` deployment."},"linearPercentage":{"type":"integer","description":"The percentage of traffic that is shifted at the start of each increment of a `TimeBasedLinear` deployment."}},"type":"object","required":["linearInterval","linearPercentage"]},"aws-native:codedeploy:DeploymentConfigTrafficRoutingConfig":{"properties":{"timeBasedCanary":{"$ref":"#/types/aws-native:codedeploy:DeploymentConfigTimeBasedCanary","description":"A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file."},"timeBasedLinear":{"$ref":"#/types/aws-native:codedeploy:DeploymentConfigTimeBasedLinear","description":"A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file."},"type":{"type":"string","description":"The type of traffic shifting ( `TimeBasedCanary` or `TimeBasedLinear` ) used by a deployment configuration."}},"type":"object","required":["type"]},"aws-native:codedeploy:DeploymentConfigZonalConfig":{"properties":{"firstZoneMonitorDurationInSeconds":{"type":"integer","description":"The period of time, in seconds, that CodeDeploy must wait after completing a deployment to the *first* Availability Zone. CodeDeploy will wait this amount of time before starting a deployment to the second Availability Zone. You might set this option if you want to allow extra bake time for the first Availability Zone. If you don't specify a value for `firstZoneMonitorDurationInSeconds` , then CodeDeploy uses the `monitorDurationInSeconds` value for the first Availability Zone.\n\nFor more information about the zonal configuration feature, see [zonal configuration](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) in the *CodeDeploy User Guide* ."},"minimumHealthyHostsPerZone":{"$ref":"#/types/aws-native:codedeploy:DeploymentConfigMinimumHealthyHostsPerZone","description":"The number or percentage of instances that must remain available per Availability Zone during a deployment. This option works in conjunction with the `MinimumHealthyHosts` option. For more information, see [About the minimum number of healthy hosts per Availability Zone](https://docs.aws.amazon.com//codedeploy/latest/userguide/instances-health.html#minimum-healthy-hosts-az) in the *CodeDeploy User Guide* .\n\nIf you don't specify the `minimumHealthyHostsPerZone` option, then CodeDeploy uses a default value of `0` percent.\n\nFor more information about the zonal configuration feature, see [zonal configuration](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) in the *CodeDeploy User Guide* ."},"monitorDurationInSeconds":{"type":"integer","description":"The period of time, in seconds, that CodeDeploy must wait after completing a deployment to an Availability Zone. CodeDeploy will wait this amount of time before starting a deployment to the next Availability Zone. Consider adding a monitor duration to give the deployment some time to prove itself (or 'bake') in one Availability Zone before it is released in the next zone. If you don't specify a `monitorDurationInSeconds` , CodeDeploy starts deploying to the next Availability Zone immediately.\n\nFor more information about the zonal configuration feature, see [zonal configuration](https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations-create.html#zonal-config) in the *CodeDeploy User Guide* ."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupAlarm":{"description":"Specifies a CloudWatch alarm to use for an AWS CodeDeploy deployment group.","properties":{"name":{"type":"string","description":"The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupAlarmConfiguration":{"description":"Configures CloudWatch alarms for an AWS CodeDeploy deployment group.","properties":{"alarms":{"type":"array","items":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupAlarm"},"description":"A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added."},"enabled":{"type":"boolean","description":"Indicates whether the alarm configuration is enabled."},"ignorePollAlarmFailure":{"type":"boolean","description":"Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupAutoRollbackConfiguration":{"description":"Configures automatic rollback for an AWS CodeDeploy deployment group when a deployment is not completed successfully.","properties":{"enabled":{"type":"boolean","description":"Indicates whether a defined automatic rollback configuration is currently enabled."},"events":{"type":"array","items":{"type":"string"},"description":"The event type or types that trigger a rollback."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupBlueGreenDeploymentConfiguration":{"description":"Information about blue/green deployment options for a deployment group.","properties":{"deploymentReadyOption":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupDeploymentReadyOption","description":"Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment."},"greenFleetProvisioningOption":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupGreenFleetProvisioningOption","description":"Information about how instances are provisioned for a replacement environment in a blue/green deployment."},"terminateBlueInstancesOnDeploymentSuccess":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupBlueInstanceTerminationOption","description":"Information about whether to terminate instances in the original fleet during a blue/green deployment."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupBlueInstanceTerminationOption":{"description":"Information about whether instances in the original environment are terminated when a blue/green deployment is successful. BlueInstanceTerminationOption does not apply to Lambda deployments.","properties":{"action":{"type":"string","description":"The action to take on instances in the original environment after a successful blue/green deployment."},"terminationWaitTimeInMinutes":{"type":"integer","description":"For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment. For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set. The maximum setting is 2880 minutes (2 days)."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupDeployment":{"description":"Specifies an AWS CodeDeploy application revision to be deployed to instances in the deployment group. If you specify an application revision, your target revision is deployed as soon as the provisioning process is complete.","properties":{"description":{"type":"string","description":"A description of the deployment."},"ignoreApplicationStopFailures":{"type":"boolean","description":"If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted."},"revision":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupRevisionLocation","description":"Information about the location of stored application artifacts and the service from which to retrieve them."}},"type":"object","required":["revision"]},"aws-native:codedeploy:DeploymentGroupDeploymentReadyOption":{"description":"Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.","properties":{"actionOnTimeout":{"type":"string","description":"Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment. CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment. STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment . If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped."},"waitTimeInMinutes":{"type":"integer","description":"The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupDeploymentStyle":{"description":"Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.","properties":{"deploymentOption":{"type":"string","description":"Indicates whether to route deployment traffic behind a load balancer."},"deploymentType":{"type":"string","description":"Indicates whether to run an in-place or blue/green deployment."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupEc2TagFilter":{"description":"Information about an Amazon EC2 tag filter.","properties":{"key":{"type":"string","description":"The tag filter key."},"type":{"type":"string","description":"The tag filter type."},"value":{"type":"string","description":"The tag filter value."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupEc2TagSet":{"description":"Specifies information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same template as EC2TagFilters.","properties":{"ec2TagSetList":{"type":"array","items":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupEc2TagSetListObject"},"description":"The Amazon EC2 tags that are already applied to Amazon EC2 instances that you want to include in the deployment group. CodeDeploy includes all Amazon EC2 instances identified by any of the tags you specify in this deployment group."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupEc2TagSetListObject":{"description":"The EC2TagSet property type specifies information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same template as EC2TagFilters.","properties":{"ec2TagGroup":{"type":"array","items":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupEc2TagFilter"},"description":"A list that contains other lists of Amazon EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupEcsService":{"description":"Contains the service and cluster names used to identify an Amazon ECS deployment's target.","properties":{"clusterName":{"type":"string","description":"The name of the cluster that the Amazon ECS service is associated with."},"serviceName":{"type":"string","description":"The name of the target Amazon ECS service."}},"type":"object","required":["clusterName","serviceName"]},"aws-native:codedeploy:DeploymentGroupElbInfo":{"description":"The ELBInfo property type specifies information about the Elastic Load Balancing load balancer used for an CodeDeploy deployment group. If you specify the ELBInfo property, the DeploymentStyle.DeploymentOption property must be set to WITH_TRAFFIC_CONTROL for AWS CodeDeploy to route your traffic using the specified load balancers.","properties":{"name":{"type":"string","description":"For blue/green deployments, the name of the load balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupGitHubLocation":{"description":"Specifies the location of an application revision that is stored in GitHub.","properties":{"commitId":{"type":"string","description":"The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision."},"repository":{"type":"string","description":"The GitHub account and repository pair that stores the application revision to be deployed."}},"type":"object","required":["commitId","repository"]},"aws-native:codedeploy:DeploymentGroupGreenFleetProvisioningOption":{"description":"Information about the instances that belong to the replacement environment in a blue/green deployment.","properties":{"action":{"type":"string","description":"The method used to add instances to a replacement environment."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupLoadBalancerInfo":{"description":"Specifies information about the load balancer or target group used for an AWS CodeDeploy deployment group. For AWS CloudFormation to use the properties specified in LoadBalancerInfo, the DeploymentStyle.DeploymentOption property must be set to WITH_TRAFFIC_CONTROL.","properties":{"elbInfoList":{"type":"array","items":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupElbInfo"},"description":"An array that contains information about the load balancers to use for load balancing in a deployment. If you're using Classic Load Balancers, specify those load balancers in this array."},"targetGroupInfoList":{"type":"array","items":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupTargetGroupInfo"},"description":"An array that contains information about the target groups to use for load balancing in a deployment. If you're using Application Load Balancers and Network Load Balancers, specify their associated target groups in this array."},"targetGroupPairInfoList":{"type":"array","items":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupTargetGroupPairInfo"},"description":"The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupOnPremisesTagSet":{"description":"Specifies a list containing other lists of on-premises instance tag groups. In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list.","properties":{"onPremisesTagSetList":{"type":"array","items":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupOnPremisesTagSetListObject"},"description":"A list that contains other lists of on-premises instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupOnPremisesTagSetListObject":{"description":"Specifies lists of on-premises instance tag groups. In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list.","properties":{"onPremisesTagGroup":{"type":"array","items":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupTagFilter"},"description":"Information about groups of on-premises instance tags."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupRevisionLocation":{"description":"Defines the location of the CodeDeploy application revision to deploy.","properties":{"gitHubLocation":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupGitHubLocation","description":"Information about the location of application artifacts stored in GitHub."},"revisionType":{"type":"string","description":"The type of application revision."},"s3Location":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupS3Location","description":"Information about the location of a revision stored in Amazon S3."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupS3Location":{"description":"Information about the location of application artifacts stored in Amazon S3.","properties":{"bucket":{"type":"string","description":"The name of the Amazon S3 bucket where the application revision is stored."},"bundleType":{"type":"string","description":"The file type of the application revision."},"eTag":{"type":"string","description":"The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision. If the ETag is not specified as an input parameter, ETag validation of the object is skipped."},"key":{"type":"string","description":"The name of the Amazon S3 object that represents the bundled artifacts for the application revision."},"version":{"type":"string","description":"A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision. If the version is not specified, the system uses the most recent version by default."}},"type":"object","required":["bucket","key"]},"aws-native:codedeploy:DeploymentGroupTag":{"description":"Information about a tag.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:codedeploy:DeploymentGroupTagFilter":{"description":"Specifies which on-premises instances to associate with the deployment group.","properties":{"key":{"type":"string","description":"The on-premises instance tag filter key."},"type":{"type":"string","description":"The on-premises instance tag filter type"},"value":{"type":"string","description":"The on-premises instance tag filter value."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupTargetGroupInfo":{"description":"Specifies information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed to the target group. The DeploymentStyle.DeploymentOption property must be set to WITH_TRAFFIC_CONTROL for CodeDeploy to route your traffic using the specified target groups.","properties":{"name":{"type":"string","description":"For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment completes. No duplicates allowed."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupTargetGroupPairInfo":{"description":"The TargetGroupInfo property type specifies information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed to the target group. The DeploymentStyle.DeploymentOption property must be set to WITH_TRAFFIC_CONTROL for CodeDeploy to route your traffic using the specified target groups.","properties":{"prodTrafficRoute":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupTrafficRoute","description":"The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete."},"targetGroups":{"type":"array","items":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupTargetGroupInfo"},"description":"One pair of target groups. One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete."},"testTrafficRoute":{"$ref":"#/types/aws-native:codedeploy:DeploymentGroupTrafficRoute","description":"An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a deployment."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupTrafficRoute":{"description":"Information about a listener. The listener contains the path used to route traffic that is received from the load balancer to a target group.","properties":{"listenerArns":{"type":"array","items":{"type":"string"},"description":"The Amazon Resource Name (ARN) of one listener. The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one."}},"type":"object"},"aws-native:codedeploy:DeploymentGroupTriggerConfig":{"description":"Information about notification triggers for the deployment group.","properties":{"triggerEvents":{"type":"array","items":{"type":"string"},"description":"The event type or types that trigger notifications."},"triggerName":{"type":"string","description":"The name of the notification trigger."},"triggerTargetArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent."}},"type":"object"},"aws-native:codeguruprofiler:AgentPermissionsProperties":{"description":"The agent permissions attached to this profiling group.","properties":{"principals":{"type":"array","items":{"type":"string"},"description":"The principals for the agent permissions."}},"type":"object","required":["principals"]},"aws-native:codeguruprofiler:ProfilingGroupChannel":{"description":"Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.","properties":{"channelId":{"type":"string","description":"The channel ID."},"channelUri":{"type":"string","description":"The channel URI."}},"type":"object","required":["channelUri"]},"aws-native:codeguruprofiler:ProfilingGroupComputePlatform":{"description":"The compute platform of the profiling group.","type":"string","enum":[{"name":"Default","value":"Default"},{"name":"AwsLambda","value":"AWSLambda"}]},"aws-native:codeguruprofiler:ProfilingGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @."}},"type":"object","required":["key","value"]},"aws-native:codegurureviewer:RepositoryAssociationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @."}},"type":"object","required":["key","value"]},"aws-native:codegurureviewer:RepositoryAssociationType":{"description":"The type of repository to be associated.","type":"string","enum":[{"name":"CodeCommit","value":"CodeCommit"},{"name":"Bitbucket","value":"Bitbucket"},{"name":"GitHubEnterpriseServer","value":"GitHubEnterpriseServer"},{"name":"S3Bucket","value":"S3Bucket"}]},"aws-native:codepipeline:CustomActionTypeArtifactDetails":{"description":"Returns information about the details of an artifact.","properties":{"maximumCount":{"type":"integer","description":"The maximum number of artifacts allowed for the action type."},"minimumCount":{"type":"integer","description":"The minimum number of artifacts allowed for the action type."}},"type":"object","required":["maximumCount","minimumCount"]},"aws-native:codepipeline:CustomActionTypeConfigurationProperties":{"description":"The configuration properties for the custom action.","properties":{"description":{"type":"string","description":"The description of the action configuration property that is displayed to users. "},"key":{"type":"boolean","description":"Whether the configuration property is a key."},"name":{"type":"string","description":"The name of the action configuration property."},"queryable":{"type":"boolean","description":"Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens. "},"required":{"type":"boolean","description":"Whether the configuration property is a required value."},"secret":{"type":"boolean","description":"Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs."},"type":{"type":"string","description":"The type of the configuration property."}},"type":"object","required":["key","name","required","secret"]},"aws-native:codepipeline:CustomActionTypeSettings":{"description":"Settings is a property of the AWS::CodePipeline::CustomActionType resource that provides URLs that users can access to view information about the CodePipeline custom action. ","properties":{"entityUrlTemplate":{"type":"string","description":"The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline. "},"executionUrlTemplate":{"type":"string","description":"The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action. "},"revisionUrlTemplate":{"type":"string","description":"The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action. "},"thirdPartyConfigurationUrl":{"type":"string","description":"The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service."}},"type":"object"},"aws-native:codepipeline:CustomActionTypeTag":{"properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:codepipeline:PipelineActionDeclaration":{"description":"Represents information about an action declaration.","properties":{"actionTypeId":{"$ref":"#/types/aws-native:codepipeline:PipelineActionTypeId","description":"Specifies the action type and the provider of the action."},"commands":{"type":"array","items":{"type":"string"},"description":"The shell commands to run with your compute action in CodePipeline."},"configuration":{"$ref":"pulumi.json#/Any","description":"The action's configuration. These are key-value pairs that specify input values for an action."},"environmentVariables":{"type":"array","items":{"$ref":"#/types/aws-native:codepipeline:PipelineEnvironmentVariable"},"description":"The list of environment variables that are input to a compute based action."},"inputArtifacts":{"type":"array","items":{"$ref":"#/types/aws-native:codepipeline:PipelineInputArtifact"},"description":"The name or ID of the artifact consumed by the action, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts. To refer to the action configuration specification by action provider, see the [Action structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) in the *AWS CodePipeline User Guide* .\n\n\u003e For a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource. For more information, see the [CodeBuild action reference page](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeBuild.html) in the *AWS CodePipeline User Guide* ."},"name":{"type":"string","description":"The action declaration's name."},"namespace":{"type":"string","description":"The variable namespace associated with the action. All variables produced as output by this action fall under this namespace."},"outputArtifacts":{"type":"array","items":{"$ref":"#/types/aws-native:codepipeline:PipelineOutputArtifact"},"description":"The name or ID of the result of the action declaration, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts. To refer to the action configuration specification by action provider, see the [Action structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) in the *AWS CodePipeline User Guide* ."},"outputVariables":{"type":"array","items":{"type":"string"},"description":"The list of variables that are to be exported from the compute action."},"region":{"type":"string","description":"The action declaration's AWS Region, such as us-east-1."},"roleArn":{"type":"string","description":"The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline."},"runOrder":{"type":"integer","description":"The order in which actions are run."},"timeoutInMinutes":{"type":"integer","description":"A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for AWS CodePipeline. This attribute is available only to the manual approval ActionType."}},"type":"object","required":["actionTypeId","name"]},"aws-native:codepipeline:PipelineActionTypeId":{"description":"Represents information about an action type.","properties":{"category":{"$ref":"#/types/aws-native:codepipeline:PipelineActionTypeIdCategory","description":"A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below."},"owner":{"type":"string","description":"The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom."},"provider":{"type":"string","description":"The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy."},"version":{"type":"string","description":"A string that describes the action version."}},"type":"object","required":["category","owner","provider","version"]},"aws-native:codepipeline:PipelineActionTypeIdCategory":{"description":"A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.","type":"string","enum":[{"name":"Source","value":"Source"},{"name":"Build","value":"Build"},{"name":"Test","value":"Test"},{"name":"Deploy","value":"Deploy"},{"name":"Invoke","value":"Invoke"},{"name":"Approval","value":"Approval"},{"name":"Compute","value":"Compute"}]},"aws-native:codepipeline:PipelineArtifactStore":{"description":"The S3 bucket where artifacts for the pipeline are stored.","properties":{"encryptionKey":{"$ref":"#/types/aws-native:codepipeline:PipelineEncryptionKey","description":"The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key. If this is undefined, the default key for Amazon S3 is used. To see an example artifact store encryption key field, see the example structure here: [AWS::CodePipeline::Pipeline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html) ."},"location":{"type":"string","description":"The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts."},"type":{"$ref":"#/types/aws-native:codepipeline:PipelineArtifactStoreType","description":"The type of the artifact store, such as S3."}},"type":"object","required":["location","type"]},"aws-native:codepipeline:PipelineArtifactStoreMap":{"description":"A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.","properties":{"artifactStore":{"$ref":"#/types/aws-native:codepipeline:PipelineArtifactStore","description":"Represents information about the S3 bucket where artifacts are stored for the pipeline.\n\n\u003e You must include either `artifactStore` or `artifactStores` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use `artifactStores` ."},"region":{"type":"string","description":"The action declaration's AWS Region, such as us-east-1."}},"type":"object","required":["artifactStore","region"]},"aws-native:codepipeline:PipelineArtifactStoreType":{"description":"The type of the artifact store, such as S3.","type":"string","enum":[{"name":"S3","value":"S3"}]},"aws-native:codepipeline:PipelineBeforeEntryConditions":{"description":"The configuration that specifies the rules to run before stage starts.","properties":{"conditions":{"type":"array","items":{"$ref":"#/types/aws-native:codepipeline:PipelineCondition"},"description":"The conditions that are configured as entry conditions."}},"type":"object"},"aws-native:codepipeline:PipelineBlockerDeclaration":{"description":"Reserved for future use.","properties":{"name":{"type":"string","description":"Reserved for future use."},"type":{"$ref":"#/types/aws-native:codepipeline:PipelineBlockerDeclarationType","description":"Reserved for future use."}},"type":"object","required":["name","type"]},"aws-native:codepipeline:PipelineBlockerDeclarationType":{"description":"Reserved for future use.","type":"string","enum":[{"name":"Schedule","value":"Schedule"}]},"aws-native:codepipeline:PipelineCondition":{"description":"Represents information about condition.","properties":{"result":{"type":"string","description":"The specified result for when the failure conditions are met, such as rolling back the stage"},"rules":{"type":"array","items":{"$ref":"#/types/aws-native:codepipeline:PipelineRuleDeclaration"},"description":"The rules that make up the condition."}},"type":"object"},"aws-native:codepipeline:PipelineEncryptionKey":{"description":"Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key","properties":{"id":{"type":"string","description":"The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN."},"type":{"type":"string","description":"The type of encryption key, such as an AWS KMS key. When creating or updating a pipeline, the value must be set to 'KMS'."}},"type":"object","required":["id","type"]},"aws-native:codepipeline:PipelineEnvironmentVariable":{"description":"Represents information about the environment variable of an action.","properties":{"name":{"type":"string","description":"The name of the environment variable."},"type":{"$ref":"#/types/aws-native:codepipeline:PipelineEnvironmentVariableType","description":"The type of the environment variable."},"value":{"type":"string","description":"The value of the environment variable."}},"type":"object","required":["name","value"]},"aws-native:codepipeline:PipelineEnvironmentVariableType":{"description":"The type of the environment variable.","type":"string","enum":[{"name":"Plaintext","value":"PLAINTEXT"},{"name":"SecretsManager","value":"SECRETS_MANAGER"}]},"aws-native:codepipeline:PipelineExecutionMode":{"description":"The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.","type":"string","enum":[{"name":"Queued","value":"QUEUED"},{"name":"Superseded","value":"SUPERSEDED"},{"name":"Parallel","value":"PARALLEL"}]},"aws-native:codepipeline:PipelineFailureConditions":{"description":"The configuration that specifies the result, such as rollback, to occur upon stage failure","properties":{"conditions":{"type":"array","items":{"$ref":"#/types/aws-native:codepipeline:PipelineCondition"},"description":"The conditions that are configured as failure conditions. For more information about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html) and [How do stage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html) ."},"result":{"$ref":"#/types/aws-native:codepipeline:PipelineFailureConditionsResult","description":"The specified result for when the failure conditions are met, such as rolling back the stage"},"retryConfiguration":{"$ref":"#/types/aws-native:codepipeline:PipelineFailureConditionsRetryConfigurationProperties","description":"The configuration that specifies the retry configuration for a stage"}},"type":"object"},"aws-native:codepipeline:PipelineFailureConditionsResult":{"description":"The specified result for when the failure conditions are met, such as rolling back the stage","type":"string","enum":[{"name":"Rollback","value":"ROLLBACK"},{"name":"Retry","value":"RETRY"}]},"aws-native:codepipeline:PipelineFailureConditionsRetryConfigurationProperties":{"description":"The configuration that specifies the retry configuration for a stage","properties":{"retryMode":{"$ref":"#/types/aws-native:codepipeline:PipelineFailureConditionsRetryConfigurationPropertiesRetryMode","description":"The specified retry mode type for the given stage. FAILED_ACTIONS will retry only the failed actions. ALL_ACTIONS will retry both failed and successful"}},"type":"object"},"aws-native:codepipeline:PipelineFailureConditionsRetryConfigurationPropertiesRetryMode":{"description":"The specified retry mode type for the given stage. FAILED_ACTIONS will retry only the failed actions. ALL_ACTIONS will retry both failed and successful","type":"string","enum":[{"name":"AllActions","value":"ALL_ACTIONS"},{"name":"FailedActions","value":"FAILED_ACTIONS"}]},"aws-native:codepipeline:PipelineGitBranchFilterCriteria":{"description":"The Git repository branches specified as filter criteria to start the pipeline.","properties":{"excludes":{"type":"array","items":{"type":"string"},"description":"The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline."},"includes":{"type":"array","items":{"type":"string"},"description":"The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline."}},"type":"object"},"aws-native:codepipeline:PipelineGitConfiguration":{"description":"A type of trigger configuration for Git-based source actions.","properties":{"pullRequest":{"type":"array","items":{"$ref":"#/types/aws-native:codepipeline:PipelineGitPullRequestFilter"},"description":"The field where the repository event that will start the pipeline is specified as pull requests."},"push":{"type":"array","items":{"$ref":"#/types/aws-native:codepipeline:PipelineGitPushFilter"},"description":"The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details."},"sourceActionName":{"type":"string","description":"The name of the pipeline source action where the trigger configuration, such as Git tags, is specified. The trigger configuration will start the pipeline upon the specified change only."}},"type":"object","required":["sourceActionName"]},"aws-native:codepipeline:PipelineGitFilePathFilterCriteria":{"description":"The Git repository file paths specified as filter criteria to start the pipeline.","properties":{"excludes":{"type":"array","items":{"type":"string"},"description":"The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline."},"includes":{"type":"array","items":{"type":"string"},"description":"The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline."}},"type":"object"},"aws-native:codepipeline:PipelineGitPullRequestFilter":{"description":"The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.","properties":{"branches":{"$ref":"#/types/aws-native:codepipeline:PipelineGitBranchFilterCriteria","description":"The field that specifies to filter on branches for the pull request trigger configuration."},"events":{"type":"array","items":{"type":"string"},"description":"The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration."},"filePaths":{"$ref":"#/types/aws-native:codepipeline:PipelineGitFilePathFilterCriteria","description":"The field that specifies to filter on file paths for the pull request trigger configuration."}},"type":"object"},"aws-native:codepipeline:PipelineGitPushFilter":{"description":"The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.","properties":{"branches":{"$ref":"#/types/aws-native:codepipeline:PipelineGitBranchFilterCriteria","description":"The field that specifies to filter on branches for the push trigger configuration."},"filePaths":{"$ref":"#/types/aws-native:codepipeline:PipelineGitFilePathFilterCriteria","description":"The field that specifies to filter on file paths for the push trigger configuration."},"tags":{"$ref":"#/types/aws-native:codepipeline:PipelineGitTagFilterCriteria","description":"The field that contains the details for the Git tags trigger configuration."}},"type":"object"},"aws-native:codepipeline:PipelineGitTagFilterCriteria":{"description":"The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.","properties":{"excludes":{"type":"array","items":{"type":"string"},"description":"The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline."},"includes":{"type":"array","items":{"type":"string"},"description":"The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline."}},"type":"object"},"aws-native:codepipeline:PipelineInputArtifact":{"description":"Represents information about an artifact to be worked on, such as a test or build artifact.","properties":{"name":{"type":"string","description":"The name of the artifact to be worked on (for example, \"My App\")."}},"type":"object","required":["name"]},"aws-native:codepipeline:PipelineOutputArtifact":{"description":"Represents information about the output of an action.","properties":{"files":{"type":"array","items":{"type":"string"},"description":"The files that you want to associate with the output artifact that will be exported from the compute action."},"name":{"type":"string","description":"The name of the output of an artifact, such as \"My App\"."}},"type":"object","required":["name"]},"aws-native:codepipeline:PipelineRuleDeclaration":{"description":"Represents information about condition.","properties":{"commands":{"type":"array","items":{"type":"string"},"description":"The shell commands to run with your compute action in CodePipeline."},"configuration":{"$ref":"pulumi.json#/Any","description":"The rule's configuration. These are key-value pairs that specify input values for a rule."},"inputArtifacts":{"type":"array","items":{"$ref":"#/types/aws-native:codepipeline:PipelineInputArtifact"},"description":"The input artifacts fields for the rule, such as specifying an input file for the rule."},"name":{"type":"string","description":"The rule declaration's name."},"region":{"type":"string","description":"The rule declaration's AWS Region, such as us-east-1."},"roleArn":{"type":"string","description":"The ARN of the IAM service role that performs the declared rule. This is assumed through the roleArn for the pipeline."},"ruleTypeId":{"$ref":"#/types/aws-native:codepipeline:PipelineRuleTypeId","description":"The ID for the rule type, which is made up of the combined values for category, owner, provider, and version."}},"type":"object"},"aws-native:codepipeline:PipelineRuleTypeId":{"description":"Represents information about a rule type.","properties":{"category":{"type":"string","description":"A category for the provider type for the rule."},"owner":{"type":"string","description":"The creator of the rule being called. Only AWS is supported."},"provider":{"type":"string","description":"The provider of the service being called by the rule."},"version":{"type":"string","description":"A string that describes the rule version."}},"type":"object"},"aws-native:codepipeline:PipelineStageDeclaration":{"description":"Represents information about a stage and its definition.","properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:codepipeline:PipelineActionDeclaration"},"description":"The actions included in a stage."},"beforeEntry":{"$ref":"#/types/aws-native:codepipeline:PipelineBeforeEntryConditions","description":"The method to use before stage runs."},"blockers":{"type":"array","items":{"$ref":"#/types/aws-native:codepipeline:PipelineBlockerDeclaration"},"description":"Reserved for future use."},"name":{"type":"string","description":"The name of the stage."},"onFailure":{"$ref":"#/types/aws-native:codepipeline:PipelineFailureConditions","description":"The method to use when a stage has not completed successfully"},"onSuccess":{"$ref":"#/types/aws-native:codepipeline:PipelineSuccessConditions","description":"The method to use when a stage has completed successfully"}},"type":"object","required":["actions","name"]},"aws-native:codepipeline:PipelineStageTransition":{"description":"The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.","properties":{"reason":{"type":"string","description":"The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI."},"stageName":{"type":"string","description":"The name of the stage where you want to disable the inbound or outbound transition of artifacts."}},"type":"object","required":["reason","stageName"]},"aws-native:codepipeline:PipelineSuccessConditions":{"description":"The configuration that specifies the result, such as rollback, to occur upon stage failure","properties":{"conditions":{"type":"array","items":{"$ref":"#/types/aws-native:codepipeline:PipelineCondition"},"description":"The conditions that are success conditions."}},"type":"object"},"aws-native:codepipeline:PipelineTag":{"description":"A tag is a key-value pair that is used to manage the resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:codepipeline:PipelineTriggerDeclaration":{"description":"Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.","properties":{"gitConfiguration":{"$ref":"#/types/aws-native:codepipeline:PipelineGitConfiguration","description":"Provides the filter criteria and the source stage for the repository event that starts the pipeline, such as Git tags."},"providerType":{"$ref":"#/types/aws-native:codepipeline:PipelineTriggerDeclarationProviderType","description":"The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration."}},"type":"object","required":["providerType"]},"aws-native:codepipeline:PipelineTriggerDeclarationProviderType":{"description":"The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.","type":"string","enum":[{"name":"CodeStarSourceConnection","value":"CodeStarSourceConnection"}]},"aws-native:codepipeline:PipelineType":{"description":"CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.","type":"string","enum":[{"name":"V1","value":"V1"},{"name":"V2","value":"V2"}]},"aws-native:codepipeline:PipelineVariableDeclaration":{"description":"A variable declared at the pipeline level.","properties":{"defaultValue":{"type":"string","description":"The value of a pipeline-level variable."},"description":{"type":"string","description":"The description of a pipeline-level variable. It's used to add additional context about the variable, and not being used at time when pipeline executes."},"name":{"type":"string","description":"The name of a pipeline-level variable."}},"type":"object","required":["name"]},"aws-native:codepipeline:WebhookAuthConfiguration":{"description":"Properties that configure the authentication applied to incoming webhook trigger requests","properties":{"allowedIpRange":{"type":"string","description":"The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range."},"secretToken":{"type":"string","description":"The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set."}},"type":"object"},"aws-native:codepipeline:WebhookAuthentication":{"description":"Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.","type":"string","enum":[{"name":"GithubHmac","value":"GITHUB_HMAC"},{"name":"Ip","value":"IP"},{"name":"Unauthenticated","value":"UNAUTHENTICATED"}]},"aws-native:codepipeline:WebhookFilterRule":{"description":"A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.","properties":{"jsonPath":{"type":"string","description":"A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored."},"matchEquals":{"type":"string","description":"The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored."}},"type":"object","required":["jsonPath"]},"aws-native:codestarconnections:ConnectionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:codestarconnections:RepositoryLinkProviderType":{"description":"The name of the external provider where your third-party code repository is configured.","type":"string","enum":[{"name":"GitHub","value":"GitHub"},{"name":"Bitbucket","value":"Bitbucket"},{"name":"GitHubEnterprise","value":"GitHubEnterprise"},{"name":"GitLab","value":"GitLab"},{"name":"GitLabSelfManaged","value":"GitLabSelfManaged"}]},"aws-native:codestarconnections:RepositoryLinkTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, , ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:codestarconnections:SyncConfigurationProviderType":{"description":"The name of the external provider where your third-party code repository is configured.","type":"string","enum":[{"name":"GitHub","value":"GitHub"},{"name":"Bitbucket","value":"Bitbucket"},{"name":"GitHubEnterprise","value":"GitHubEnterprise"},{"name":"GitLab","value":"GitLab"},{"name":"GitLabSelfManaged","value":"GitLabSelfManaged"}]},"aws-native:codestarconnections:SyncConfigurationPublishDeploymentStatus":{"description":"Whether to enable or disable publishing of deployment status to source providers.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:codestarconnections:SyncConfigurationTriggerResourceUpdateOn":{"description":"When to trigger Git sync to begin the stack update.","type":"string","enum":[{"name":"AnyChange","value":"ANY_CHANGE"},{"name":"FileChange","value":"FILE_CHANGE"}]},"aws-native:codestarnotifications:NotificationRuleDetailType":{"description":"The level of detail to include in the notifications for this resource. `BASIC` will include only the contents of the event as it would appear in Amazon CloudWatch. `FULL` will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.","type":"string","enum":[{"name":"Basic","value":"BASIC"},{"name":"Full","value":"FULL"}]},"aws-native:codestarnotifications:NotificationRuleStatus":{"description":"The status of the notification rule. The default value is `ENABLED` . If the status is set to `DISABLED` , notifications aren't sent for the notification rule.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:codestarnotifications:NotificationRuleTarget":{"properties":{"targetAddress":{"type":"string","description":"The Amazon Resource Name (ARN) of the  topic or  client."},"targetType":{"type":"string","description":"The target type. Can be an Amazon Simple Notification Service topic or  client.\n\n- Amazon Simple Notification Service topics are specified as `SNS` .\n- clients are specified as `AWSChatbotSlack` .\n- clients for Microsoft Teams are specified as `AWSChatbotMicrosoftTeams` ."}},"type":"object","required":["targetAddress","targetType"]},"aws-native:cognito:IdentityPoolCognitoIdentityProvider":{"properties":{"clientId":{"type":"string","description":"The client ID for the Amazon Cognito user pool."},"providerName":{"type":"string","description":"The provider name for an Amazon Cognito user pool. For example: `cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789` ."},"serverSideTokenCheck":{"type":"boolean","description":"TRUE if server-side token validation is enabled for the identity provider’s token.\n\nAfter you set the `ServerSideTokenCheck` to TRUE for an identity pool, that identity pool checks with the integrated user pools to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.\n\nIf the user is signed out or deleted, the identity pool returns a 400 Not Authorized error."}},"type":"object","required":["clientId","providerName"]},"aws-native:cognito:IdentityPoolCognitoStreams":{"properties":{"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the role Amazon Cognito can assume to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke `PutRecord` on your Amazon Cognito stream."},"streamName":{"type":"string","description":"The name of the Amazon Cognito stream to receive updates. This stream must be in the developer's account and in the same Region as the identity pool."},"streamingStatus":{"type":"string","description":"Status of the Amazon Cognito streams. Valid values are: `ENABLED` or `DISABLED` ."}},"type":"object"},"aws-native:cognito:IdentityPoolPushSync":{"properties":{"applicationArns":{"type":"array","items":{"type":"string"},"description":"The ARNs of the Amazon SNS platform applications that could be used by clients."},"roleArn":{"type":"string","description":"An IAM role configured to allow Amazon Cognito to call Amazon SNS on behalf of the developer."}},"type":"object"},"aws-native:cognito:IdentityPoolRoleAttachmentMappingRule":{"properties":{"claim":{"type":"string"},"matchType":{"type":"string"},"roleArn":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["claim","matchType","roleArn","value"]},"aws-native:cognito:IdentityPoolRoleAttachmentRoleMapping":{"properties":{"ambiguousRoleResolution":{"type":"string"},"identityProvider":{"type":"string"},"rulesConfiguration":{"$ref":"#/types/aws-native:cognito:IdentityPoolRoleAttachmentRulesConfigurationType"},"type":{"type":"string"}},"type":"object","required":["type"]},"aws-native:cognito:IdentityPoolRoleAttachmentRulesConfigurationType":{"properties":{"rules":{"type":"array","items":{"$ref":"#/types/aws-native:cognito:IdentityPoolRoleAttachmentMappingRule"}}},"type":"object","required":["rules"]},"aws-native:cognito:IdentityPoolTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:cognito:LogDeliveryConfigurationCloudWatchLogsConfiguration":{"properties":{"logGroupArn":{"type":"string"}},"type":"object"},"aws-native:cognito:LogDeliveryConfigurationFirehoseConfiguration":{"properties":{"streamArn":{"type":"string"}},"type":"object"},"aws-native:cognito:LogDeliveryConfigurationLogConfiguration":{"properties":{"cloudWatchLogsConfiguration":{"$ref":"#/types/aws-native:cognito:LogDeliveryConfigurationCloudWatchLogsConfiguration"},"eventSource":{"type":"string"},"firehoseConfiguration":{"$ref":"#/types/aws-native:cognito:LogDeliveryConfigurationFirehoseConfiguration"},"logLevel":{"type":"string"},"s3Configuration":{"$ref":"#/types/aws-native:cognito:LogDeliveryConfigurationS3Configuration"}},"type":"object"},"aws-native:cognito:LogDeliveryConfigurationS3Configuration":{"properties":{"bucketArn":{"type":"string"}},"type":"object"},"aws-native:cognito:ManagedLoginBrandingAssetType":{"properties":{"bytes":{"type":"string"},"category":{"$ref":"#/types/aws-native:cognito:ManagedLoginBrandingCategoryType"},"colorMode":{"$ref":"#/types/aws-native:cognito:ManagedLoginBrandingColorModeType"},"extension":{"$ref":"#/types/aws-native:cognito:ManagedLoginBrandingExtensionType"},"resourceId":{"type":"string"}},"type":"object","required":["category","colorMode","extension"]},"aws-native:cognito:ManagedLoginBrandingCategoryType":{"type":"string","enum":[{"name":"FaviconIco","value":"FAVICON_ICO"},{"name":"FaviconSvg","value":"FAVICON_SVG"},{"name":"EmailGraphic","value":"EMAIL_GRAPHIC"},{"name":"SmsGraphic","value":"SMS_GRAPHIC"},{"name":"AuthAppGraphic","value":"AUTH_APP_GRAPHIC"},{"name":"PasswordGraphic","value":"PASSWORD_GRAPHIC"},{"name":"PasskeyGraphic","value":"PASSKEY_GRAPHIC"},{"name":"PageHeaderLogo","value":"PAGE_HEADER_LOGO"},{"name":"PageHeaderBackground","value":"PAGE_HEADER_BACKGROUND"},{"name":"PageFooterLogo","value":"PAGE_FOOTER_LOGO"},{"name":"PageFooterBackground","value":"PAGE_FOOTER_BACKGROUND"},{"name":"PageBackground","value":"PAGE_BACKGROUND"},{"name":"FormBackground","value":"FORM_BACKGROUND"},{"name":"FormLogo","value":"FORM_LOGO"},{"name":"IdpButtonIcon","value":"IDP_BUTTON_ICON"}]},"aws-native:cognito:ManagedLoginBrandingColorModeType":{"type":"string","enum":[{"name":"Light","value":"LIGHT"},{"name":"Dark","value":"DARK"},{"name":"Dynamic","value":"DYNAMIC"}]},"aws-native:cognito:ManagedLoginBrandingExtensionType":{"type":"string","enum":[{"name":"Ico","value":"ICO"},{"name":"Jpeg","value":"JPEG"},{"name":"Png","value":"PNG"},{"name":"Svg","value":"SVG"},{"name":"Webp","value":"WEBP"}]},"aws-native:cognito:TermsEnforcementType":{"type":"string","enum":[{"name":"None","value":"NONE"}]},"aws-native:cognito:TermsSourceType":{"type":"string","enum":[{"name":"Link","value":"LINK"}]},"aws-native:cognito:UserPoolAccountRecoverySetting":{"properties":{"recoveryMechanisms":{"type":"array","items":{"$ref":"#/types/aws-native:cognito:UserPoolRecoveryOption"},"description":"The list of options and priorities for user message delivery in forgot-password operations. Sets or displays user pool preferences for email or SMS message priority, whether users should fall back to a second delivery method, and whether passwords should only be reset by administrators."}},"type":"object"},"aws-native:cognito:UserPoolAddOns":{"properties":{"advancedSecurityAdditionalFlows":{"$ref":"#/types/aws-native:cognito:UserPoolAdvancedSecurityAdditionalFlows","description":"Threat protection configuration options for additional authentication types in your user pool, including custom authentication."},"advancedSecurityMode":{"type":"string","description":"The operating mode of threat protection for standard authentication types in your user pool, including username-password and secure remote password (SRP) authentication."}},"type":"object"},"aws-native:cognito:UserPoolAdminCreateUserConfig":{"properties":{"allowAdminCreateUserOnly":{"type":"boolean","description":"The setting for allowing self-service sign-up. When `true` , only administrators can create new user profiles. When `false` , users can register themselves and create a new user profile with the `SignUp` operation."},"inviteMessageTemplate":{"$ref":"#/types/aws-native:cognito:UserPoolInviteMessageTemplate","description":"The template for the welcome message to new users. This template must include the `{####}` temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder.\n\nSee also [Customizing User Invitation Messages](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization) ."},"unusedAccountValidityDays":{"type":"integer","description":"This parameter is no longer in use.\n\nThe password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. To reset the account after that time limit, you must call `AdminCreateUser` again, specifying `RESEND` for the `MessageAction` parameter.\n\nThe default value for this parameter is 7."}},"type":"object"},"aws-native:cognito:UserPoolAdvancedSecurityAdditionalFlows":{"properties":{"customAuthMode":{"type":"string","description":"The operating mode of threat protection in custom authentication with [Custom authentication challenge Lambda triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) ."}},"type":"object"},"aws-native:cognito:UserPoolClientAnalyticsConfiguration":{"properties":{"applicationArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that `ApplicationArn` declares. You can also configure your application to pass an endpoint ID in the `AnalyticsMetadata` parameter of sign-in operations. The endpoint ID is information about the destination for push notifications"},"applicationId":{"type":"string","description":"Your Amazon Pinpoint project ID."},"externalId":{"type":"string","description":"The [external ID](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html) of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint."},"roleArn":{"type":"string","description":"The ARN of an AWS Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics."},"userDataShared":{"type":"boolean","description":"If `UserDataShared` is `true` , Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics."}},"type":"object"},"aws-native:cognito:UserPoolClientRefreshTokenRotation":{"properties":{"feature":{"$ref":"#/types/aws-native:cognito:UserPoolClientRefreshTokenRotationFeature","description":"The state of refresh token rotation for the current app client."},"retryGracePeriodSeconds":{"type":"integer","description":"When you request a token refresh with `GetTokensFromRefreshToken` , the original refresh token that you're rotating out can remain valid for a period of time of up to 60 seconds. This allows for client-side retries. When `RetryGracePeriodSeconds` is `0` , the grace period is disabled and a successful request immediately invalidates the submitted refresh token."}},"type":"object"},"aws-native:cognito:UserPoolClientRefreshTokenRotationFeature":{"description":"The state of refresh token rotation for the current app client.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:cognito:UserPoolClientTokenValidityUnits":{"properties":{"accessToken":{"type":"string","description":"A time unit for the value that you set in the `AccessTokenValidity` parameter. The default `AccessTokenValidity` time unit is `hours` . `AccessTokenValidity` duration can range from five minutes to one day."},"idToken":{"type":"string","description":"A time unit for the value that you set in the `IdTokenValidity` parameter. The default `IdTokenValidity` time unit is `hours` . `IdTokenValidity` duration can range from five minutes to one day."},"refreshToken":{"type":"string","description":"A time unit for the value that you set in the `RefreshTokenValidity` parameter. The default `RefreshTokenValidity` time unit is `days` . `RefreshTokenValidity` duration can range from 60 minutes to 10 years."}},"type":"object"},"aws-native:cognito:UserPoolCustomEmailSender":{"properties":{"lambdaArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger."},"lambdaVersion":{"type":"string","description":"The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.\n\nYou must use a `LambdaVersion` of `V1_0` with a custom sender function."}},"type":"object"},"aws-native:cognito:UserPoolCustomSmsSender":{"properties":{"lambdaArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger."},"lambdaVersion":{"type":"string","description":"The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.\n\nYou must use a `LambdaVersion` of `V1_0` with a custom sender function."}},"type":"object"},"aws-native:cognito:UserPoolDeviceConfiguration":{"properties":{"challengeRequiredOnNewDevice":{"type":"boolean","description":"When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).\n\n\u003e Whether or not `ChallengeRequiredOnNewDevice` is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA."},"deviceOnlyRememberedOnUserPrompt":{"type":"boolean","description":"When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a `ConfirmDevice` API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an `UpdateDeviceStatus` API request.\n\nWhen `DeviceOnlyRememberedOnUserPrompt` is `false` , Amazon Cognito immediately remembers devices that you register in a `ConfirmDevice` API request."}},"type":"object"},"aws-native:cognito:UserPoolDomainCustomDomainConfigType":{"properties":{"certificateArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain."}},"type":"object"},"aws-native:cognito:UserPoolEmailConfiguration":{"properties":{"configurationSet":{"type":"string","description":"The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:\n\n- **Event publishing** - Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other AWS services such as and Amazon CloudWatch\n- **IP pool management** - When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets."},"emailSendingAccount":{"type":"string","description":"Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:\n\n- **COGNITO_DEFAULT** - When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.\n\nTo look up the email delivery limit for the default option, see [Limits](https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html) in the *Amazon Cognito Developer Guide* .\n\nThe default FROM address is `no-reply@verificationemail.com` . To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the `SourceArn` parameter.\n- **DEVELOPER** - When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account .\n\nIf you use this option, provide the ARN of an Amazon SES verified email address for the `SourceArn` parameter.\n\nBefore Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a *service-linked role* , which is a type of role in your AWS account . This role contains the permissions that allow you to access Amazon SES and send email messages from your email address. For more information about the service-linked role that Amazon Cognito creates, see [Using Service-Linked Roles for Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html) in the *Amazon Cognito Developer Guide* ."},"from":{"type":"string","description":"Either the sender’s email address or the sender’s name with their email address. For example, `testuser@example.com` or `Test User \u003ctestuser@example.com\u003e` . This address appears before the body of the email."},"replyToEmailAddress":{"type":"string","description":"The destination to which the receiver of the email should reply."},"sourceArn":{"type":"string","description":"The ARN of a verified email address or an address from a verified domain in Amazon SES. You can set a `SourceArn` email from a verified domain only with an API request. You can set a verified email address, but not an address in a verified domain, in the Amazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following ways, depending on the value that you specify for the `EmailSendingAccount` parameter:\n\n- If you specify `COGNITO_DEFAULT` , Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.\n- If you specify `DEVELOPER` , Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.\n\nThe Region value of the `SourceArn` parameter must indicate a supported AWS Region of your user pool. Typically, the Region in the `SourceArn` and the user pool Region are the same. For more information, see [Amazon SES email configuration regions](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html#user-pool-email-developer-region-mapping) in the [Amazon Cognito Developer Guide](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) ."}},"type":"object"},"aws-native:cognito:UserPoolInboundFederation":{"properties":{"lambdaArn":{"type":"string"},"lambdaVersion":{"type":"string"}},"type":"object"},"aws-native:cognito:UserPoolInviteMessageTemplate":{"properties":{"emailMessage":{"type":"string","description":"The message template for email messages. EmailMessage is allowed only if [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER."},"emailSubject":{"type":"string","description":"The subject line for email messages. EmailSubject is allowed only if [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER."},"smsMessage":{"type":"string","description":"The message template for SMS messages."}},"type":"object"},"aws-native:cognito:UserPoolLambdaConfig":{"properties":{"createAuthChallenge":{"type":"string","description":"The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the [custom authentication challenge triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) ."},"customEmailSender":{"$ref":"#/types/aws-native:cognito:UserPoolCustomEmailSender","description":"The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic."},"customMessage":{"type":"string","description":"A custom message Lambda trigger. This trigger is an opportunity to customize all SMS and email messages from your user pool. When a custom message trigger is active, your user pool routes all messages to a Lambda function that returns a runtime-customized message subject and body for your user pool to deliver to a user."},"customSmsSender":{"$ref":"#/types/aws-native:cognito:UserPoolCustomSmsSender","description":"The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic."},"defineAuthChallenge":{"type":"string","description":"The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the [custom authentication challenge triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) ."},"inboundFederation":{"$ref":"#/types/aws-native:cognito:UserPoolInboundFederation"},"kmsKeyId":{"type":"string","description":"The ARN of an [KMS key](https://docs.aws.amazon.com//kms/latest/developerguide/concepts.html#master_keys) . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers."},"postAuthentication":{"type":"string","description":"The configuration of a [post authentication Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-authentication.html) in a user pool. This trigger can take custom actions after a user signs in."},"postConfirmation":{"type":"string","description":"The configuration of a [post confirmation Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-confirmation.html) in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number."},"preAuthentication":{"type":"string","description":"The configuration of a [pre authentication trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-authentication.html) in a user pool. This trigger can evaluate and modify user sign-in events."},"preSignUp":{"type":"string","description":"The configuration of a [pre sign-up Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html) in a user pool. This trigger evaluates new users and can bypass confirmation, [link a federated user profile](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html) , or block sign-up requests."},"preTokenGeneration":{"type":"string","description":"The legacy configuration of a [pre token generation Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html) in a user pool.\n\nSet this parameter for legacy purposes. If you also set an ARN in `PreTokenGenerationConfig` , its value must be identical to `PreTokenGeneration` . For new instances of pre token generation triggers, set the `LambdaArn` of `PreTokenGenerationConfig` ."},"preTokenGenerationConfig":{"$ref":"#/types/aws-native:cognito:UserPoolPreTokenGenerationConfig","description":"The detailed configuration of a [pre token generation Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html) in a user pool. If you also set an ARN in `PreTokenGeneration` , its value must be identical to `PreTokenGenerationConfig` ."},"userMigration":{"type":"string","description":"The configuration of a [migrate user Lambda trigger](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-migrate-user.html) in a user pool. This trigger can create user profiles when users sign in or attempt to reset their password with credentials that don't exist yet."},"verifyAuthChallengeResponse":{"type":"string","description":"The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the [custom authentication challenge triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html) ."}},"type":"object"},"aws-native:cognito:UserPoolNumberAttributeConstraints":{"properties":{"maxValue":{"type":"string","description":"The maximum length of a number attribute value. Must be a number less than or equal to `2^1023` , represented as a string with a length of 131072 characters or fewer."},"minValue":{"type":"string","description":"The minimum value of an attribute that is of the number data type."}},"type":"object"},"aws-native:cognito:UserPoolPasswordPolicy":{"properties":{"minimumLength":{"type":"integer","description":"The minimum length of the password in the policy that you have set. This value can't be less than 6."},"passwordHistorySize":{"type":"integer","description":"The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of `n` previous passwords, where `n` is the value of `PasswordHistorySize` ."},"requireLowercase":{"type":"boolean","description":"The requirement in a password policy that users must include at least one lowercase letter in their password."},"requireNumbers":{"type":"boolean","description":"The requirement in a password policy that users must include at least one number in their password."},"requireSymbols":{"type":"boolean","description":"The requirement in a password policy that users must include at least one symbol in their password."},"requireUppercase":{"type":"boolean","description":"The requirement in a password policy that users must include at least one uppercase letter in their password."},"temporaryPasswordValidityDays":{"type":"integer","description":"The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. Defaults to `7` . If you submit a value of `0` , Amazon Cognito treats it as a null value and sets `TemporaryPasswordValidityDays` to its default value.\n\n\u003e When you set `TemporaryPasswordValidityDays` for a user pool, you can no longer set a value for the legacy `UnusedAccountValidityDays` parameter in that user pool."}},"type":"object"},"aws-native:cognito:UserPoolPolicies":{"properties":{"passwordPolicy":{"$ref":"#/types/aws-native:cognito:UserPoolPasswordPolicy","description":"The password policy settings for a user pool, including complexity, history, and length requirements."},"signInPolicy":{"$ref":"#/types/aws-native:cognito:UserPoolSignInPolicy","description":"The policy for allowed types of authentication in a user pool. To activate this setting, your user pool must be in the [Essentials tier](https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html) or higher."}},"type":"object"},"aws-native:cognito:UserPoolPreTokenGenerationConfig":{"properties":{"lambdaArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.\n\nThis parameter and the `PreTokenGeneration` property of `LambdaConfig` have the same value. For new instances of pre token generation triggers, set `LambdaArn` ."},"lambdaVersion":{"type":"string","description":"The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features."}},"type":"object"},"aws-native:cognito:UserPoolRecoveryOption":{"properties":{"name":{"type":"string","description":"The recovery method that this object sets a recovery option for."},"priority":{"type":"integer","description":"Your priority preference for using the specified attribute in account recovery. The highest priority is `1` ."}},"type":"object"},"aws-native:cognito:UserPoolResourceServerResourceServerScopeType":{"properties":{"scopeDescription":{"type":"string","description":"A friendly description of a custom scope."},"scopeName":{"type":"string","description":"The name of the scope. Amazon Cognito renders custom scopes in the format `resourceServerIdentifier/ScopeName` . For example, if this parameter is `exampleScope` in the resource server with the identifier `exampleResourceServer` , you request and receive the scope `exampleResourceServer/exampleScope` ."}},"type":"object","required":["scopeDescription","scopeName"]},"aws-native:cognito:UserPoolRiskConfigurationAttachmentAccountTakeoverActionType":{"properties":{"eventAction":{"type":"string","description":"The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows:\n\n- `BLOCK` : Block the request.\n- `MFA_IF_CONFIGURED` : Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.\n- `MFA_REQUIRED` : Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.\n- `NO_ACTION` : Take no action. Permit sign-in."},"notify":{"type":"boolean","description":"Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level."}},"type":"object","required":["eventAction","notify"]},"aws-native:cognito:UserPoolRiskConfigurationAttachmentAccountTakeoverActionsType":{"properties":{"highAction":{"$ref":"#/types/aws-native:cognito:UserPoolRiskConfigurationAttachmentAccountTakeoverActionType","description":"The action that you assign to a high-risk assessment by threat protection."},"lowAction":{"$ref":"#/types/aws-native:cognito:UserPoolRiskConfigurationAttachmentAccountTakeoverActionType","description":"The action that you assign to a low-risk assessment by threat protection."},"mediumAction":{"$ref":"#/types/aws-native:cognito:UserPoolRiskConfigurationAttachmentAccountTakeoverActionType","description":"The action that you assign to a medium-risk assessment by threat protection."}},"type":"object"},"aws-native:cognito:UserPoolRiskConfigurationAttachmentAccountTakeoverRiskConfigurationType":{"properties":{"actions":{"$ref":"#/types/aws-native:cognito:UserPoolRiskConfigurationAttachmentAccountTakeoverActionsType","description":"A list of account-takeover actions for each level of risk that Amazon Cognito might assess with threat protection."},"notifyConfiguration":{"$ref":"#/types/aws-native:cognito:UserPoolRiskConfigurationAttachmentNotifyConfigurationType","description":"The settings for composing and sending an email message when threat protection assesses a risk level with adaptive authentication. When you choose to notify users in `AccountTakeoverRiskConfiguration` , Amazon Cognito sends an email message using the method and template that you set with this data type."}},"type":"object","required":["actions"]},"aws-native:cognito:UserPoolRiskConfigurationAttachmentCompromisedCredentialsActionsType":{"properties":{"eventAction":{"type":"string","description":"The action that Amazon Cognito takes when it detects compromised credentials."}},"type":"object","required":["eventAction"]},"aws-native:cognito:UserPoolRiskConfigurationAttachmentCompromisedCredentialsRiskConfigurationType":{"properties":{"actions":{"$ref":"#/types/aws-native:cognito:UserPoolRiskConfigurationAttachmentCompromisedCredentialsActionsType","description":"Settings for the actions that you want your user pool to take when Amazon Cognito detects compromised credentials."},"eventFilter":{"type":"array","items":{"type":"string"},"description":"Settings for the sign-in activity where you want to configure compromised-credentials actions. Defaults to all events."}},"type":"object","required":["actions"]},"aws-native:cognito:UserPoolRiskConfigurationAttachmentNotifyConfigurationType":{"properties":{"blockEmail":{"$ref":"#/types/aws-native:cognito:UserPoolRiskConfigurationAttachmentNotifyEmailType","description":"The template for the email message that your user pool sends when a detected risk event is blocked."},"from":{"type":"string","description":"The email address that sends the email message. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES."},"mfaEmail":{"$ref":"#/types/aws-native:cognito:UserPoolRiskConfigurationAttachmentNotifyEmailType","description":"The template for the email message that your user pool sends when MFA is challenged in response to a detected risk."},"noActionEmail":{"$ref":"#/types/aws-native:cognito:UserPoolRiskConfigurationAttachmentNotifyEmailType","description":"The template for the email message that your user pool sends when no action is taken in response to a detected risk."},"replyTo":{"type":"string","description":"The reply-to email address of an email template. Can be an email address in the format `admin@example.com` or `Administrator \u003cadmin@example.com\u003e` ."},"sourceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the `From` parameter."}},"type":"object","required":["sourceArn"]},"aws-native:cognito:UserPoolRiskConfigurationAttachmentNotifyEmailType":{"properties":{"htmlBody":{"type":"string","description":"The body of an email notification formatted in HTML. Choose an `HtmlBody` or a `TextBody` to send an HTML-formatted or plaintext message, respectively."},"subject":{"type":"string","description":"The subject of the threat protection email notification."},"textBody":{"type":"string","description":"The body of an email notification formatted in plaintext. Choose an `HtmlBody` or a `TextBody` to send an HTML-formatted or plaintext message, respectively."}},"type":"object","required":["subject"]},"aws-native:cognito:UserPoolRiskConfigurationAttachmentRiskExceptionConfigurationType":{"properties":{"blockedIpRangeList":{"type":"array","items":{"type":"string"},"description":"An always-block IP address list. Overrides the risk decision and always blocks authentication requests. This parameter is displayed and set in CIDR notation."},"skippedIpRangeList":{"type":"array","items":{"type":"string"},"description":"An always-allow IP address list. Risk detection isn't performed on the IP addresses in this range list. This parameter is displayed and set in CIDR notation."}},"type":"object"},"aws-native:cognito:UserPoolSchemaAttribute":{"properties":{"attributeDataType":{"type":"string","description":"The data format of the values for your attribute. When you choose an `AttributeDataType` , Amazon Cognito validates the input against the data type. A custom attribute value in your user's ID token is always a string, for example `\"custom:isMember\" : \"true\"` or `\"custom:YearsAsMember\" : \"12\"` ."},"developerOnlyAttribute":{"type":"boolean","description":"\u003e You should use [WriteAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes) in the user pool client to control how attributes can be mutated for new use cases instead of using `DeveloperOnlyAttribute` . \n\nSpecifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example, `DeveloperOnlyAttribute` can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes."},"mutable":{"type":"boolean","description":"Specifies whether the value of the attribute can be changed.\n\nAny user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of `true` . Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see [Specifying Identity Provider Attribute Mappings for Your User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html) ."},"name":{"type":"string","description":"The name of your user pool attribute. When you create or update a user pool, adding a schema attribute creates a custom or developer-only attribute. When you add an attribute with a `Name` value of `MyAttribute` , Amazon Cognito creates the custom attribute `custom:MyAttribute` . When `DeveloperOnlyAttribute` is `true` , Amazon Cognito creates your attribute as `dev:MyAttribute` . In an operation that describes a user pool, Amazon Cognito returns this value as `value` for standard attributes, `custom:value` for custom attributes, and `dev:value` for developer-only attributes.."},"numberAttributeConstraints":{"$ref":"#/types/aws-native:cognito:UserPoolNumberAttributeConstraints","description":"Specifies the constraints for an attribute of the number type."},"required":{"type":"boolean","description":"Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail."},"stringAttributeConstraints":{"$ref":"#/types/aws-native:cognito:UserPoolStringAttributeConstraints","description":"Specifies the constraints for an attribute of the string type."}},"type":"object"},"aws-native:cognito:UserPoolSignInPolicy":{"properties":{"allowedFirstAuthFactors":{"type":"array","items":{"type":"string"},"description":"The sign-in methods that a user pool supports as the first factor. You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors.\n\nSupports values of `EMAIL_OTP` , `SMS_OTP` , `WEB_AUTHN` and `PASSWORD` ,"}},"type":"object"},"aws-native:cognito:UserPoolSmsConfiguration":{"properties":{"externalId":{"type":"string","description":"The external ID provides additional security for your IAM role. You can use an `ExternalId` with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an `ExternalId` , your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the `ExternalID` . If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the `ExternalId` .\n\nFor more information about the `ExternalId` of a role, see [How to use an external ID when granting access to your AWS resources to a third party](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html) ."},"snsCallerArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your AWS account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a [spending limit](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html) ."},"snsRegion":{"type":"string","description":"The AWS Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported *Legacy Amazon SNS alternate Region* .\n\nAmazon Cognito resources in the Asia Pacific (Seoul) AWS Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see [SMS message settings for Amazon Cognito user pools](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) ."}},"type":"object"},"aws-native:cognito:UserPoolStringAttributeConstraints":{"properties":{"maxLength":{"type":"string","description":"The maximum length of a string attribute value. Must be a number less than or equal to `2^1023` , represented as a string with a length of 131072 characters or fewer."},"minLength":{"type":"string","description":"The minimum length of a string attribute value."}},"type":"object"},"aws-native:cognito:UserPoolTier":{"description":"The user pool [feature plan](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html) , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to `ESSENTIALS` .","type":"string","enum":[{"name":"Lite","value":"LITE"},{"name":"Essentials","value":"ESSENTIALS"},{"name":"Plus","value":"PLUS"}]},"aws-native:cognito:UserPoolUserAttributeType":{"properties":{"name":{"type":"string","description":"The name of the attribute."},"value":{"type":"string","description":"The value of the attribute."}},"type":"object"},"aws-native:cognito:UserPoolUserAttributeUpdateSettings":{"properties":{"attributesRequireVerificationBeforeUpdate":{"type":"array","items":{"type":"string"},"description":"Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.\n\nWhen `AttributesRequireVerificationBeforeUpdate` is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where `AttributesRequireVerificationBeforeUpdate` is false, API operations that change attribute values can immediately update a user’s `email` or `phone_number` attribute."}},"type":"object","required":["attributesRequireVerificationBeforeUpdate"]},"aws-native:cognito:UserPoolUsernameConfiguration":{"properties":{"caseSensitive":{"type":"boolean","description":"Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to `False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name.\n\nValid values include:\n\n- **true** - Enables case sensitivity for all username input. When this option is set to `true` , users must sign in using the exact capitalization of their given username, such as \"UserName\". This is the default value.\n- **false** - Enables case insensitivity for all username input. For example, when this option is set to `false` , users can sign in using `username` , `USERNAME` , or `UserName` . This option also enables both `preferred_username` and `email` alias to be case insensitive, in addition to the `username` attribute."}},"type":"object"},"aws-native:cognito:UserPoolVerificationMessageTemplate":{"properties":{"defaultEmailOption":{"type":"string","description":"The configuration of verification emails to contain a clickable link or a verification code.\n\nFor link, your template body must contain link text in the format `{##Click here##}` . \"Click here\" in the example is a customizable string. For code, your template body must contain a code placeholder in the format `{####}` ."},"emailMessage":{"type":"string","description":"The template for email messages that Amazon Cognito sends to your users. You can set an `EmailMessage` template only if the value of [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` . When your [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` , your user pool sends email messages with your own Amazon SES configuration."},"emailMessageByLink":{"type":"string","description":"The email message template for sending a confirmation link to the user. You can set an `EmailMessageByLink` template only if the value of [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` . When your [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` , your user pool sends email messages with your own Amazon SES configuration."},"emailSubject":{"type":"string","description":"The subject line for the email message template. You can set an `EmailSubject` template only if the value of [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` . When your [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` , your user pool sends email messages with your own Amazon SES configuration."},"emailSubjectByLink":{"type":"string","description":"The subject line for the email message template for sending a confirmation link to the user. You can set an `EmailSubjectByLink` template only if the value of [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` . When your [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is `DEVELOPER` , your user pool sends email messages with your own Amazon SES configuration."},"smsMessage":{"type":"string","description":"The template for SMS messages that Amazon Cognito sends to your users."}},"type":"object"},"aws-native:comprehend:DocumentClassifierAugmentedManifestsListItem":{"properties":{"attributeNames":{"type":"array","items":{"type":"string"},"description":"The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.\n\nIf your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.\n\nIf your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job."},"s3Uri":{"type":"string","description":"The Amazon S3 location of the augmented manifest file."},"split":{"$ref":"#/types/aws-native:comprehend:DocumentClassifierAugmentedManifestsListItemSplit","description":"The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.\n\nTRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.\n\nTEST - all of the documents in the manifest will be used for testing."}},"type":"object","required":["attributeNames","s3Uri"]},"aws-native:comprehend:DocumentClassifierAugmentedManifestsListItemSplit":{"description":"The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.\n\nTRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.\n\nTEST - all of the documents in the manifest will be used for testing.","type":"string","enum":[{"name":"Train","value":"TRAIN"},{"name":"Test","value":"TEST"}]},"aws-native:comprehend:DocumentClassifierDocumentReaderConfig":{"properties":{"documentReadAction":{"$ref":"#/types/aws-native:comprehend:DocumentClassifierDocumentReaderConfigDocumentReadAction","description":"This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:\n\n- `TEXTRACT_DETECT_DOCUMENT_TEXT` - The Amazon Comprehend service uses the `DetectDocumentText` API operation.\n- `TEXTRACT_ANALYZE_DOCUMENT` - The Amazon Comprehend service uses the `AnalyzeDocument` API operation."},"documentReadMode":{"$ref":"#/types/aws-native:comprehend:DocumentClassifierDocumentReaderConfigDocumentReadMode","description":"Determines the text extraction actions for PDF files. Enter one of the following values:\n\n- `SERVICE_DEFAULT` - use the Amazon Comprehend service defaults for PDF files.\n- `FORCE_DOCUMENT_READ_ACTION` - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files."},"featureTypes":{"type":"array","items":{"$ref":"#/types/aws-native:comprehend:DocumentClassifierDocumentReaderConfigFeatureTypesItem"},"description":"Specifies the type of Amazon Textract features to apply. If you chose `TEXTRACT_ANALYZE_DOCUMENT` as the read action, you must specify one or both of the following values:\n\n- `TABLES` - Returns additional information about any tables that are detected in the input document.\n- `FORMS` - Returns additional information about any forms that are detected in the input document."}},"type":"object","required":["documentReadAction"]},"aws-native:comprehend:DocumentClassifierDocumentReaderConfigDocumentReadAction":{"description":"This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:\n\n- `TEXTRACT_DETECT_DOCUMENT_TEXT` - The Amazon Comprehend service uses the `DetectDocumentText` API operation.\n- `TEXTRACT_ANALYZE_DOCUMENT` - The Amazon Comprehend service uses the `AnalyzeDocument` API operation.","type":"string","enum":[{"name":"TextractDetectDocumentText","value":"TEXTRACT_DETECT_DOCUMENT_TEXT"},{"name":"TextractAnalyzeDocument","value":"TEXTRACT_ANALYZE_DOCUMENT"}]},"aws-native:comprehend:DocumentClassifierDocumentReaderConfigDocumentReadMode":{"description":"Determines the text extraction actions for PDF files. Enter one of the following values:\n\n- `SERVICE_DEFAULT` - use the Amazon Comprehend service defaults for PDF files.\n- `FORCE_DOCUMENT_READ_ACTION` - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.","type":"string","enum":[{"name":"ServiceDefault","value":"SERVICE_DEFAULT"},{"name":"ForceDocumentReadAction","value":"FORCE_DOCUMENT_READ_ACTION"}]},"aws-native:comprehend:DocumentClassifierDocumentReaderConfigFeatureTypesItem":{"type":"string","enum":[{"name":"Tables","value":"TABLES"},{"name":"Forms","value":"FORMS"}]},"aws-native:comprehend:DocumentClassifierDocuments":{"properties":{"s3Uri":{"type":"string","description":"The S3 URI location of the training documents specified in the S3Uri CSV file."},"testS3Uri":{"type":"string","description":"The S3 URI location of the test documents included in the TestS3Uri CSV file. This field is not required if you do not specify a test CSV file."}},"type":"object","required":["s3Uri"]},"aws-native:comprehend:DocumentClassifierInputDataConfig":{"properties":{"augmentedManifests":{"type":"array","items":{"$ref":"#/types/aws-native:comprehend:DocumentClassifierAugmentedManifestsListItem"},"description":"A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.\n\nThis parameter is required if you set `DataFormat` to `AUGMENTED_MANIFEST` ."},"dataFormat":{"$ref":"#/types/aws-native:comprehend:DocumentClassifierInputDataConfigDataFormat","description":"The format of your training data:\n\n- `COMPREHEND_CSV` : A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the `S3Uri` parameter in your request.\n- `AUGMENTED_MANIFEST` : A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.\n\nIf you use this value, you must provide the `AugmentedManifests` parameter in your request.\n\nIf you don't specify a value, Amazon Comprehend uses `COMPREHEND_CSV` as the default."},"documentReaderConfig":{"$ref":"#/types/aws-native:comprehend:DocumentClassifierDocumentReaderConfig"},"documentType":{"$ref":"#/types/aws-native:comprehend:DocumentClassifierInputDataConfigDocumentType","description":"The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model."},"documents":{"$ref":"#/types/aws-native:comprehend:DocumentClassifierDocuments","description":"The S3 location of the training documents. This parameter is required in a request to create a native document model."},"labelDelimiter":{"type":"string","description":"Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL."},"s3Uri":{"type":"string","description":"The Amazon S3 URI for the input data. The S3 bucket must be in the same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.\n\nFor example, if you use the URI `S3://bucketName/prefix` , if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.\n\nThis parameter is required if you set `DataFormat` to `COMPREHEND_CSV` ."},"testS3Uri":{"type":"string","description":"This specifies the Amazon S3 location that contains the test annotations for the document classifier. The URI must be in the same AWS Region as the API endpoint that you are calling."}},"type":"object"},"aws-native:comprehend:DocumentClassifierInputDataConfigDataFormat":{"description":"The format of your training data:\n\n- `COMPREHEND_CSV` : A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the `S3Uri` parameter in your request.\n- `AUGMENTED_MANIFEST` : A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels.\n\nIf you use this value, you must provide the `AugmentedManifests` parameter in your request.\n\nIf you don't specify a value, Amazon Comprehend uses `COMPREHEND_CSV` as the default.","type":"string","enum":[{"name":"ComprehendCsv","value":"COMPREHEND_CSV"},{"name":"AugmentedManifest","value":"AUGMENTED_MANIFEST"}]},"aws-native:comprehend:DocumentClassifierInputDataConfigDocumentType":{"description":"The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.","type":"string","enum":[{"name":"PlainTextDocument","value":"PLAIN_TEXT_DOCUMENT"},{"name":"SemiStructuredDocument","value":"SEMI_STRUCTURED_DOCUMENT"}]},"aws-native:comprehend:DocumentClassifierLanguageCode":{"description":"The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.","type":"string","enum":[{"name":"En","value":"en"},{"name":"Es","value":"es"},{"name":"Fr","value":"fr"},{"name":"It","value":"it"},{"name":"De","value":"de"},{"name":"Pt","value":"pt"}]},"aws-native:comprehend:DocumentClassifierMode":{"description":"Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).","type":"string","enum":[{"name":"MultiClass","value":"MULTI_CLASS"},{"name":"MultiLabel","value":"MULTI_LABEL"}]},"aws-native:comprehend:DocumentClassifierOutputDataConfig":{"properties":{"kmsKeyId":{"type":"string","description":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:\n\n- KMS Key ID: `\"1234abcd-12ab-34cd-56ef-1234567890ab\"`\n- Amazon Resource Name (ARN) of a KMS Key: `\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"`\n- KMS Key Alias: `\"alias/ExampleAlias\"`\n- ARN of a KMS Key Alias: `\"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"`"},"s3Uri":{"type":"string","description":"When you use the `OutputDataConfig` object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.\n\nWhen the custom classifier job is finished, the service creates the output file in a directory specific to the job. The `S3Uri` field contains the location of the output file, called `output.tar.gz` . It is a compressed archive that contains the confusion matrix."}},"type":"object"},"aws-native:comprehend:DocumentClassifierTag":{"properties":{"key":{"type":"string","description":"The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use \"Department\" as the key portion of the pair, with multiple possible values such as \"sales,\" \"legal,\" and \"administration.\""},"value":{"type":"string","description":"The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use \"Department\" as the initial (key) portion of the pair, with a value of \"sales\" to indicate the sales department."}},"type":"object","required":["key","value"]},"aws-native:comprehend:DocumentClassifierVpcConfig":{"properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by \"sg-\", for instance: \"sg-03b388029b0a285ea\". For more information, see [Security Groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) ."},"subnets":{"type":"array","items":{"type":"string"},"description":"The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by \"subnet-\", for instance: \"subnet-04ccf456919e69055\". For more information, see [VPCs and Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) ."}},"type":"object","required":["securityGroupIds","subnets"]},"aws-native:comprehend:FlywheelDataSecurityConfig":{"properties":{"dataLakeKmsKeyId":{"type":"string","description":"ID for the AWS  key that Amazon Comprehend uses to encrypt the data in the data lake."},"modelKmsKeyId":{"type":"string","description":"ID for the AWS  key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:\n\n- KMS Key ID: `\"1234abcd-12ab-34cd-56ef-1234567890ab\"`\n- Amazon Resource Name (ARN) of a KMS Key: `\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"`"},"volumeKmsKeyId":{"type":"string","description":"ID for the AWS  key that Amazon Comprehend uses to encrypt the volume."},"vpcConfig":{"$ref":"#/types/aws-native:comprehend:FlywheelVpcConfig","description":"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see [Amazon VPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html) ."}},"type":"object"},"aws-native:comprehend:FlywheelDocumentClassificationConfig":{"properties":{"labels":{"type":"array","items":{"type":"string"},"description":"One or more labels to associate with the custom classifier."},"mode":{"$ref":"#/types/aws-native:comprehend:FlywheelDocumentClassificationConfigMode","description":"Classification mode indicates whether the documents are `MULTI_CLASS` or `MULTI_LABEL` ."}},"type":"object","required":["mode"]},"aws-native:comprehend:FlywheelDocumentClassificationConfigMode":{"description":"Classification mode indicates whether the documents are `MULTI_CLASS` or `MULTI_LABEL` .","type":"string","enum":[{"name":"MultiClass","value":"MULTI_CLASS"},{"name":"MultiLabel","value":"MULTI_LABEL"}]},"aws-native:comprehend:FlywheelEntityRecognitionConfig":{"properties":{"entityTypes":{"type":"array","items":{"$ref":"#/types/aws-native:comprehend:FlywheelEntityTypesListItem"},"description":"Up to 25 entity types that the model is trained to recognize."}},"type":"object"},"aws-native:comprehend:FlywheelEntityTypesListItem":{"properties":{"type":{"type":"string","description":"An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.\n\nEntity types must not contain the following invalid characters: \\n (line break), \\\\n (escaped line break, \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab), and , (comma)."}},"type":"object","required":["type"]},"aws-native:comprehend:FlywheelModelType":{"description":"Model type of the flywheel's model.","type":"string","enum":[{"name":"DocumentClassifier","value":"DOCUMENT_CLASSIFIER"},{"name":"EntityRecognizer","value":"ENTITY_RECOGNIZER"}]},"aws-native:comprehend:FlywheelTag":{"properties":{"key":{"type":"string","description":"The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use \"Department\" as the key portion of the pair, with multiple possible values such as \"sales,\" \"legal,\" and \"administration.\""},"value":{"type":"string","description":"The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use \"Department\" as the initial (key) portion of the pair, with a value of \"sales\" to indicate the sales department."}},"type":"object","required":["key","value"]},"aws-native:comprehend:FlywheelTaskConfig":{"properties":{"documentClassificationConfig":{"$ref":"#/types/aws-native:comprehend:FlywheelDocumentClassificationConfig","description":"Configuration required for a document classification model."},"entityRecognitionConfig":{"$ref":"#/types/aws-native:comprehend:FlywheelEntityRecognitionConfig","description":"Configuration required for an entity recognition model."},"languageCode":{"$ref":"#/types/aws-native:comprehend:FlywheelTaskConfigLanguageCode","description":"Language code for the language that the model supports."}},"type":"object","required":["languageCode"]},"aws-native:comprehend:FlywheelTaskConfigLanguageCode":{"description":"Language code for the language that the model supports.","type":"string","enum":[{"name":"En","value":"en"},{"name":"Es","value":"es"},{"name":"Fr","value":"fr"},{"name":"It","value":"it"},{"name":"De","value":"de"},{"name":"Pt","value":"pt"}]},"aws-native:comprehend:FlywheelVpcConfig":{"properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by \"sg-\", for instance: \"sg-03b388029b0a285ea\". For more information, see [Security Groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) ."},"subnets":{"type":"array","items":{"type":"string"},"description":"The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by \"subnet-\", for instance: \"subnet-04ccf456919e69055\". For more information, see [VPCs and Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) ."}},"type":"object","required":["securityGroupIds","subnets"]},"aws-native:computeoptimizer:AutomationRuleCriteria":{"properties":{"ebsVolumeSizeInGib":{"type":"array","items":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleIntegerCriteriaCondition"}},"ebsVolumeType":{"type":"array","items":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleStringCriteriaCondition"}},"estimatedMonthlySavings":{"type":"array","items":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleDoubleCriteriaCondition"}},"lookBackPeriodInDays":{"type":"array","items":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleIntegerCriteriaCondition"}},"region":{"type":"array","items":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleStringCriteriaCondition"}},"resourceArn":{"type":"array","items":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleStringCriteriaCondition"}},"resourceTag":{"type":"array","items":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleResourceTagsCriteriaCondition"}},"restartNeeded":{"type":"array","items":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleStringCriteriaCondition"}}},"type":"object"},"aws-native:computeoptimizer:AutomationRuleDoubleCriteriaCondition":{"properties":{"comparison":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleDoubleCriteriaConditionComparison"},"values":{"type":"array","items":{"type":"number"}}},"type":"object"},"aws-native:computeoptimizer:AutomationRuleDoubleCriteriaConditionComparison":{"type":"string","enum":[{"name":"StringEquals","value":"StringEquals"},{"name":"StringNotEquals","value":"StringNotEquals"},{"name":"StringEqualsIgnoreCase","value":"StringEqualsIgnoreCase"},{"name":"StringNotEqualsIgnoreCase","value":"StringNotEqualsIgnoreCase"},{"name":"StringLike","value":"StringLike"},{"name":"StringNotLike","value":"StringNotLike"},{"name":"NumericEquals","value":"NumericEquals"},{"name":"NumericNotEquals","value":"NumericNotEquals"},{"name":"NumericLessThan","value":"NumericLessThan"},{"name":"NumericLessThanEquals","value":"NumericLessThanEquals"},{"name":"NumericGreaterThan","value":"NumericGreaterThan"},{"name":"NumericGreaterThanEquals","value":"NumericGreaterThanEquals"}]},"aws-native:computeoptimizer:AutomationRuleIntegerCriteriaCondition":{"properties":{"comparison":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleIntegerCriteriaConditionComparison"},"values":{"type":"array","items":{"type":"integer"}}},"type":"object"},"aws-native:computeoptimizer:AutomationRuleIntegerCriteriaConditionComparison":{"type":"string","enum":[{"name":"StringEquals","value":"StringEquals"},{"name":"StringNotEquals","value":"StringNotEquals"},{"name":"StringEqualsIgnoreCase","value":"StringEqualsIgnoreCase"},{"name":"StringNotEqualsIgnoreCase","value":"StringNotEqualsIgnoreCase"},{"name":"StringLike","value":"StringLike"},{"name":"StringNotLike","value":"StringNotLike"},{"name":"NumericEquals","value":"NumericEquals"},{"name":"NumericNotEquals","value":"NumericNotEquals"},{"name":"NumericLessThan","value":"NumericLessThan"},{"name":"NumericLessThanEquals","value":"NumericLessThanEquals"},{"name":"NumericGreaterThan","value":"NumericGreaterThan"},{"name":"NumericGreaterThanEquals","value":"NumericGreaterThanEquals"}]},"aws-native:computeoptimizer:AutomationRuleOrganizationConfiguration":{"properties":{"accountIds":{"type":"array","items":{"type":"string"},"description":"List of account IDs where the organization rule applies"},"ruleApplyOrder":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleOrganizationConfigurationRuleApplyOrder","description":"When the rule should be applied relative to account rules"}},"type":"object"},"aws-native:computeoptimizer:AutomationRuleOrganizationConfigurationRuleApplyOrder":{"description":"When the rule should be applied relative to account rules","type":"string","enum":[{"name":"BeforeAccountRules","value":"BeforeAccountRules"},{"name":"AfterAccountRules","value":"AfterAccountRules"}]},"aws-native:computeoptimizer:AutomationRuleRecommendedActionTypesItem":{"type":"string","enum":[{"name":"SnapshotAndDeleteUnattachedEbsVolume","value":"SnapshotAndDeleteUnattachedEbsVolume"},{"name":"UpgradeEbsVolumeType","value":"UpgradeEbsVolumeType"}]},"aws-native:computeoptimizer:AutomationRuleResourceTagsCriteriaCondition":{"properties":{"comparison":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleResourceTagsCriteriaConditionComparison"},"key":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:computeoptimizer:AutomationRuleResourceTagsCriteriaConditionComparison":{"type":"string","enum":[{"name":"StringEquals","value":"StringEquals"},{"name":"StringNotEquals","value":"StringNotEquals"},{"name":"StringEqualsIgnoreCase","value":"StringEqualsIgnoreCase"},{"name":"StringNotEqualsIgnoreCase","value":"StringNotEqualsIgnoreCase"},{"name":"StringLike","value":"StringLike"},{"name":"StringNotLike","value":"StringNotLike"},{"name":"NumericEquals","value":"NumericEquals"},{"name":"NumericNotEquals","value":"NumericNotEquals"},{"name":"NumericLessThan","value":"NumericLessThan"},{"name":"NumericLessThanEquals","value":"NumericLessThanEquals"},{"name":"NumericGreaterThan","value":"NumericGreaterThan"},{"name":"NumericGreaterThanEquals","value":"NumericGreaterThanEquals"}]},"aws-native:computeoptimizer:AutomationRuleRuleType":{"description":"The type of automation rule.","type":"string","enum":[{"name":"AccountRule","value":"AccountRule"},{"name":"OrganizationRule","value":"OrganizationRule"}]},"aws-native:computeoptimizer:AutomationRuleSchedule":{"properties":{"executionWindowInMinutes":{"type":"integer","description":"Execution window duration in minutes"},"scheduleExpression":{"type":"string","description":"Schedule expression (e.g., cron or rate expression)"},"scheduleExpressionTimezone":{"type":"string","description":"IANA timezone identifier"}},"type":"object"},"aws-native:computeoptimizer:AutomationRuleStatus":{"description":"The status of the automation rule.","type":"string","enum":[{"name":"Active","value":"Active"},{"name":"Inactive","value":"Inactive"}]},"aws-native:computeoptimizer:AutomationRuleStringCriteriaCondition":{"properties":{"comparison":{"$ref":"#/types/aws-native:computeoptimizer:AutomationRuleStringCriteriaConditionComparison"},"values":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:computeoptimizer:AutomationRuleStringCriteriaConditionComparison":{"type":"string","enum":[{"name":"StringEquals","value":"StringEquals"},{"name":"StringNotEquals","value":"StringNotEquals"},{"name":"StringEqualsIgnoreCase","value":"StringEqualsIgnoreCase"},{"name":"StringNotEqualsIgnoreCase","value":"StringNotEqualsIgnoreCase"},{"name":"StringLike","value":"StringLike"},{"name":"StringNotLike","value":"StringNotLike"},{"name":"NumericEquals","value":"NumericEquals"},{"name":"NumericNotEquals","value":"NumericNotEquals"},{"name":"NumericLessThan","value":"NumericLessThan"},{"name":"NumericLessThanEquals","value":"NumericLessThanEquals"},{"name":"NumericGreaterThan","value":"NumericGreaterThan"},{"name":"NumericGreaterThanEquals","value":"NumericGreaterThanEquals"}]},"aws-native:computeoptimizer:AutomationRuleTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:config:AssumeRole":{"description":"The configuration for a Provider to assume a role.","properties":{"durationSeconds":{"type":"integer","description":"Number of seconds to restrict the assume role session duration.","language":{"python":{"mapCase":false}}},"externalId":{"type":"string","description":"External identifier to use when assuming the role.","language":{"python":{"mapCase":false}}},"policy":{"type":"string","description":"IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.","language":{"python":{"mapCase":false}}},"policyArns":{"type":"array","items":{"type":"string"},"description":"Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the role.","language":{"python":{"mapCase":false}}},"roleArn":{"type":"string","description":"Amazon Resource Name (ARN) of the IAM Role to assume.","language":{"python":{"mapCase":false}}},"sessionName":{"type":"string","description":"Session name to use when assuming the role.","language":{"python":{"mapCase":false}}},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of assume role session tags.","language":{"python":{"mapCase":false}}},"transitiveTagKeys":{"type":"array","items":{"type":"string"},"description":"A list of keys for session tags that you want to set as transitive. If you set a tag key as transitive, the corresponding key and value passes to subsequent sessions in a role chain.","language":{"python":{"mapCase":false}}}},"type":"object"},"aws-native:config:AutoNaming":{"description":"The configuration for automatically naming resources.","properties":{"autoTrim":{"type":"boolean","description":"Automatically trim the auto-generated name to meet the maximum length constraint.","language":{"python":{"mapCase":false}}},"randomSuffixMinLength":{"type":"integer","description":"The minimum length of the random suffix to append to the auto-generated name.","default":1,"language":{"python":{"mapCase":false}}}},"type":"object"},"aws-native:config:DefaultTags":{"description":"The configuration with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys.","properties":{"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"A group of tags to set across all resources.","language":{"python":{"mapCase":false}}}},"type":"object"},"aws-native:config:Endpoints":{"description":"The configuration for for customizing service endpoints.","properties":{"cloudcontrol":{"type":"string","description":"Override the default endpoint for AWS CloudControl","language":{"python":{"mapCase":false}}},"cloudformation":{"type":"string","description":"Override the default endpoint for AWS CloudFormation","language":{"python":{"mapCase":false}}},"ec2":{"type":"string","description":"Override the default endpoint for AWS Elastic Compute Cloud (EC2)","language":{"python":{"mapCase":false}}},"ssm":{"type":"string","description":"Override the default endpoint for AWS Systems Manager","language":{"python":{"mapCase":false}}},"sts":{"type":"string","description":"Override the default endpoint for AWS Security Token Service (STS)","language":{"python":{"mapCase":false}}}},"type":"object"},"aws-native:config:IgnoreTags":{"description":"The configuration with resource tag settings to ignore across all resources handled by this provider (except any individual service tag resources such as `ec2.Tag`) for situations where external systems are managing certain resource tags.","properties":{"keyPrefixes":{"type":"array","items":{"type":"string"},"description":"List of exact resource tag keys to ignore across all resources handled by this provider. This configuration prevents Pulumi from returning the tag in any `tags` attributes and displaying any configuration difference for the tag value. If any resource configuration still has this tag key configured in the `tags` argument, it will display a perpetual difference until the tag is removed from the argument or `ignoreChanges` is also used.","language":{"python":{"mapCase":false}}},"keys":{"type":"array","items":{"type":"string"},"description":"List of resource tag key prefixes to ignore across all resources handled by this provider. This configuration prevents Pulumi from returning any tag key matching the prefixes in any `tags` attributes and displaying any configuration difference for those tag values. If any resource configuration still has a tag matching one of the prefixes configured in the `tags` argument, it will display a perpetual difference until the tag is removed from the argument or `ignoreChanges` is also used.","language":{"python":{"mapCase":false}}}},"type":"object"},"aws-native:configuration:AggregationAuthorizationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:configuration:ComplianceProperties":{"description":"Indicates whether an AWS resource or CC rule is compliant and provides the number of contributors that affect the compliance.","properties":{"type":{"type":"string","description":"Compliance type determined by the Config rule"}},"type":"object"},"aws-native:configuration:ConfigRuleCustomPolicyDetails":{"description":"Provides the CustomPolicyDetails, the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your AWS resources.","properties":{"enableDebugLogDelivery":{"type":"boolean","description":"The boolean expression for enabling debug logging for your CC Custom Policy rule. The default value is ``false``."},"policyRuntime":{"type":"string","description":"The runtime system for your CC Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by CC Custom Policy rules. For more information about Guard, see the [Guard GitHub Repository](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-guard)."},"policyText":{"type":"string","description":"The policy definition containing the logic for your CC Custom Policy rule."}},"type":"object"},"aws-native:configuration:ConfigRuleEvaluationModeConfiguration":{"description":"The configuration object for CC rule evaluation mode. The supported valid values are Detective or Proactive.","properties":{"mode":{"type":"string","description":"The mode of an evaluation. The valid values are Detective or Proactive."}},"type":"object"},"aws-native:configuration:ConfigRuleScope":{"description":"Defines which resources trigger an evaluation for an CC rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.","properties":{"complianceResourceId":{"type":"string","description":"The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ``ComplianceResourceTypes``."},"complianceResourceTypes":{"type":"array","items":{"type":"string"},"description":"The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ``ComplianceResourceId``."},"tagKey":{"type":"string","description":"The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule."},"tagValue":{"type":"string","description":"The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for ``TagValue``, you must also specify a value for ``TagKey``."}},"type":"object"},"aws-native:configuration:ConfigRuleSource":{"description":"Provides the CustomPolicyDetails, the rule owner (```` for managed rules, ``CUSTOM_POLICY`` for Custom Policy rules, and ``CUSTOM_LAMBDA`` for Custom Lambda rules), the rule identifier, and the events that cause the evaluation of your AWS resources.","properties":{"customPolicyDetails":{"$ref":"#/types/aws-native:configuration:ConfigRuleCustomPolicyDetails","description":"Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to ``CUSTOM_POLICY``."},"owner":{"type":"string","description":"Indicates whether AWS or the customer owns and manages the CC rule.\n  CC Managed Rules are predefined rules owned by AWS. For more information, see [Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) in the *developer guide*.\n  CC Custom Rules are rules that you can develop either with Guard (``CUSTOM_POLICY``) or LAMlong (``CUSTOM_LAMBDA``). For more information, see [Custom Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html) in the *developer guide*."},"sourceDetails":{"type":"array","items":{"$ref":"#/types/aws-native:configuration:ConfigRuleSourceDetail"},"description":"Provides the source and the message types that cause CC to evaluate your AWS resources against a rule. It also provides the frequency with which you want CC to run evaluations for the rule if the trigger type is periodic.\n If the owner is set to ``CUSTOM_POLICY``, the only acceptable values for the CC rule trigger message type are ``ConfigurationItemChangeNotification`` and ``OversizedConfigurationItemChangeNotification``."},"sourceIdentifier":{"type":"string","description":"For CC Managed rules, a predefined identifier from a list. For example, ``IAM_PASSWORD_POLICY`` is a managed rule. To reference a managed rule, see [List of Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html).\n For CC Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's LAMlong function, such as ``arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name``.\n For CC Custom Policy rules, this field will be ignored."}},"type":"object","required":["owner"]},"aws-native:configuration:ConfigRuleSourceDetail":{"description":"Provides the source and the message types that trigger CC to evaluate your AWS resources against a rule. It also provides the frequency with which you want CC to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for ``SourceDetail`` only for custom rules.","properties":{"eventSource":{"type":"string","description":"The source of the event, such as an AWS service, that triggers CC to evaluate your AWS resources."},"maximumExecutionFrequency":{"type":"string","description":"The frequency at which you want CC to run evaluations for a custom rule with a periodic trigger. If you specify a value for ``MaximumExecutionFrequency``, then ``MessageType`` must use the ``ScheduledNotification`` value.\n  By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ``MaximumExecutionFrequency`` parameter.\n Based on the valid value you choose, CC runs evaluations once for each valid value. For example, if you choose ``Three_Hours``, CC runs evaluations once every three hours. In this case, ``Three_Hours`` is the frequency of this rule."},"messageType":{"type":"string","description":"The type of notification that triggers CC to run an evaluation for a rule. You can specify the following notification types:\n  +   ``ConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers a configuration item as a result of a resource change.\n  +   ``OversizedConfigurationItemChangeNotification`` - Triggers an evaluation when CC delivers an oversized configuration item. CC may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.\n  +   ``ScheduledNotification`` - Triggers a periodic evaluation at the frequency specified for ``MaximumExecutionFrequency``.\n  +   ``ConfigurationSnapshotDeliveryCompleted`` - Triggers a periodic evaluation when CC delivers a configuration snapshot.\n  \n If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ``ConfigurationItemChangeNotification`` and one for ``OversizedConfigurationItemChangeNotification``."}},"type":"object","required":["eventSource","messageType"]},"aws-native:configuration:ConfigurationAggregatorAccountAggregationSource":{"properties":{"accountIds":{"type":"array","items":{"type":"string"},"description":"The 12-digit account ID of the account being aggregated."},"allAwsRegions":{"type":"boolean","description":"If true, aggregate existing AWS Config regions and future regions."},"awsRegions":{"type":"array","items":{"type":"string"},"description":"The source regions being aggregated."}},"type":"object","required":["accountIds"]},"aws-native:configuration:ConfigurationAggregatorOrganizationAggregationSource":{"properties":{"allAwsRegions":{"type":"boolean","description":"If true, aggregate existing AWS Config regions and future regions."},"awsRegions":{"type":"array","items":{"type":"string"},"description":"The source regions being aggregated."},"roleArn":{"type":"string","description":"ARN of the IAM role used to retrieve AWS Organizations details associated with the aggregator account."}},"type":"object","required":["roleArn"]},"aws-native:configuration:ConfigurationAggregatorTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:configuration:ConformancePackInputParameter":{"description":"Input parameters in the form of key-value pairs for the conformance pack.","properties":{"parameterName":{"type":"string","description":"One part of a key-value pair."},"parameterValue":{"type":"string","description":"Another part of the key-value pair."}},"type":"object","required":["parameterName","parameterValue"]},"aws-native:configuration:OrganizationConformancePackConformancePackInputParameter":{"description":"Input parameters in the form of key-value pairs for the conformance pack.","properties":{"parameterName":{"type":"string","description":"One part of a key-value pair."},"parameterValue":{"type":"string","description":"One part of a key-value pair."}},"type":"object","required":["parameterName","parameterValue"]},"aws-native:configuration:StoredQueryTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:configuration:TemplateSsmDocumentDetailsProperties":{"description":"The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.","properties":{"documentName":{"type":"string","description":"The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, AWS Config checks only your account and AWS Region for the SSM document."},"documentVersion":{"type":"string","description":"The version of the SSM document to use to create a conformance pack. By default, AWS Config uses the latest version.\n\n\u003e This field is optional."}},"type":"object"},"aws-native:connect:AgentStatusState":{"description":"The state of the status.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:connect:AgentStatusTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:connect:AgentStatusType":{"description":"The type of agent status.","type":"string","enum":[{"name":"Routable","value":"ROUTABLE"},{"name":"Custom","value":"CUSTOM"},{"name":"Offline","value":"OFFLINE"}]},"aws-native:connect:AttributeConfigurationProperties":{"description":"Custom metadata associated to a Predefined attribute that controls how the attribute behaves when used by upstream services.","properties":{"enableValueValidationOnAssociation":{"type":"boolean","description":"Enables customers to enforce strict validation on the specific values that this predefined attribute can hold."},"isReadOnly":{"type":"boolean","description":"Allows the predefined attribute to show up and be managed in the Amazon Connect UI."}},"type":"object"},"aws-native:connect:ConstraintsProperties":{"description":"The constraints for the task template","properties":{"invisibleFields":{"type":"array","items":{"$ref":"#/types/aws-native:connect:TaskTemplateInvisibleFieldInfo"},"description":"Lists the fields that are invisible to agents."},"readOnlyFields":{"type":"array","items":{"$ref":"#/types/aws-native:connect:TaskTemplateReadOnlyFieldInfo"},"description":"Lists the fields that are read-only to agents, and cannot be edited."},"requiredFields":{"type":"array","items":{"$ref":"#/types/aws-native:connect:TaskTemplateRequiredFieldInfo"},"description":"Lists the fields that are required to be filled by agents."}},"type":"object"},"aws-native:connect:ContactFlowModuleTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:connect:ContactFlowState":{"description":"The state of the contact flow.","type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Archived","value":"ARCHIVED"}]},"aws-native:connect:ContactFlowTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:connect:ContactFlowType":{"description":"The type of the contact flow.","type":"string","enum":[{"name":"ContactFlow","value":"CONTACT_FLOW"},{"name":"CustomerQueue","value":"CUSTOMER_QUEUE"},{"name":"CustomerHold","value":"CUSTOMER_HOLD"},{"name":"CustomerWhisper","value":"CUSTOMER_WHISPER"},{"name":"AgentHold","value":"AGENT_HOLD"},{"name":"AgentWhisper","value":"AGENT_WHISPER"},{"name":"OutboundWhisper","value":"OUTBOUND_WHISPER"},{"name":"AgentTransfer","value":"AGENT_TRANSFER"},{"name":"QueueTransfer","value":"QUEUE_TRANSFER"},{"name":"Campaign","value":"CAMPAIGN"}]},"aws-native:connect:DataTableAttributeValueType":{"description":"The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN. Determines how values are validated and processed.","type":"string","enum":[{"name":"Text","value":"TEXT"},{"name":"Number","value":"NUMBER"},{"name":"Boolean","value":"BOOLEAN"},{"name":"TextList","value":"TEXT_LIST"},{"name":"NumberList","value":"NUMBER_LIST"}]},"aws-native:connect:DataTableRecordProperties":{"properties":{"primaryValues":{"type":"array","items":{"$ref":"#/types/aws-native:connect:DataTableRecordValue"}},"values":{"type":"array","items":{"$ref":"#/types/aws-native:connect:DataTableRecordValue"}}},"type":"object","required":["values"]},"aws-native:connect:DataTableRecordValue":{"properties":{"attributeId":{"type":"string"},"attributeValue":{"type":"string"}},"type":"object"},"aws-native:connect:DataTableStatus":{"description":"The status of the Data Table","type":"string","enum":[{"name":"Published","value":"PUBLISHED"}]},"aws-native:connect:DataTableTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:connect:DataTableValueLockLevel":{"description":"The value lock level of the Data Table","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"DataTable","value":"DATA_TABLE"},{"name":"PrimaryValue","value":"PRIMARY_VALUE"},{"name":"Attribute","value":"ATTRIBUTE"},{"name":"Value","value":"VALUE"}]},"aws-native:connect:EmailAddressAliasConfiguration":{"description":"Configuration for an email address alias","properties":{"emailAddressArn":{"type":"string","description":"The identifier of the email address alias"}},"type":"object","required":["emailAddressArn"]},"aws-native:connect:EmailAddressTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:connect:EvaluationFormAutoEvaluationConfiguration":{"description":"Configuration information about automated evaluations.","properties":{"enabled":{"type":"boolean"}},"type":"object"},"aws-native:connect:EvaluationFormAutomaticFailConfiguration":{"description":"Information about automatic fail configuration for an evaluation form.","properties":{"targetSection":{"type":"string","description":"The referenceId of the target section for auto failure."}},"type":"object"},"aws-native:connect:EvaluationFormBaseItem":{"description":"An item at the root level. All items must be sections.","properties":{"section":{"$ref":"#/types/aws-native:connect:EvaluationFormSection","description":"A subsection or inner section of an item."}},"type":"object","required":["section"]},"aws-native:connect:EvaluationFormEvaluationReviewConfiguration":{"description":"Configuration settings for evaluation reviews.","properties":{"eligibilityDays":{"type":"integer","description":"Number of days during which a request for review can be submitted for evaluations created from this form."},"reviewNotificationRecipients":{"type":"array","items":{"$ref":"#/types/aws-native:connect:EvaluationFormEvaluationReviewNotificationRecipient"},"description":"List of recipients who should be notified when a review is requested."}},"type":"object","required":["reviewNotificationRecipients"]},"aws-native:connect:EvaluationFormEvaluationReviewNotificationRecipient":{"description":"Information about a recipient who should be notified when an evaluation review is requested.","properties":{"type":{"$ref":"#/types/aws-native:connect:EvaluationFormEvaluationReviewNotificationRecipientType","description":"The type of notification recipient."},"value":{"$ref":"#/types/aws-native:connect:EvaluationFormEvaluationReviewNotificationRecipientValue","description":"The value associated with the notification recipient type."}},"type":"object","required":["type","value"]},"aws-native:connect:EvaluationFormEvaluationReviewNotificationRecipientType":{"description":"The type of notification recipient.","type":"string","enum":[{"name":"UserId","value":"USER_ID"}]},"aws-native:connect:EvaluationFormEvaluationReviewNotificationRecipientValue":{"description":"The value information for an evaluation review notification recipient.","properties":{"userId":{"type":"string","description":"The user identifier for the notification recipient."}},"type":"object"},"aws-native:connect:EvaluationFormItem":{"description":"Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.","properties":{"question":{"$ref":"#/types/aws-native:connect:EvaluationFormQuestion","description":"The information of the question."},"section":{"$ref":"#/types/aws-native:connect:EvaluationFormSection","description":"The information of the section."}},"type":"object"},"aws-native:connect:EvaluationFormItemEnablementCondition":{"description":"A condition for item enablement.","properties":{"operands":{"type":"array","items":{"$ref":"#/types/aws-native:connect:EvaluationFormItemEnablementConditionOperand"},"description":"Operands of the enablement condition."},"operator":{"$ref":"#/types/aws-native:connect:EvaluationFormItemEnablementConditionOperator","description":"The operator to be used to be applied to operands if more than one provided."}},"type":"object","required":["operands"]},"aws-native:connect:EvaluationFormItemEnablementConditionOperand":{"description":"An operand of the enablement condition.","properties":{"expression":{"$ref":"#/types/aws-native:connect:EvaluationFormItemEnablementExpression","description":"An expression of the enablement condition."}},"type":"object"},"aws-native:connect:EvaluationFormItemEnablementConditionOperator":{"description":"The operator to be used to be applied to operands if more than one provided.","type":"string","enum":[{"name":"Or","value":"OR"},{"name":"And","value":"AND"}]},"aws-native:connect:EvaluationFormItemEnablementConfiguration":{"description":"An item enablement configuration.","properties":{"action":{"$ref":"#/types/aws-native:connect:EvaluationFormItemEnablementConfigurationAction","description":"An enablement action that if condition is satisfied."},"condition":{"$ref":"#/types/aws-native:connect:EvaluationFormItemEnablementCondition","description":"A condition for item enablement configuration."},"defaultAction":{"$ref":"#/types/aws-native:connect:EvaluationFormItemEnablementConfigurationDefaultAction","description":"An enablement action that if condition is not satisfied."}},"type":"object","required":["action","condition"]},"aws-native:connect:EvaluationFormItemEnablementConfigurationAction":{"description":"An enablement action that if condition is satisfied.","type":"string","enum":[{"name":"Disable","value":"DISABLE"},{"name":"Enable","value":"ENABLE"}]},"aws-native:connect:EvaluationFormItemEnablementConfigurationDefaultAction":{"description":"An enablement action that if condition is not satisfied.","type":"string","enum":[{"name":"Disable","value":"DISABLE"},{"name":"Enable","value":"ENABLE"}]},"aws-native:connect:EvaluationFormItemEnablementExpression":{"description":"An expression that defines a basic building block of conditional enablement.","properties":{"comparator":{"$ref":"#/types/aws-native:connect:EvaluationFormItemEnablementExpressionComparator","description":"A comparator to be used against list of values."},"source":{"$ref":"#/types/aws-native:connect:EvaluationFormItemEnablementSource","description":"A source item of enablement expression."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:connect:EvaluationFormItemEnablementSourceValue"},"description":"A list of values from source item."}},"type":"object","required":["comparator","source","values"]},"aws-native:connect:EvaluationFormItemEnablementExpressionComparator":{"description":"A comparator to be used against list of values.","type":"string","enum":[{"name":"In","value":"IN"},{"name":"NotIn","value":"NOT_IN"},{"name":"AllIn","value":"ALL_IN"},{"name":"Exact","value":"EXACT"}]},"aws-native:connect:EvaluationFormItemEnablementSource":{"description":"An enablement expression source item.","properties":{"refId":{"type":"string","description":"A referenceId of the source item."},"type":{"$ref":"#/types/aws-native:connect:EvaluationFormItemEnablementSourceType","description":"A type of source item."}},"type":"object","required":["type"]},"aws-native:connect:EvaluationFormItemEnablementSourceType":{"description":"A type of source item.","type":"string","enum":[{"name":"QuestionRefId","value":"QUESTION_REF_ID"}]},"aws-native:connect:EvaluationFormItemEnablementSourceValue":{"description":"An enablement expression source value.","properties":{"refId":{"type":"string","description":"A referenceId of the source value."},"type":{"$ref":"#/types/aws-native:connect:EvaluationFormItemEnablementSourceValueType","description":"A type of source item value."}},"type":"object"},"aws-native:connect:EvaluationFormItemEnablementSourceValueType":{"description":"A type of source item value.","type":"string","enum":[{"name":"OptionRefId","value":"OPTION_REF_ID"}]},"aws-native:connect:EvaluationFormLanguageConfiguration":{"description":"Language configuration for an evaluation form.","properties":{"formLanguage":{"$ref":"#/types/aws-native:connect:EvaluationFormLanguageConfigurationFormLanguage","description":"The language for the evaluation form."}},"type":"object"},"aws-native:connect:EvaluationFormLanguageConfigurationFormLanguage":{"description":"The language for the evaluation form.","type":"string","enum":[{"name":"DeDe","value":"de-DE"},{"name":"EnUs","value":"en-US"},{"name":"EsEs","value":"es-ES"},{"name":"FrFr","value":"fr-FR"},{"name":"ItIt","value":"it-IT"},{"name":"PtBr","value":"pt-BR"}]},"aws-native:connect:EvaluationFormMultiSelectQuestionAutomation":{"description":"Automation configuration for multi-select questions.","properties":{"answerSource":{"$ref":"#/types/aws-native:connect:EvaluationFormQuestionAutomationAnswerSource"},"defaultOptionRefIds":{"type":"array","items":{"type":"string"},"description":"Reference IDs of default options."},"options":{"type":"array","items":{"$ref":"#/types/aws-native:connect:EvaluationFormMultiSelectQuestionAutomationOption"},"description":"Automation options for the multi-select question."}},"type":"object","required":["options"]},"aws-native:connect:EvaluationFormMultiSelectQuestionAutomationOption":{"description":"An automation option for a multi-select question.","properties":{"ruleCategory":{"$ref":"#/types/aws-native:connect:EvaluationFormMultiSelectQuestionRuleCategoryAutomation","description":"Rule category configuration for this automation option."}},"type":"object","required":["ruleCategory"]},"aws-native:connect:EvaluationFormMultiSelectQuestionOption":{"description":"An option for a multi-select question in an evaluation form.","properties":{"refId":{"type":"string","description":"Reference identifier for this option."},"text":{"type":"string","description":"Display text for this option."}},"type":"object","required":["refId","text"]},"aws-native:connect:EvaluationFormMultiSelectQuestionProperties":{"description":"Properties for a multi-select question in an evaluation form.","properties":{"automation":{"$ref":"#/types/aws-native:connect:EvaluationFormMultiSelectQuestionAutomation","description":"Automation configuration for this multi-select question."},"displayAs":{"$ref":"#/types/aws-native:connect:EvaluationFormMultiSelectQuestionPropertiesDisplayAs","description":"Display format for the multi-select question."},"options":{"type":"array","items":{"$ref":"#/types/aws-native:connect:EvaluationFormMultiSelectQuestionOption"},"description":"Options available for this multi-select question."}},"type":"object","required":["options"]},"aws-native:connect:EvaluationFormMultiSelectQuestionPropertiesDisplayAs":{"description":"Display format for the multi-select question.","type":"string","enum":[{"name":"Dropdown","value":"DROPDOWN"},{"name":"Checkbox","value":"CHECKBOX"}]},"aws-native:connect:EvaluationFormMultiSelectQuestionRuleCategoryAutomation":{"description":"Automation rule for multi-select questions based on rule categories.","properties":{"category":{"type":"string","description":"The category name for this automation rule."},"condition":{"$ref":"#/types/aws-native:connect:EvaluationFormMultiSelectQuestionRuleCategoryAutomationCondition","description":"The condition for this automation rule."},"optionRefIds":{"type":"array","items":{"type":"string"},"description":"Reference IDs of options for this automation rule."}},"type":"object","required":["category","condition","optionRefIds"]},"aws-native:connect:EvaluationFormMultiSelectQuestionRuleCategoryAutomationCondition":{"description":"The condition for this automation rule.","type":"string","enum":[{"name":"Present","value":"PRESENT"},{"name":"NotPresent","value":"NOT_PRESENT"}]},"aws-native:connect:EvaluationFormNumericQuestionAutomation":{"description":"Information about the automation configuration in numeric questions.","properties":{"answerSource":{"$ref":"#/types/aws-native:connect:EvaluationFormQuestionAutomationAnswerSource","description":"A source of automation answer for numeric question."},"propertyValue":{"$ref":"#/types/aws-native:connect:EvaluationFormNumericQuestionPropertyValueAutomation","description":"The property value of the automation."}},"type":"object"},"aws-native:connect:EvaluationFormNumericQuestionOption":{"description":"Information about the option range used for scoring in numeric questions.","properties":{"automaticFail":{"type":"boolean","description":"The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0."},"automaticFailConfiguration":{"$ref":"#/types/aws-native:connect:EvaluationFormAutomaticFailConfiguration","description":"A configuration for automatic fail."},"maxValue":{"type":"integer","description":"The maximum answer value of the range option."},"minValue":{"type":"integer","description":"The minimum answer value of the range option."},"score":{"type":"integer","description":"The score assigned to answer values within the range option.\n *Minimum*: 0\n *Maximum*: 10"}},"type":"object","required":["maxValue","minValue"]},"aws-native:connect:EvaluationFormNumericQuestionProperties":{"description":"Information about properties for a numeric question in an evaluation form.","properties":{"automation":{"$ref":"#/types/aws-native:connect:EvaluationFormNumericQuestionAutomation","description":"The automation properties of the numeric question."},"maxValue":{"type":"integer","description":"The maximum answer value."},"minValue":{"type":"integer","description":"The minimum answer value."},"options":{"type":"array","items":{"$ref":"#/types/aws-native:connect:EvaluationFormNumericQuestionOption"},"description":"The scoring options of the numeric question."}},"type":"object","required":["maxValue","minValue"]},"aws-native:connect:EvaluationFormNumericQuestionPropertyValueAutomation":{"description":"Information about the property value used in automation of a numeric questions.","properties":{"label":{"$ref":"#/types/aws-native:connect:EvaluationFormNumericQuestionPropertyValueAutomationLabel","description":"The property label of the automation."}},"type":"object","required":["label"]},"aws-native:connect:EvaluationFormNumericQuestionPropertyValueAutomationLabel":{"description":"The property label of the automation.","type":"string","enum":[{"name":"OverallCustomerSentimentScore","value":"OVERALL_CUSTOMER_SENTIMENT_SCORE"},{"name":"OverallAgentSentimentScore","value":"OVERALL_AGENT_SENTIMENT_SCORE"},{"name":"NonTalkTime","value":"NON_TALK_TIME"},{"name":"NonTalkTimePercentage","value":"NON_TALK_TIME_PERCENTAGE"},{"name":"NumberOfInterruptions","value":"NUMBER_OF_INTERRUPTIONS"},{"name":"ContactDuration","value":"CONTACT_DURATION"},{"name":"AgentInteractionDuration","value":"AGENT_INTERACTION_DURATION"},{"name":"CustomerHoldTime","value":"CUSTOMER_HOLD_TIME"},{"name":"LongestHoldDuration","value":"LONGEST_HOLD_DURATION"},{"name":"NumberOfHolds","value":"NUMBER_OF_HOLDS"},{"name":"AgentInteractionAndHoldDuration","value":"AGENT_INTERACTION_AND_HOLD_DURATION"},{"name":"CustomerSentimentScoreWithoutAgent","value":"CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT"},{"name":"CustomerSentimentScoreWithAgent","value":"CUSTOMER_SENTIMENT_SCORE_WITH_AGENT"}]},"aws-native:connect:EvaluationFormQuestion":{"description":"Information about a question from an evaluation form.","properties":{"enablement":{"$ref":"#/types/aws-native:connect:EvaluationFormItemEnablementConfiguration","description":"A question conditional enablement."},"instructions":{"type":"string","description":"The instructions of the section.\n *Length Constraints*: Minimum length of 0. Maximum length of 1024."},"notApplicableEnabled":{"type":"boolean","description":"The flag to enable not applicable answers to the question."},"questionType":{"$ref":"#/types/aws-native:connect:EvaluationFormQuestionQuestionType","description":"The type of the question.\n *Allowed values*: ``NUMERIC`` | ``SINGLESELECT`` | ``TEXT``"},"questionTypeProperties":{"$ref":"#/types/aws-native:connect:EvaluationFormQuestionTypeProperties","description":"The properties of the type of question. Text questions do not have to define question type properties."},"refId":{"type":"string","description":"The identifier of the question. An identifier must be unique within the evaluation form.\n *Length Constraints*: Minimum length of 1. Maximum length of 40."},"title":{"type":"string","description":"The title of the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 350."},"weight":{"type":"number","description":"The scoring weight of the section.\n *Minimum*: 0\n *Maximum*: 100"}},"type":"object","required":["questionType","refId","title"]},"aws-native:connect:EvaluationFormQuestionAutomationAnswerSource":{"description":"A question automation answer.","properties":{"sourceType":{"$ref":"#/types/aws-native:connect:EvaluationFormQuestionAutomationAnswerSourceSourceType","description":"The automation answer source type."}},"type":"object","required":["sourceType"]},"aws-native:connect:EvaluationFormQuestionAutomationAnswerSourceSourceType":{"description":"The automation answer source type.","type":"string","enum":[{"name":"ContactLensData","value":"CONTACT_LENS_DATA"},{"name":"GenAi","value":"GEN_AI"}]},"aws-native:connect:EvaluationFormQuestionQuestionType":{"description":"The type of the question.\n *Allowed values*: ``NUMERIC`` | ``SINGLESELECT`` | ``TEXT``","type":"string","enum":[{"name":"Numeric","value":"NUMERIC"},{"name":"Singleselect","value":"SINGLESELECT"},{"name":"Text","value":"TEXT"},{"name":"Multiselect","value":"MULTISELECT"},{"name":"Datetime","value":"DATETIME"}]},"aws-native:connect:EvaluationFormQuestionTypeProperties":{"description":"Information about properties for a question in an evaluation form. The question type properties must be either for a numeric question or a single select question.","properties":{"multiSelect":{"$ref":"#/types/aws-native:connect:EvaluationFormMultiSelectQuestionProperties","description":"Properties for multi-select question types."},"numeric":{"$ref":"#/types/aws-native:connect:EvaluationFormNumericQuestionProperties","description":"The properties of the numeric question."},"singleSelect":{"$ref":"#/types/aws-native:connect:EvaluationFormSingleSelectQuestionProperties","description":"The properties of the numeric question."},"text":{"$ref":"#/types/aws-native:connect:EvaluationFormTextQuestionProperties","description":"The properties of the text question."}},"type":"object"},"aws-native:connect:EvaluationFormScoringStrategy":{"description":"A scoring strategy of the evaluation form.","properties":{"mode":{"$ref":"#/types/aws-native:connect:EvaluationFormScoringStrategyMode","description":"The scoring mode of the evaluation form.\n *Allowed values*: ``QUESTION_ONLY`` | ``SECTION_ONLY``"},"status":{"$ref":"#/types/aws-native:connect:EvaluationFormScoringStrategyStatus","description":"The scoring status of the evaluation form.\n *Allowed values*: ``ENABLED`` | ``DISABLED``"}},"type":"object","required":["mode","status"]},"aws-native:connect:EvaluationFormScoringStrategyMode":{"description":"The scoring mode of the evaluation form.\n *Allowed values*: ``QUESTION_ONLY`` | ``SECTION_ONLY``","type":"string","enum":[{"name":"QuestionOnly","value":"QUESTION_ONLY"},{"name":"SectionOnly","value":"SECTION_ONLY"}]},"aws-native:connect:EvaluationFormScoringStrategyStatus":{"description":"The scoring status of the evaluation form.\n *Allowed values*: ``ENABLED`` | ``DISABLED``","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:connect:EvaluationFormSection":{"description":"Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation forms can only contain sections and subsections (two level nesting).","properties":{"instructions":{"type":"string","description":"The instructions of the section."},"items":{"type":"array","items":{"$ref":"#/types/aws-native:connect:EvaluationFormItem"},"description":"The items of the section.\n *Minimum*: 1"},"refId":{"type":"string","description":"The identifier of the section. An identifier must be unique within the evaluation form.\n *Length Constraints*: Minimum length of 1. Maximum length of 40."},"title":{"type":"string","description":"The title of the section.\n *Length Constraints*: Minimum length of 1. Maximum length of 128."},"weight":{"type":"number","description":"The scoring weight of the section.\n *Minimum*: 0 \n *Maximum*: 100"}},"type":"object","required":["refId","title"]},"aws-native:connect:EvaluationFormSingleSelectQuestionAutomation":{"description":"Information about the automation configuration in single select questions. Automation options are evaluated in order, and the first matched option is applied. If no automation option matches, and there is a default option, then the default option is applied.","properties":{"answerSource":{"$ref":"#/types/aws-native:connect:EvaluationFormQuestionAutomationAnswerSource","description":"Automation answer source."},"defaultOptionRefId":{"type":"string","description":"The identifier of the default answer option, when none of the automation options match the criteria.\n *Length Constraints*: Minimum length of 1. Maximum length of 40."},"options":{"type":"array","items":{"$ref":"#/types/aws-native:connect:EvaluationFormSingleSelectQuestionAutomationOption"},"description":"The automation options of the single select question.\n *Minimum*: 1\n *Maximum*: 20"}},"type":"object","required":["options"]},"aws-native:connect:EvaluationFormSingleSelectQuestionAutomationOption":{"description":"The automation options of the single select question.","properties":{"ruleCategory":{"$ref":"#/types/aws-native:connect:EvaluationFormSingleSelectQuestionRuleCategoryAutomation","description":"The automation option based on a rule category for the single select question."}},"type":"object","required":["ruleCategory"]},"aws-native:connect:EvaluationFormSingleSelectQuestionOption":{"description":"Information about the automation configuration in single select questions.","properties":{"automaticFail":{"type":"boolean","description":"The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0."},"automaticFailConfiguration":{"$ref":"#/types/aws-native:connect:EvaluationFormAutomaticFailConfiguration","description":"Whether automatic fail is configured on a single select question."},"refId":{"type":"string","description":"The identifier of the answer option. An identifier must be unique within the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 40."},"score":{"type":"integer","description":"The score assigned to the answer option.\n *Minimum*: 0\n *Maximum*: 10"},"text":{"type":"string","description":"The title of the answer option.\n *Length Constraints*: Minimum length of 1. Maximum length of 128."}},"type":"object","required":["refId","text"]},"aws-native:connect:EvaluationFormSingleSelectQuestionProperties":{"description":"Information about the options in single select questions.","properties":{"automation":{"$ref":"#/types/aws-native:connect:EvaluationFormSingleSelectQuestionAutomation","description":"The display mode of the single select question."},"displayAs":{"$ref":"#/types/aws-native:connect:EvaluationFormSingleSelectQuestionPropertiesDisplayAs","description":"The display mode of the single select question.\n *Allowed values*: ``DROPDOWN`` | ``RADIO``"},"options":{"type":"array","items":{"$ref":"#/types/aws-native:connect:EvaluationFormSingleSelectQuestionOption"},"description":"The answer options of the single select question.\n *Minimum*: 2\n *Maximum*: 256"}},"type":"object","required":["options"]},"aws-native:connect:EvaluationFormSingleSelectQuestionPropertiesDisplayAs":{"description":"The display mode of the single select question.\n *Allowed values*: ``DROPDOWN`` | ``RADIO``","type":"string","enum":[{"name":"Dropdown","value":"DROPDOWN"},{"name":"Radio","value":"RADIO"}]},"aws-native:connect:EvaluationFormSingleSelectQuestionRuleCategoryAutomation":{"description":"Information about the automation option based on a rule category for a single select question.\n *Length Constraints*: Minimum length of 1. Maximum length of 50.","properties":{"category":{"type":"string","description":"The category name, as defined in Rules.\n *Minimum*: 1\n *Maximum*: 50"},"condition":{"$ref":"#/types/aws-native:connect:EvaluationFormSingleSelectQuestionRuleCategoryAutomationCondition","description":"The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.\n *Allowed values*: ``PRESENT`` | ``NOT_PRESENT``\n *Maximum*: 50"},"optionRefId":{"type":"string","description":"The identifier of the answer option. An identifier must be unique within the question.\n *Length Constraints*: Minimum length of 1. Maximum length of 40."}},"type":"object","required":["category","condition","optionRefId"]},"aws-native:connect:EvaluationFormSingleSelectQuestionRuleCategoryAutomationCondition":{"description":"The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.\n *Allowed values*: ``PRESENT`` | ``NOT_PRESENT``\n *Maximum*: 50","type":"string","enum":[{"name":"Present","value":"PRESENT"},{"name":"NotPresent","value":"NOT_PRESENT"}]},"aws-native:connect:EvaluationFormStatus":{"description":"The status of the evaluation form.\n *Allowed values*: ``DRAFT`` | ``ACTIVE``","type":"string","enum":[{"name":"Draft","value":"DRAFT"},{"name":"Active","value":"ACTIVE"}]},"aws-native:connect:EvaluationFormTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -"},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -"}},"type":"object","required":["key","value"]},"aws-native:connect:EvaluationFormTargetConfiguration":{"description":"Configuration that specifies the target for an evaluation form.","properties":{"contactInteractionType":{"$ref":"#/types/aws-native:connect:EvaluationFormTargetConfigurationContactInteractionType","description":"The contact interaction type for this evaluation form."}},"type":"object","required":["contactInteractionType"]},"aws-native:connect:EvaluationFormTargetConfigurationContactInteractionType":{"description":"The contact interaction type for this evaluation form.","type":"string","enum":[{"name":"Agent","value":"AGENT"},{"name":"Automated","value":"AUTOMATED"}]},"aws-native:connect:EvaluationFormTextQuestionAutomation":{"description":"Information about the automation configuration in text questions.","properties":{"answerSource":{"$ref":"#/types/aws-native:connect:EvaluationFormQuestionAutomationAnswerSource","description":"Automation answer source."}},"type":"object"},"aws-native:connect:EvaluationFormTextQuestionProperties":{"description":"Information about properties for a text question in an evaluation form.","properties":{"automation":{"$ref":"#/types/aws-native:connect:EvaluationFormTextQuestionAutomation","description":"The automation properties of the text question."}},"type":"object"},"aws-native:connect:ExternalInvocationConfigurationProperties":{"description":"Defines the external invocation configuration of the flow module resource","properties":{"enabled":{"type":"boolean","description":"Enable external invocation."}},"type":"object","required":["enabled"]},"aws-native:connect:FontFamily":{"properties":{"default":{"$ref":"#/types/aws-native:connect:WorkspaceFontFamily","description":"The default font family to use in the workspace theme."}},"type":"object"},"aws-native:connect:GranularAccessControlConfigurationProperties":{"description":"The granular access control configuration for the security profile, including data table permissions.","properties":{"dataTableAccessControlConfiguration":{"$ref":"#/types/aws-native:connect:SecurityProfileDataTableAccessControlConfiguration","description":"The access control configuration for data tables."}},"type":"object"},"aws-native:connect:HoursOfOperationConfig":{"description":"Contains information about the hours of operation.","properties":{"day":{"$ref":"#/types/aws-native:connect:HoursOfOperationConfigDay","description":"The day that the hours of operation applies to."},"endTime":{"$ref":"#/types/aws-native:connect:HoursOfOperationTimeSlice","description":"The end time that your contact center closes."},"startTime":{"$ref":"#/types/aws-native:connect:HoursOfOperationTimeSlice","description":"The start time that your contact center opens."}},"type":"object","required":["day","endTime","startTime"]},"aws-native:connect:HoursOfOperationConfigDay":{"description":"The day that the hours of operation applies to.","type":"string","enum":[{"name":"Sunday","value":"SUNDAY"},{"name":"Monday","value":"MONDAY"},{"name":"Tuesday","value":"TUESDAY"},{"name":"Wednesday","value":"WEDNESDAY"},{"name":"Thursday","value":"THURSDAY"},{"name":"Friday","value":"FRIDAY"},{"name":"Saturday","value":"SATURDAY"}]},"aws-native:connect:HoursOfOperationOverride":{"description":"Overrides attached to the hours of operation.","properties":{"effectiveFrom":{"type":"string","description":"The date from which the hours of operation override would be effective."},"effectiveTill":{"type":"string","description":"The date until the hours of operation override is effective."},"hoursOfOperationOverrideId":{"type":"string","description":"The identifier for the hours of operation override."},"overrideConfig":{"type":"array","items":{"$ref":"#/types/aws-native:connect:HoursOfOperationOverrideConfig"}},"overrideDescription":{"type":"string"},"overrideName":{"type":"string"},"overrideType":{"$ref":"#/types/aws-native:connect:HoursOfOperationOverrideType"},"recurrenceConfig":{"$ref":"#/types/aws-native:connect:HoursOfOperationRecurrenceConfig"}},"type":"object","required":["effectiveFrom","effectiveTill","overrideConfig","overrideName"]},"aws-native:connect:HoursOfOperationOverrideConfig":{"description":"Contains information about the hours of operation override.","properties":{"day":{"$ref":"#/types/aws-native:connect:HoursOfOperationOverrideConfigDay","description":"The day that the hours of operation override applies to."},"endTime":{"$ref":"#/types/aws-native:connect:HoursOfOperationOverrideTimeSlice","description":"The new end time that your contact center closes for the overriden days."},"startTime":{"$ref":"#/types/aws-native:connect:HoursOfOperationOverrideTimeSlice","description":"The new start time that your contact center opens for the overriden days."}},"type":"object","required":["day","endTime","startTime"]},"aws-native:connect:HoursOfOperationOverrideConfigDay":{"description":"The day that the hours of operation override applies to.","type":"string","enum":[{"name":"Sunday","value":"SUNDAY"},{"name":"Monday","value":"MONDAY"},{"name":"Tuesday","value":"TUESDAY"},{"name":"Wednesday","value":"WEDNESDAY"},{"name":"Thursday","value":"THURSDAY"},{"name":"Friday","value":"FRIDAY"},{"name":"Saturday","value":"SATURDAY"}]},"aws-native:connect:HoursOfOperationOverrideTimeSlice":{"description":"The start time or end time for an an hours of operation override.","properties":{"hours":{"type":"integer","description":"The hours."},"minutes":{"type":"integer","description":"The minutes."}},"type":"object","required":["hours","minutes"]},"aws-native:connect:HoursOfOperationOverrideType":{"description":"The type of hours of operation override.","type":"string","enum":[{"name":"Standard","value":"STANDARD"},{"name":"Open","value":"OPEN"},{"name":"Closed","value":"CLOSED"}]},"aws-native:connect:HoursOfOperationRecurrenceConfig":{"description":"Configuration for recurring hours of operation overrides.","properties":{"recurrencePattern":{"$ref":"#/types/aws-native:connect:HoursOfOperationRecurrencePattern"}},"type":"object","required":["recurrencePattern"]},"aws-native:connect:HoursOfOperationRecurrenceFrequency":{"description":"The frequency of recurrence for hours of operation overrides.","type":"string","enum":[{"name":"Weekly","value":"WEEKLY"},{"name":"Monthly","value":"MONTHLY"},{"name":"Yearly","value":"YEARLY"}]},"aws-native:connect:HoursOfOperationRecurrencePattern":{"description":"Pattern for recurring hours of operation overrides.","properties":{"byMonth":{"type":"array","items":{"type":"integer"}},"byMonthDay":{"type":"array","items":{"type":"integer"}},"byWeekdayOccurrence":{"type":"array","items":{"type":"integer"}},"frequency":{"$ref":"#/types/aws-native:connect:HoursOfOperationRecurrenceFrequency"},"interval":{"type":"integer"}},"type":"object"},"aws-native:connect:HoursOfOperationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:connect:HoursOfOperationTimeSlice":{"description":"The start time or end time for an hours of operation.","properties":{"hours":{"type":"integer","description":"The hours."},"minutes":{"type":"integer","description":"The minutes."}},"type":"object","required":["hours","minutes"]},"aws-native:connect:HoursOfOperationsIdentifier":{"description":"Identifier for hours of operation.","properties":{"id":{"type":"string","description":"The identifier for the hours of operation."},"name":{"type":"string","description":"The name of the hours of operation."}},"type":"object","required":["id"]},"aws-native:connect:InstanceAttributes":{"properties":{"autoResolveBestVoices":{"type":"boolean"},"contactLens":{"type":"boolean"},"contactflowLogs":{"type":"boolean"},"earlyMedia":{"type":"boolean"},"enhancedChatMonitoring":{"type":"boolean"},"enhancedContactMonitoring":{"type":"boolean"},"highVolumeOutBound":{"type":"boolean"},"inboundCalls":{"type":"boolean"},"messageStreaming":{"type":"boolean"},"multiPartyChatConference":{"type":"boolean"},"multiPartyConference":{"type":"boolean"},"outboundCalls":{"type":"boolean"},"useCustomTtsVoices":{"type":"boolean"}},"type":"object","required":["inboundCalls","outboundCalls"]},"aws-native:connect:InstanceIdentityManagementType":{"description":"Specifies the type of directory integration for new instance.","type":"string","enum":[{"name":"Saml","value":"SAML"},{"name":"ConnectManaged","value":"CONNECT_MANAGED"},{"name":"ExistingDirectory","value":"EXISTING_DIRECTORY"}]},"aws-native:connect:InstanceStatus":{"description":"Specifies the creation status of new instance.","type":"string","enum":[{"name":"CreationInProgress","value":"CREATION_IN_PROGRESS"},{"name":"CreationFailed","value":"CREATION_FAILED"},{"name":"Active","value":"ACTIVE"}]},"aws-native:connect:InstanceStorageConfigEncryptionConfig":{"properties":{"encryptionType":{"$ref":"#/types/aws-native:connect:InstanceStorageConfigEncryptionType","description":"The type of encryption."},"keyId":{"type":"string","description":"The full ARN of the encryption key.\n\n\u003e Be sure to provide the full ARN of the encryption key, not just the ID.\n\u003e \n\u003e Amazon Connect supports only KMS keys with the default key spec of [`SYMMETRIC_DEFAULT`](https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default) ."}},"type":"object","required":["encryptionType","keyId"]},"aws-native:connect:InstanceStorageConfigEncryptionType":{"description":"Specifies default encryption using AWS KMS-Managed Keys","type":"string","enum":[{"name":"Kms","value":"KMS"}]},"aws-native:connect:InstanceStorageConfigInstanceStorageResourceType":{"description":"Specifies the type of storage resource available for the instance","type":"string","enum":[{"name":"ChatTranscripts","value":"CHAT_TRANSCRIPTS"},{"name":"CallRecordings","value":"CALL_RECORDINGS"},{"name":"ScheduledReports","value":"SCHEDULED_REPORTS"},{"name":"MediaStreams","value":"MEDIA_STREAMS"},{"name":"ContactTraceRecords","value":"CONTACT_TRACE_RECORDS"},{"name":"AgentEvents","value":"AGENT_EVENTS"}]},"aws-native:connect:InstanceStorageConfigKinesisFirehoseConfig":{"properties":{"firehoseArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the delivery stream."}},"type":"object","required":["firehoseArn"]},"aws-native:connect:InstanceStorageConfigKinesisStreamConfig":{"properties":{"streamArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the data stream."}},"type":"object","required":["streamArn"]},"aws-native:connect:InstanceStorageConfigKinesisVideoStreamConfig":{"properties":{"encryptionConfig":{"$ref":"#/types/aws-native:connect:InstanceStorageConfigEncryptionConfig","description":"The encryption configuration."},"prefix":{"type":"string","description":"The prefix of the video stream."},"retentionPeriodHours":{"type":"number","description":"The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.\n\nThe default value is 0, indicating that the stream does not persist data."}},"type":"object","required":["encryptionConfig","prefix","retentionPeriodHours"]},"aws-native:connect:InstanceStorageConfigS3Config":{"properties":{"bucketName":{"type":"string","description":"The S3 bucket name."},"bucketPrefix":{"type":"string","description":"The S3 bucket prefix."},"encryptionConfig":{"$ref":"#/types/aws-native:connect:InstanceStorageConfigEncryptionConfig","description":"The Amazon S3 encryption configuration."}},"type":"object","required":["bucketName","bucketPrefix"]},"aws-native:connect:InstanceStorageConfigStorageType":{"description":"Specifies the storage type to be associated with the instance","type":"string","enum":[{"name":"S3","value":"S3"},{"name":"KinesisVideoStream","value":"KINESIS_VIDEO_STREAM"},{"name":"KinesisStream","value":"KINESIS_STREAM"},{"name":"KinesisFirehose","value":"KINESIS_FIREHOSE"}]},"aws-native:connect:InstanceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:connect:IntegrationAssociationIntegrationType":{"description":"Specifies the integration type to be associated with the instance","type":"string","enum":[{"name":"LexBot","value":"LEX_BOT"},{"name":"LambdaFunction","value":"LAMBDA_FUNCTION"},{"name":"Application","value":"APPLICATION"},{"name":"CasesDomain","value":"CASES_DOMAIN"}]},"aws-native:connect:LockVersionProperties":{"properties":{"attribute":{"type":"string"},"dataTable":{"type":"string"}},"type":"object"},"aws-native:connect:NotificationContent":{"description":"The content of a notification","properties":{"deDe":{"type":"string"},"enUs":{"type":"string"},"esEs":{"type":"string"},"frFr":{"type":"string"},"idId":{"type":"string"},"itIt":{"type":"string"},"jaJp":{"type":"string"},"koKr":{"type":"string"},"ptBr":{"type":"string"},"zhCn":{"type":"string"},"zhTw":{"type":"string"}},"type":"object"},"aws-native:connect:NotificationPriority":{"description":"The priority of notification. In the Amazon Connect console, when you create a notification, you are prompted to assign one of the following priorities: High (HIGH) or LOW (LOW)","type":"string","enum":[{"name":"High","value":"HIGH"},{"name":"Low","value":"LOW"}]},"aws-native:connect:NotificationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:connect:PhoneNumberTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:connect:PromptTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:connect:QueueEmailAddress":{"description":"An email address configuration for the queue","properties":{"emailAddressArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the email address"}},"type":"object","required":["emailAddressArn"]},"aws-native:connect:QueueOutboundCallerConfig":{"description":"The outbound caller ID name, number, and outbound whisper flow.","properties":{"outboundCallerIdName":{"type":"string","description":"The caller ID name."},"outboundCallerIdNumberArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the outbound caller ID number.\n\n\u003e Only use the phone number ARN format that doesn't contain `instance` in the path, for example, `arn:aws:connect:us-east-1:1234567890:phone-number/uuid` . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the [ListPhoneNumbersV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) API."},"outboundFlowArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the outbound flow."}},"type":"object"},"aws-native:connect:QueueOutboundEmailConfig":{"description":"The outbound email address ID.","properties":{"outboundEmailAddressId":{"type":"string","description":"The identifier of the email address."}},"type":"object"},"aws-native:connect:QueueStatus":{"description":"The status of the queue.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:connect:QueueTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -"},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -"}},"type":"object","required":["key","value"]},"aws-native:connect:QueueType":{"description":"The type of queue.","type":"string","enum":[{"name":"Standard","value":"STANDARD"},{"name":"Agent","value":"AGENT"}]},"aws-native:connect:QuickConnectConfig":{"description":"Configuration settings for the quick connect.","properties":{"phoneConfig":{"$ref":"#/types/aws-native:connect:QuickConnectPhoneNumberQuickConnectConfig","description":"The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER."},"queueConfig":{"$ref":"#/types/aws-native:connect:QuickConnectQueueQuickConnectConfig","description":"The queue configuration. This is required only if QuickConnectType is QUEUE."},"quickConnectType":{"$ref":"#/types/aws-native:connect:QuickConnectType","description":"The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE)."},"userConfig":{"$ref":"#/types/aws-native:connect:QuickConnectUserQuickConnectConfig","description":"The user configuration. This is required only if QuickConnectType is USER."}},"type":"object","required":["quickConnectType"]},"aws-native:connect:QuickConnectPhoneNumberQuickConnectConfig":{"description":"The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.","properties":{"phoneNumber":{"type":"string","description":"The phone number in E.164 format."}},"type":"object","required":["phoneNumber"]},"aws-native:connect:QuickConnectQueueQuickConnectConfig":{"description":"The queue configuration. This is required only if QuickConnectType is QUEUE.","properties":{"contactFlowArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the flow."},"queueArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the queue."}},"type":"object","required":["contactFlowArn","queueArn"]},"aws-native:connect:QuickConnectTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:connect:QuickConnectType":{"description":"The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).","type":"string","enum":[{"name":"PhoneNumber","value":"PHONE_NUMBER"},{"name":"Queue","value":"QUEUE"},{"name":"User","value":"USER"}]},"aws-native:connect:QuickConnectUserQuickConnectConfig":{"description":"The user configuration. This is required only if QuickConnectType is USER.","properties":{"contactFlowArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the flow."},"userArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the user."}},"type":"object","required":["contactFlowArn","userArn"]},"aws-native:connect:RoutingProfileAgentAvailabilityTimer":{"description":"Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.","type":"string","enum":[{"name":"TimeSinceLastActivity","value":"TIME_SINCE_LAST_ACTIVITY"},{"name":"TimeSinceLastInbound","value":"TIME_SINCE_LAST_INBOUND"}]},"aws-native:connect:RoutingProfileBehaviorType":{"description":"Specifies the other channels that can be routed to an agent handling their current channel.","type":"string","enum":[{"name":"RouteCurrentChannelOnly","value":"ROUTE_CURRENT_CHANNEL_ONLY"},{"name":"RouteAnyChannel","value":"ROUTE_ANY_CHANNEL"}]},"aws-native:connect:RoutingProfileChannel":{"description":"The channels that agents can handle in the Contact Control Panel (CCP).","type":"string","enum":[{"name":"Voice","value":"VOICE"},{"name":"Chat","value":"CHAT"},{"name":"Task","value":"TASK"},{"name":"Email","value":"EMAIL"}]},"aws-native:connect:RoutingProfileCrossChannelBehavior":{"description":"Defines the cross-channel routing behavior that allows an agent working on a contact in one channel to be offered a contact from a different channel.","properties":{"behaviorType":{"$ref":"#/types/aws-native:connect:RoutingProfileBehaviorType","description":"Specifies the other channels that can be routed to an agent handling their current channel."}},"type":"object","required":["behaviorType"]},"aws-native:connect:RoutingProfileManualAssignmentQueueConfig":{"description":"Contains information about the manual assignment queue and channel","properties":{"queueReference":{"$ref":"#/types/aws-native:connect:RoutingProfileQueueReference","description":"Contains information about a queue resource."}},"type":"object","required":["queueReference"]},"aws-native:connect:RoutingProfileMediaConcurrency":{"description":"Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.","properties":{"channel":{"$ref":"#/types/aws-native:connect:RoutingProfileChannel","description":"The channels that agents can handle in the Contact Control Panel (CCP)."},"concurrency":{"type":"integer","description":"The number of contacts an agent can have on a channel simultaneously.\n\nValid Range for `VOICE` : Minimum value of 1. Maximum value of 1.\n\nValid Range for `CHAT` : Minimum value of 1. Maximum value of 10.\n\nValid Range for `TASK` : Minimum value of 1. Maximum value of 10."},"crossChannelBehavior":{"$ref":"#/types/aws-native:connect:RoutingProfileCrossChannelBehavior","description":"Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel."}},"type":"object","required":["channel","concurrency"]},"aws-native:connect:RoutingProfileQueueConfig":{"description":"Contains information about the queue and channel for which priority and delay can be set.","properties":{"delay":{"type":"integer","description":"The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see [Queues: priority and delay](https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html) in the *Amazon Connect Administrator Guide* ."},"priority":{"type":"integer","description":"The order in which contacts are to be handled for the queue. For more information, see [Queues: priority and delay](https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html) ."},"queueReference":{"$ref":"#/types/aws-native:connect:RoutingProfileQueueReference","description":"Contains information about a queue resource."}},"type":"object","required":["delay","priority","queueReference"]},"aws-native:connect:RoutingProfileQueueReference":{"description":"Contains the channel and queue identifier for a routing profile.","properties":{"channel":{"$ref":"#/types/aws-native:connect:RoutingProfileChannel","description":"The channels agents can handle in the Contact Control Panel (CCP) for this routing profile."},"queueArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the queue."}},"type":"object","required":["channel","queueArn"]},"aws-native:connect:RoutingProfileTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:connect:RuleActions":{"description":"A list of actions to be run when the rule is triggered.","properties":{"assignContactCategoryActions":{"type":"array","items":{"$ref":"#/types/aws-native:connect:RuleAssignContactCategoryAction"},"description":"Information about the contact category action. The syntax can be empty, for example, ``{}``."},"createCaseActions":{"type":"array","items":{"$ref":"#/types/aws-native:connect:RuleCreateCaseAction"}},"endAssociatedTasksActions":{"type":"array","items":{"$ref":"#/types/aws-native:connect:RuleEndAssociatedTasksAction"}},"eventBridgeActions":{"type":"array","items":{"$ref":"#/types/aws-native:connect:RuleEventBridgeAction"},"description":"Information about the EV action."},"sendNotificationActions":{"type":"array","items":{"$ref":"#/types/aws-native:connect:RuleSendNotificationAction"},"description":"Information about the send notification action."},"submitAutoEvaluationActions":{"type":"array","items":{"$ref":"#/types/aws-native:connect:RuleSubmitAutoEvaluationAction"}},"taskActions":{"type":"array","items":{"$ref":"#/types/aws-native:connect:RuleTaskAction"},"description":"Information about the task action. This field is required if ``TriggerEventSource`` is one of the following values: ``OnZendeskTicketCreate`` | ``OnZendeskTicketStatusUpdate`` | ``OnSalesforceCaseCreate``"},"updateCaseActions":{"type":"array","items":{"$ref":"#/types/aws-native:connect:RuleUpdateCaseAction"}}},"type":"object"},"aws-native:connect:RuleAssignContactCategoryAction":{"description":"The definition for assigning contact category action.","type":"object"},"aws-native:connect:RuleCreateCaseAction":{"properties":{"fields":{"type":"array","items":{"$ref":"#/types/aws-native:connect:RuleField"}},"templateId":{"type":"string"}},"type":"object","required":["fields","templateId"]},"aws-native:connect:RuleEndAssociatedTasksAction":{"description":"The definition for ending associated task action.","type":"object"},"aws-native:connect:RuleEventBridgeAction":{"description":"The EV action definition.","properties":{"name":{"type":"string","description":"The name."}},"type":"object","required":["name"]},"aws-native:connect:RuleField":{"properties":{"id":{"type":"string"},"value":{"$ref":"#/types/aws-native:connect:RuleFieldValue"}},"type":"object","required":["id","value"]},"aws-native:connect:RuleFieldValue":{"description":"Object for case field values.","properties":{"booleanValue":{"type":"boolean"},"doubleValue":{"type":"number"},"emptyValue":{"$ref":"pulumi.json#/Any"},"stringValue":{"type":"string"}},"type":"object"},"aws-native:connect:RuleNotificationRecipientType":{"description":"The type of notification recipient.","properties":{"userArns":{"type":"array","items":{"type":"string"},"description":"The Amazon Resource Name (ARN) of the user account."},"userTags":{"type":"object","additionalProperties":{"type":"string"},"description":"The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }. CON users with the specified tags will be notified."}},"type":"object"},"aws-native:connect:RulePublishStatus":{"description":"The publish status of the rule.\n *Allowed values*: ``DRAFT`` | ``PUBLISHED``","type":"string","enum":[{"name":"Draft","value":"DRAFT"},{"name":"Published","value":"PUBLISHED"}]},"aws-native:connect:RuleReference":{"description":"Information about the reference when the ``referenceType`` is ``URL``. Otherwise, null. (Supports variable injection in the ``Value`` field.)","properties":{"type":{"$ref":"#/types/aws-native:connect:RuleReferenceType","description":"The type of the reference. ``DATE`` must be of type Epoch timestamp. \n *Allowed values*: ``URL`` | ``ATTACHMENT`` | ``NUMBER`` | ``STRING`` | ``DATE`` | ``EMAIL``"},"value":{"type":"string","description":"A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP)."}},"type":"object","required":["type","value"]},"aws-native:connect:RuleReferenceType":{"description":"The type of the reference. ``DATE`` must be of type Epoch timestamp. \n *Allowed values*: ``URL`` | ``ATTACHMENT`` | ``NUMBER`` | ``STRING`` | ``DATE`` | ``EMAIL``","type":"string","enum":[{"name":"Url","value":"URL"},{"name":"Attachment","value":"ATTACHMENT"},{"name":"Number","value":"NUMBER"},{"name":"String","value":"STRING"},{"name":"Date","value":"DATE"},{"name":"Email","value":"EMAIL"}]},"aws-native:connect:RuleSendNotificationAction":{"description":"Information about the send notification action.","properties":{"content":{"type":"string","description":"Notification content. Supports variable injection. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Administrators Guide*."},"contentType":{"$ref":"#/types/aws-native:connect:RuleSendNotificationActionContentType","description":"Content type format.\n *Allowed value*: ``PLAIN_TEXT``"},"deliveryMethod":{"$ref":"#/types/aws-native:connect:RuleSendNotificationActionDeliveryMethod","description":"Notification delivery method.\n *Allowed value*: ``EMAIL``"},"recipient":{"$ref":"#/types/aws-native:connect:RuleNotificationRecipientType","description":"Notification recipient."},"subject":{"type":"string","description":"The subject of the email if the delivery method is ``EMAIL``. Supports variable injection. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Administrators Guide*."}},"type":"object","required":["content","contentType","deliveryMethod","recipient"]},"aws-native:connect:RuleSendNotificationActionContentType":{"description":"Content type format.\n *Allowed value*: ``PLAIN_TEXT``","type":"string","enum":[{"name":"PlainText","value":"PLAIN_TEXT"}]},"aws-native:connect:RuleSendNotificationActionDeliveryMethod":{"description":"Notification delivery method.\n *Allowed value*: ``EMAIL``","type":"string","enum":[{"name":"Email","value":"EMAIL"}]},"aws-native:connect:RuleSubmitAutoEvaluationAction":{"properties":{"evaluationFormArn":{"type":"string"}},"type":"object","required":["evaluationFormArn"]},"aws-native:connect:RuleTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -"},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -"}},"type":"object","required":["key","value"]},"aws-native:connect:RuleTaskAction":{"description":"Information about the task action. This field is required if ``TriggerEventSource`` is one of the following values: ``OnZendeskTicketCreate`` | ``OnZendeskTicketStatusUpdate`` | ``OnSalesforceCaseCreate``","properties":{"contactFlowArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the flow."},"description":{"type":"string","description":"The description. Supports variable injection. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Administrators Guide*."},"name":{"type":"string","description":"The name. Supports variable injection. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Administrators Guide*."},"references":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:connect:RuleReference"},"description":"Information about the reference when the ``referenceType`` is ``URL``. Otherwise, null. ``URL`` is the only accepted type. (Supports variable injection in the ``Value`` field.)"}},"type":"object","required":["contactFlowArn","name"]},"aws-native:connect:RuleTriggerEventSource":{"description":"The name of the event source.","properties":{"eventSourceName":{"$ref":"#/types/aws-native:connect:RuleTriggerEventSourceEventSourceName","description":"The name of the event source."},"integrationAssociationArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the integration association. ``IntegrationAssociationArn`` is required if ``TriggerEventSource`` is one of the following values: ``OnZendeskTicketCreate`` | ``OnZendeskTicketStatusUpdate`` | ``OnSalesforceCaseCreate``"}},"type":"object","required":["eventSourceName"]},"aws-native:connect:RuleTriggerEventSourceEventSourceName":{"description":"The name of the event source.","type":"string","enum":[{"name":"OnContactEvaluationSubmit","value":"OnContactEvaluationSubmit"},{"name":"OnPostCallAnalysisAvailable","value":"OnPostCallAnalysisAvailable"},{"name":"OnRealTimeCallAnalysisAvailable","value":"OnRealTimeCallAnalysisAvailable"},{"name":"OnRealTimeChatAnalysisAvailable","value":"OnRealTimeChatAnalysisAvailable"},{"name":"OnPostChatAnalysisAvailable","value":"OnPostChatAnalysisAvailable"},{"name":"OnZendeskTicketCreate","value":"OnZendeskTicketCreate"},{"name":"OnZendeskTicketStatusUpdate","value":"OnZendeskTicketStatusUpdate"},{"name":"OnSalesforceCaseCreate","value":"OnSalesforceCaseCreate"},{"name":"OnMetricDataUpdate","value":"OnMetricDataUpdate"},{"name":"OnCaseCreate","value":"OnCaseCreate"},{"name":"OnCaseUpdate","value":"OnCaseUpdate"}]},"aws-native:connect:RuleUpdateCaseAction":{"properties":{"fields":{"type":"array","items":{"$ref":"#/types/aws-native:connect:RuleField"}}},"type":"object","required":["fields"]},"aws-native:connect:SecurityProfileApplication":{"description":"A third-party application's metadata.","properties":{"applicationPermissions":{"type":"array","items":{"type":"string"},"description":"The permissions that the agent is granted on the application"},"namespace":{"type":"string","description":"Namespace of the application that you want to give access to."},"type":{"$ref":"#/types/aws-native:connect:SecurityProfileApplicationType","description":"The type of the application."}},"type":"object","required":["applicationPermissions","namespace"]},"aws-native:connect:SecurityProfileApplicationType":{"description":"The type of the application.","type":"string","enum":[{"name":"Mcp","value":"MCP"},{"name":"ThirdPartyApplication","value":"THIRD_PARTY_APPLICATION"}]},"aws-native:connect:SecurityProfileDataTableAccessControlConfiguration":{"description":"Defines the access control configuration for data tables.","properties":{"primaryAttributeAccessControlConfiguration":{"$ref":"#/types/aws-native:connect:SecurityProfilePrimaryAttributeAccessControlConfigurationItem","description":"The configuration's primary attribute access control configuration."}},"type":"object"},"aws-native:connect:SecurityProfileFlowModule":{"description":"A first-party application's metadata.","properties":{"flowModuleId":{"type":"string","description":"The identifier of the application that you want to give access to."},"type":{"type":"string","description":"The type of the first-party application"}},"type":"object","required":["flowModuleId","type"]},"aws-native:connect:SecurityProfilePrimaryAttributeAccessControlConfigurationItem":{"description":"Contains the configuration for record-based access control.","properties":{"primaryAttributeValues":{"type":"array","items":{"$ref":"#/types/aws-native:connect:SecurityProfilePrimaryAttributeValue"},"description":"An array of PrimaryAttributeValue objects."}},"type":"object","required":["primaryAttributeValues"]},"aws-native:connect:SecurityProfilePrimaryAttributeValue":{"description":"An object defining the access control for a specific attribute and its values.","properties":{"accessType":{"$ref":"#/types/aws-native:connect:SecurityProfilePrimaryAttributeValueAccessType","description":"Specifies the type of access granted. Currently, only \"ALLOW\" is supported"},"attributeName":{"type":"string","description":"The name of the primary attribute."},"values":{"type":"array","items":{"type":"string"},"description":"An array of allowed primary values for the specified primary attribute."}},"type":"object","required":["accessType","attributeName","values"]},"aws-native:connect:SecurityProfilePrimaryAttributeValueAccessType":{"description":"Specifies the type of access granted. Currently, only \"ALLOW\" is supported","type":"string","enum":[{"name":"Allow","value":"ALLOW"}]},"aws-native:connect:SecurityProfileTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:connect:TaskTemplateDefaultFieldValue":{"description":"the default value for the task template's field","properties":{"defaultValue":{"type":"string","description":"Default value for the field."},"id":{"$ref":"#/types/aws-native:connect:TaskTemplateFieldIdentifier","description":"Identifier of a field."}},"type":"object","required":["defaultValue","id"]},"aws-native:connect:TaskTemplateField":{"description":"A task template field object.","properties":{"description":{"type":"string","description":"The description of the task template's field"},"id":{"$ref":"#/types/aws-native:connect:TaskTemplateFieldIdentifier","description":"The unique identifier for the field."},"singleSelectOptions":{"type":"array","items":{"type":"string"},"description":"list of field options to be used with single select"},"type":{"$ref":"#/types/aws-native:connect:TaskTemplateFieldType","description":"Indicates the type of field. Following are the valid field types: `NAME` `DESCRIPTION` | `SCHEDULED_TIME` | `QUICK_CONNECT` | `URL` | `NUMBER` | `TEXT` | `TEXT_AREA` | `DATE_TIME` | `BOOLEAN` | `SINGLE_SELECT` | `EMAIL`"}},"type":"object","required":["id","type"]},"aws-native:connect:TaskTemplateFieldIdentifier":{"description":"the identifier (name) for the task template field","properties":{"name":{"type":"string","description":"The name of the task template field"}},"type":"object","required":["name"]},"aws-native:connect:TaskTemplateFieldType":{"description":"The type of the task template's field","type":"string","enum":[{"name":"Name","value":"NAME"},{"name":"Description","value":"DESCRIPTION"},{"name":"ScheduledTime","value":"SCHEDULED_TIME"},{"name":"QuickConnect","value":"QUICK_CONNECT"},{"name":"Url","value":"URL"},{"name":"Number","value":"NUMBER"},{"name":"Text","value":"TEXT"},{"name":"TextArea","value":"TEXT_AREA"},{"name":"DateTime","value":"DATE_TIME"},{"name":"Boolean","value":"BOOLEAN"},{"name":"SingleSelect","value":"SINGLE_SELECT"},{"name":"Email","value":"EMAIL"},{"name":"ExpiryDuration","value":"EXPIRY_DURATION"},{"name":"SelfAssign","value":"SELF_ASSIGN"}]},"aws-native:connect:TaskTemplateInvisibleFieldInfo":{"description":"Invisible field info","properties":{"id":{"$ref":"#/types/aws-native:connect:TaskTemplateFieldIdentifier"}},"type":"object","required":["id"]},"aws-native:connect:TaskTemplateReadOnlyFieldInfo":{"description":"ReadOnly field info","properties":{"id":{"$ref":"#/types/aws-native:connect:TaskTemplateFieldIdentifier"}},"type":"object","required":["id"]},"aws-native:connect:TaskTemplateRequiredFieldInfo":{"description":"Required field info","properties":{"id":{"$ref":"#/types/aws-native:connect:TaskTemplateFieldIdentifier"}},"type":"object","required":["id"]},"aws-native:connect:TaskTemplateStatus":{"description":"The status of the task template","type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Inactive","value":"INACTIVE"}]},"aws-native:connect:TaskTemplateTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. . You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:connect:TrafficDistributionGroupStatus":{"description":"The status of the traffic distribution group.","type":"string","enum":[{"name":"CreationInProgress","value":"CREATION_IN_PROGRESS"},{"name":"Active","value":"ACTIVE"},{"name":"CreationFailed","value":"CREATION_FAILED"},{"name":"PendingDeletion","value":"PENDING_DELETION"},{"name":"DeletionFailed","value":"DELETION_FAILED"},{"name":"UpdateInProgress","value":"UPDATE_IN_PROGRESS"}]},"aws-native:connect:TrafficDistributionGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:connect:UserAfterContactWorkConfig":{"description":"After Contact Work configuration.","properties":{"afterContactWorkTimeLimit":{"type":"integer"}},"type":"object"},"aws-native:connect:UserAfterContactWorkConfigPerChannel":{"description":"After Contact Work configuration per channel.","properties":{"afterContactWorkConfig":{"$ref":"#/types/aws-native:connect:UserAfterContactWorkConfig"},"agentFirstCallbackAfterContactWorkConfig":{"$ref":"#/types/aws-native:connect:UserAfterContactWorkConfig"},"channel":{"$ref":"#/types/aws-native:connect:UserChannel"}},"type":"object","required":["afterContactWorkConfig","channel"]},"aws-native:connect:UserAutoAcceptConfig":{"description":"Auto-accept configuration per channel.","properties":{"agentFirstCallbackAutoAccept":{"type":"boolean"},"autoAccept":{"type":"boolean"},"channel":{"$ref":"#/types/aws-native:connect:UserChannel"}},"type":"object","required":["autoAccept","channel"]},"aws-native:connect:UserChannel":{"description":"The channels that agents can handle in the Contact Control Panel (CCP).","type":"string","enum":[{"name":"Voice","value":"VOICE"},{"name":"Chat","value":"CHAT"},{"name":"Task","value":"TASK"},{"name":"Email","value":"EMAIL"}]},"aws-native:connect:UserHierarchyGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:connect:UserHierarchyStructureLevelFive":{"description":"Information about level five.","properties":{"hierarchyLevelArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the hierarchy level."},"hierarchyLevelId":{"type":"string","description":"The identifier of the hierarchy level."},"name":{"type":"string","description":"The name of the hierarchy level."}},"type":"object","required":["name"]},"aws-native:connect:UserHierarchyStructureLevelFour":{"description":"Information about level four.","properties":{"hierarchyLevelArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the hierarchy level."},"hierarchyLevelId":{"type":"string","description":"The identifier of the hierarchy level."},"name":{"type":"string","description":"The name of the hierarchy level."}},"type":"object","required":["name"]},"aws-native:connect:UserHierarchyStructureLevelOne":{"description":"Information about level one.","properties":{"hierarchyLevelArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the hierarchy level."},"hierarchyLevelId":{"type":"string","description":"The identifier of the hierarchy level."},"name":{"type":"string","description":"The name of the hierarchy level."}},"type":"object","required":["name"]},"aws-native:connect:UserHierarchyStructureLevelThree":{"description":"Information about level three.","properties":{"hierarchyLevelArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the hierarchy level."},"hierarchyLevelId":{"type":"string"},"name":{"type":"string","description":"The name of the hierarchy level."}},"type":"object","required":["name"]},"aws-native:connect:UserHierarchyStructureLevelTwo":{"description":"Information about level two.","properties":{"hierarchyLevelArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the hierarchy level."},"hierarchyLevelId":{"type":"string","description":"The identifier of the hierarchy level."},"name":{"type":"string","description":"The name of the hierarchy level."}},"type":"object","required":["name"]},"aws-native:connect:UserHierarchyStructureProperties":{"description":"Information about the hierarchy structure.","properties":{"levelFive":{"$ref":"#/types/aws-native:connect:UserHierarchyStructureLevelFive"},"levelFour":{"$ref":"#/types/aws-native:connect:UserHierarchyStructureLevelFour","description":"The update for level four."},"levelOne":{"$ref":"#/types/aws-native:connect:UserHierarchyStructureLevelOne","description":"The update for level one."},"levelThree":{"$ref":"#/types/aws-native:connect:UserHierarchyStructureLevelThree","description":"The update for level three."},"levelTwo":{"$ref":"#/types/aws-native:connect:UserHierarchyStructureLevelTwo","description":"The update for level two."}},"type":"object"},"aws-native:connect:UserIdentityInfo":{"description":"Contains information about the identity of a user.","properties":{"email":{"type":"string","description":"The email address. If you are using SAML for identity management and include this parameter, an error is returned."},"firstName":{"type":"string","description":"The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted."},"lastName":{"type":"string","description":"The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted."},"mobile":{"type":"string","description":"The user's mobile number."},"secondaryEmail":{"type":"string","description":"The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.\n\n*Pattern* : `(?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}`"}},"type":"object"},"aws-native:connect:UserPersistentConnectionConfig":{"description":"Persistent Connection configuration per channel.","properties":{"channel":{"$ref":"#/types/aws-native:connect:UserChannel"},"persistentConnection":{"type":"boolean"}},"type":"object","required":["channel","persistentConnection"]},"aws-native:connect:UserPhoneConfig":{"description":"Contains information about the phone configuration settings for a user.","properties":{"afterContactWorkTimeLimit":{"type":"integer","description":"The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.\n\n\u003e When returned by a `SearchUsers` call, `AfterContactWorkTimeLimit` is returned in milliseconds."},"autoAccept":{"type":"boolean","description":"The Auto accept setting."},"deskPhoneNumber":{"type":"string","description":"The phone number for the user's desk phone."},"persistentConnection":{"type":"boolean","description":"The persistent connection setting for the user."},"phoneType":{"$ref":"#/types/aws-native:connect:UserPhoneType","description":"The phone type."}},"type":"object"},"aws-native:connect:UserPhoneNumberConfig":{"description":"Phone Number configuration per channel.","properties":{"channel":{"$ref":"#/types/aws-native:connect:UserChannel"},"phoneNumber":{"type":"string"},"phoneType":{"$ref":"#/types/aws-native:connect:UserPhoneType"}},"type":"object","required":["channel","phoneType"]},"aws-native:connect:UserPhoneType":{"description":"The phone type.","type":"string","enum":[{"name":"SoftPhone","value":"SOFT_PHONE"},{"name":"DeskPhone","value":"DESK_PHONE"}]},"aws-native:connect:UserProficiency":{"description":"Proficiency of a user.","properties":{"attributeName":{"type":"string","description":"The name of user’s proficiency. You must use a predefined attribute name that is present in the Amazon Connect instance."},"attributeValue":{"type":"string","description":"The value of user’s proficiency. You must use a predefined attribute value that is present in the Amazon Connect instance."},"level":{"type":"number","description":"The level of the proficiency. The valid values are 1, 2, 3, 4 and 5."}},"type":"object","required":["attributeName","attributeValue","level"]},"aws-native:connect:UserTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is maximum of 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:connect:UserVoiceEnhancementConfig":{"description":"Voice Enhancement configuration per channel.","properties":{"channel":{"$ref":"#/types/aws-native:connect:UserChannel"},"voiceEnhancementMode":{"$ref":"#/types/aws-native:connect:UserVoiceEnhancementMode"}},"type":"object","required":["channel","voiceEnhancementMode"]},"aws-native:connect:UserVoiceEnhancementMode":{"description":"The Voice Enhancement Mode setting.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"VoiceIsolation","value":"VOICE_ISOLATION"},{"name":"NoiseSuppression","value":"NOISE_SUPPRESSION"}]},"aws-native:connect:ValidationProperties":{"description":"The validation rules applied to values of this attribute. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations for data integrity.","properties":{"enum":{"$ref":"#/types/aws-native:connect:ValidationPropertiesEnumProperties","description":"Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom values are permitted beyond the enumerated list."},"exclusiveMaximum":{"type":"number","description":"The largest exclusive numeric value for NUMBER value type. Can be provided alongside Maximum where both operate independently. Must be greater than ExclusiveMinimum and Minimum. Applies to NUMBER and values within NUMBER_LIST."},"exclusiveMinimum":{"type":"number","description":"The smallest exclusive numeric value for NUMBER value type. Can be provided alongside Minimum where both operate independently. Must be less than ExclusiveMaximum and Maximum. Applies to NUMBER and values within NUMBER_LIST."},"maxLength":{"type":"integer","description":"The maximum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be greater than or equal to MinLength."},"maxValues":{"type":"integer","description":"The maximum number of values in a list. Must be an integer greater than or equal to 0 and greater than or equal to MinValues. Applies to all list types."},"maximum":{"type":"number","description":"The largest inclusive numeric value for NUMBER value type. Can be provided alongside ExclusiveMaximum where both operate independently. Must be greater than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER and values within NUMBER_LIST."},"minLength":{"type":"integer","description":"The minimum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be less than or equal to MaxLength."},"minValues":{"type":"integer","description":"The minimum number of values in a list. Must be an integer greater than or equal to 0 and less than or equal to MaxValues. Applies to all list types."},"minimum":{"type":"number","description":"The smallest inclusive numeric value for NUMBER value type. Cannot be provided when ExclusiveMinimum is also provided. Must be less than or equal to Maximum and less than ExclusiveMaximum. Applies to NUMBER and values within NUMBER_LIST."},"multipleOf":{"type":"number","description":"Specifies that numeric values must be multiples of this number. Must be greater than 0. The result of dividing a value by this multiple must result in an integer. Applies to NUMBER and values within NUMBER_LIST."}},"type":"object"},"aws-native:connect:ValidationPropertiesEnumProperties":{"description":"Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom values are permitted beyond the enumerated list.","properties":{"strict":{"type":"boolean"},"values":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:connect:ValuesProperties":{"description":"The values of a predefined attribute.","properties":{"stringList":{"type":"array","items":{"type":"string"},"description":"Predefined attribute values of type string list."}},"type":"object"},"aws-native:connect:ViewTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters"},"value":{"type":"string","description":"The value for the tag. . You can specify a value that is maximum of 256 Unicode characters"}},"type":"object","required":["key","value"]},"aws-native:connect:WorkspaceFontFamily":{"type":"string","enum":[{"name":"Arial","value":"ARIAL"},{"name":"CourierNew","value":"COURIER_NEW"},{"name":"Georgia","value":"GEORGIA"},{"name":"TimesNewRoman","value":"TIMES_NEW_ROMAN"},{"name":"Trebuchet","value":"TREBUCHET"},{"name":"Verdana","value":"VERDANA"}]},"aws-native:connect:WorkspaceMediaItem":{"properties":{"source":{"type":"string","description":"The source URL or data for the media asset."},"type":{"$ref":"#/types/aws-native:connect:WorkspaceMediaType","description":"The type of media. Valid values are: `IMAGE_LOGO_FAVICON` and `IMAGE_LOGO_HORIZONTAL` ."}},"type":"object","required":["type"]},"aws-native:connect:WorkspaceMediaType":{"description":"The type of media","type":"string","enum":[{"name":"ImageLogoLightFavicon","value":"IMAGE_LOGO_LIGHT_FAVICON"},{"name":"ImageLogoDarkFavicon","value":"IMAGE_LOGO_DARK_FAVICON"},{"name":"ImageLogoLightHorizontal","value":"IMAGE_LOGO_LIGHT_HORIZONTAL"},{"name":"ImageLogoDarkHorizontal","value":"IMAGE_LOGO_DARK_HORIZONTAL"}]},"aws-native:connect:WorkspacePage":{"properties":{"inputData":{"type":"string","description":"The input data for the page."},"page":{"type":"string","description":"The page identifier."},"resourceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the resource associated with the page."},"slug":{"type":"string","description":"The slug for the page."}},"type":"object","required":["page","resourceArn"]},"aws-native:connect:WorkspacePaletteCanvas":{"properties":{"activeBackground":{"type":"string","description":"The background color for active elements."},"containerBackground":{"type":"string","description":"The background color for container elements."},"pageBackground":{"type":"string","description":"The background color for page elements."}},"type":"object"},"aws-native:connect:WorkspacePaletteHeader":{"properties":{"background":{"type":"string","description":"The background color of the header."},"invertActionsColors":{"type":"boolean","description":"Whether to invert the colors of action buttons in the header."},"text":{"type":"string","description":"The text color in the header."},"textHover":{"type":"string","description":"The text color when hovering over header elements."}},"type":"object"},"aws-native:connect:WorkspacePaletteNavigation":{"properties":{"background":{"type":"string","description":"The background color of the navigation area."},"invertActionsColors":{"type":"boolean","description":"Whether to invert the colors of action buttons in the navigation area."},"text":{"type":"string","description":"The text color in the navigation area."},"textActive":{"type":"string","description":"The text color for active navigation items."},"textBackgroundActive":{"type":"string","description":"The background color for active navigation items."},"textBackgroundHover":{"type":"string","description":"The background color when hovering over navigation text."},"textHover":{"type":"string","description":"The text color when hovering over navigation items."}},"type":"object"},"aws-native:connect:WorkspacePalettePrimary":{"properties":{"active":{"type":"string","description":"The primary color used for active states."},"contrastText":{"type":"string","description":"The text color that contrasts with the primary color for readability."},"default":{"type":"string","description":"The default primary color used throughout the workspace."}},"type":"object"},"aws-native:connect:WorkspaceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:connect:WorkspaceTheme":{"description":"The theme configuration for the Connect workspace","properties":{"dark":{"$ref":"#/types/aws-native:connect:WorkspaceThemeConfig","description":"The theme configuration for dark mode."},"light":{"$ref":"#/types/aws-native:connect:WorkspaceThemeConfig","description":"The theme configuration for light mode."}},"type":"object"},"aws-native:connect:WorkspaceThemeConfig":{"properties":{"palette":{"$ref":"#/types/aws-native:connect:WorkspaceThemePalette","description":"The color palette configuration for the workspace theme."},"typography":{"$ref":"#/types/aws-native:connect:WorkspaceThemeTypography","description":"The typography configuration for the workspace theme."}},"type":"object"},"aws-native:connect:WorkspaceThemePalette":{"properties":{"canvas":{"$ref":"#/types/aws-native:connect:WorkspacePaletteCanvas","description":"The color configuration for the canvas area."},"header":{"$ref":"#/types/aws-native:connect:WorkspacePaletteHeader","description":"The color configuration for the header area."},"navigation":{"$ref":"#/types/aws-native:connect:WorkspacePaletteNavigation","description":"The color configuration for the navigation area."},"primary":{"$ref":"#/types/aws-native:connect:WorkspacePalettePrimary","description":"The primary color configuration used throughout the workspace."}},"type":"object"},"aws-native:connect:WorkspaceThemeTypography":{"properties":{"fontFamily":{"$ref":"#/types/aws-native:connect:FontFamily","description":"The font family configuration for text in the workspace."}},"type":"object"},"aws-native:connect:WorkspaceVisibility":{"description":"The visibility of the Connect workspace","type":"string","enum":[{"name":"All","value":"ALL"},{"name":"Assigned","value":"ASSIGNED"},{"name":"None","value":"NONE"}]},"aws-native:connectcampaigns:CampaignAgentlessDialerConfig":{"description":"Agentless Dialer config","properties":{"dialingCapacity":{"type":"number","description":"Allocates dialing capacity for this campaign between multiple active campaigns."}},"type":"object"},"aws-native:connectcampaigns:CampaignAnswerMachineDetectionConfig":{"description":"The configuration used for answering machine detection during outbound calls","properties":{"awaitAnswerMachinePrompt":{"type":"boolean","description":"Enables detection of prompts (e.g., beep after after a voicemail greeting)"},"enableAnswerMachineDetection":{"type":"boolean","description":"Flag to decided whether outbound calls should have answering machine detection enabled or not"}},"type":"object","required":["enableAnswerMachineDetection"]},"aws-native:connectcampaigns:CampaignDialerConfig":{"description":"The possible types of dialer config parameters","properties":{"agentlessDialerConfig":{"$ref":"#/types/aws-native:connectcampaigns:CampaignAgentlessDialerConfig","description":"The configuration of the agentless dialer."},"predictiveDialerConfig":{"$ref":"#/types/aws-native:connectcampaigns:CampaignPredictiveDialerConfig","description":"The configuration of the predictive dialer."},"progressiveDialerConfig":{"$ref":"#/types/aws-native:connectcampaigns:CampaignProgressiveDialerConfig","description":"The configuration of the progressive dialer."}},"type":"object"},"aws-native:connectcampaigns:CampaignOutboundCallConfig":{"description":"The configuration used for outbound calls.","properties":{"answerMachineDetectionConfig":{"$ref":"#/types/aws-native:connectcampaigns:CampaignAnswerMachineDetectionConfig","description":"Whether answering machine detection has been enabled."},"connectContactFlowArn":{"type":"string","description":"The identifier of the contact flow for the outbound call."},"connectQueueArn":{"type":"string","description":"The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number."},"connectSourcePhoneNumber":{"type":"string","description":"The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue."}},"type":"object","required":["connectContactFlowArn"]},"aws-native:connectcampaigns:CampaignPredictiveDialerConfig":{"description":"Predictive Dialer config","properties":{"bandwidthAllocation":{"type":"number","description":"The bandwidth allocation of a queue resource."},"dialingCapacity":{"type":"number","description":"Allocates dialing capacity for this campaign between multiple active campaigns."}},"type":"object","required":["bandwidthAllocation"]},"aws-native:connectcampaigns:CampaignProgressiveDialerConfig":{"description":"Progressive Dialer config","properties":{"bandwidthAllocation":{"type":"number","description":"The bandwidth allocation of a queue resource."},"dialingCapacity":{"type":"number","description":"Allocates dialing capacity for this campaign between multiple active campaigns."}},"type":"object","required":["bandwidthAllocation"]},"aws-native:connectcampaigns:CampaignTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that's 1 to 256 characters in length."}},"type":"object","required":["key","value"]},"aws-native:connectcampaignsv2:CampaignAgentAction":{"description":"Actions that can performed on a contact by an agent","type":"string","enum":[{"name":"Discard","value":"DISCARD"}]},"aws-native:connectcampaignsv2:CampaignAgentlessConfig":{"description":"Agentless config","type":"object"},"aws-native:connectcampaignsv2:CampaignAnswerMachineDetectionConfig":{"description":"The configuration used for answering machine detection during outbound calls","properties":{"awaitAnswerMachinePrompt":{"type":"boolean","description":"Enables detection of prompts (e.g., beep after after a voicemail greeting)"},"enableAnswerMachineDetection":{"type":"boolean","description":"Flag to decided whether outbound calls should have answering machine detection enabled or not"}},"type":"object","required":["enableAnswerMachineDetection"]},"aws-native:connectcampaignsv2:CampaignChannelSubtypeConfig":{"description":"The possible types of channel subtype config parameters","properties":{"email":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignEmailChannelSubtypeConfig","description":"The configuration of the email channel subtype."},"sms":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignSmsChannelSubtypeConfig","description":"The configuration of the SMS channel subtype."},"telephony":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignTelephonyChannelSubtypeConfig","description":"The configuration of the telephony channel subtype."},"whatsApp":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignWhatsAppChannelSubtypeConfig","description":"The configuration of the WhatsApp channel subtype."}},"type":"object"},"aws-native:connectcampaignsv2:CampaignCommunicationLimit":{"description":"Communication Limit","properties":{"frequency":{"type":"integer"},"maxCountPerRecipient":{"type":"integer"},"unit":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignCommunicationLimitTimeUnit"}},"type":"object","required":["frequency","maxCountPerRecipient","unit"]},"aws-native:connectcampaignsv2:CampaignCommunicationLimitTimeUnit":{"description":"The communication limit time unit","type":"string","enum":[{"name":"Day","value":"DAY"}]},"aws-native:connectcampaignsv2:CampaignCommunicationLimits":{"description":"Communication limits","properties":{"communicationLimitList":{"type":"array","items":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignCommunicationLimit"},"description":"The list of CommunicationLimits."}},"type":"object"},"aws-native:connectcampaignsv2:CampaignCommunicationLimitsConfig":{"description":"Communication limits config","properties":{"allChannelsSubtypes":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignCommunicationLimits","description":"The CommunicationLimits that apply to all channel subtypes defined in an outbound campaign."},"instanceLimitsHandling":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignInstanceLimitsHandling","description":"Opt-in or Opt-out from instance-level limits."}},"type":"object"},"aws-native:connectcampaignsv2:CampaignCommunicationTimeConfig":{"description":"Campaign communication time config","properties":{"email":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignTimeWindow","description":"The communication time configuration for the email channel subtype."},"localTimeZoneConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignLocalTimeZoneConfig","description":"The local timezone configuration."},"sms":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignTimeWindow","description":"The communication time configuration for the SMS channel subtype."},"telephony":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignTimeWindow","description":"The communication time configuration for the telephony channel subtype."},"whatsApp":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignTimeWindow","description":"The communication time configuration for the WhatsApp channel subtype."}},"type":"object","required":["localTimeZoneConfig"]},"aws-native:connectcampaignsv2:CampaignDailyHour":{"description":"Daily Hour","properties":{"key":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignDayOfWeek"},"value":{"type":"array","items":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignTimeRange"}}},"type":"object"},"aws-native:connectcampaignsv2:CampaignDayOfWeek":{"description":"Day of week","type":"string","enum":[{"name":"Monday","value":"MONDAY"},{"name":"Tuesday","value":"TUESDAY"},{"name":"Wednesday","value":"WEDNESDAY"},{"name":"Thursday","value":"THURSDAY"},{"name":"Friday","value":"FRIDAY"},{"name":"Saturday","value":"SATURDAY"},{"name":"Sunday","value":"SUNDAY"}]},"aws-native:connectcampaignsv2:CampaignEmailChannelSubtypeConfig":{"description":"Email Channel Subtype config","properties":{"capacity":{"type":"number","description":"The allocation of email capacity between multiple running outbound campaigns."},"defaultOutboundConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignEmailOutboundConfig","description":"The default email outbound configuration of an outbound campaign."},"outboundMode":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignEmailOutboundMode","description":"The outbound mode for email of an outbound campaign."}},"type":"object","required":["defaultOutboundConfig","outboundMode"]},"aws-native:connectcampaignsv2:CampaignEmailOutboundConfig":{"description":"Default Email outbound config","properties":{"connectSourceEmailAddress":{"type":"string","description":"The Amazon Connect source email address."},"sourceEmailAddressDisplayName":{"type":"string","description":"The display name for the Amazon Connect source email address."},"wisdomTemplateArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon Q in Connect template."}},"type":"object","required":["connectSourceEmailAddress","wisdomTemplateArn"]},"aws-native:connectcampaignsv2:CampaignEmailOutboundMode":{"description":"Email Outbound Mode","properties":{"agentlessConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignAgentlessConfig","description":"The agentless outbound mode configuration for email."}},"type":"object"},"aws-native:connectcampaignsv2:CampaignEventTrigger":{"description":"The event trigger of the campaign","properties":{"customerProfilesDomainArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Customer Profiles domain."}},"type":"object"},"aws-native:connectcampaignsv2:CampaignInstanceLimitsHandling":{"description":"Enumeration of Instance Limits handling in a Campaign","type":"string","enum":[{"name":"OptIn","value":"OPT_IN"},{"name":"OptOut","value":"OPT_OUT"}]},"aws-native:connectcampaignsv2:CampaignLocalTimeZoneConfig":{"description":"Local time zone config","properties":{"defaultTimeZone":{"type":"string","description":"The timezone to use for all recipients."},"localTimeZoneDetection":{"type":"array","items":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignLocalTimeZoneDetectionType"},"description":"Detects methods for the recipient's timezone."}},"type":"object"},"aws-native:connectcampaignsv2:CampaignLocalTimeZoneDetectionType":{"description":"Local TimeZone Detection method","type":"string","enum":[{"name":"ZipCode","value":"ZIP_CODE"},{"name":"AreaCode","value":"AREA_CODE"}]},"aws-native:connectcampaignsv2:CampaignOpenHours":{"description":"Open Hours config","properties":{"dailyHours":{"type":"array","items":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignDailyHour"},"description":"The daily hours configuration."}},"type":"object","required":["dailyHours"]},"aws-native:connectcampaignsv2:CampaignPredictiveConfig":{"description":"Predictive config","properties":{"bandwidthAllocation":{"type":"number","description":"Bandwidth allocation for the predictive outbound mode."}},"type":"object","required":["bandwidthAllocation"]},"aws-native:connectcampaignsv2:CampaignPreviewConfig":{"description":"Preview config","properties":{"agentActions":{"type":"array","items":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignAgentAction"},"description":"Agent actions for the preview outbound mode."},"bandwidthAllocation":{"type":"number","description":"Bandwidth allocation for the preview outbound mode."},"timeoutConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignTimeoutConfig","description":"Countdown timer configuration for preview outbound mode."}},"type":"object","required":["bandwidthAllocation","timeoutConfig"]},"aws-native:connectcampaignsv2:CampaignProgressiveConfig":{"description":"Progressive config","properties":{"bandwidthAllocation":{"type":"number","description":"Bandwidth allocation for the progressive outbound mode."}},"type":"object","required":["bandwidthAllocation"]},"aws-native:connectcampaignsv2:CampaignRestrictedPeriod":{"description":"Restricted period","properties":{"endDate":{"type":"string"},"name":{"type":"string","description":"The name of a restricted period"},"startDate":{"type":"string"}},"type":"object","required":["endDate","startDate"]},"aws-native:connectcampaignsv2:CampaignRestrictedPeriods":{"description":"Restricted period config","properties":{"restrictedPeriodList":{"type":"array","items":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignRestrictedPeriod"},"description":"The restricted period list."}},"type":"object"},"aws-native:connectcampaignsv2:CampaignSchedule":{"description":"Campaign schedule","properties":{"endTime":{"type":"string","description":"The end time of the schedule in UTC."},"refreshFrequency":{"type":"string","description":"The refresh frequency of the campaign."},"startTime":{"type":"string","description":"The start time of the schedule in UTC."}},"type":"object","required":["endTime","startTime"]},"aws-native:connectcampaignsv2:CampaignSmsChannelSubtypeConfig":{"description":"SMS Channel Subtype config","properties":{"capacity":{"type":"number","description":"The allocation of SMS capacity between multiple running outbound campaigns."},"defaultOutboundConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignSmsOutboundConfig","description":"The default SMS outbound configuration of an outbound campaign."},"outboundMode":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignSmsOutboundMode","description":"The outbound mode of SMS for an outbound campaign."}},"type":"object","required":["defaultOutboundConfig","outboundMode"]},"aws-native:connectcampaignsv2:CampaignSmsOutboundConfig":{"description":"Default SMS outbound config","properties":{"connectSourcePhoneNumberArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon Connect source SMS phone number."},"wisdomTemplateArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon Q in Connect template."}},"type":"object","required":["connectSourcePhoneNumberArn","wisdomTemplateArn"]},"aws-native:connectcampaignsv2:CampaignSmsOutboundMode":{"description":"SMS Outbound Mode","properties":{"agentlessConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignAgentlessConfig","description":"Contains agentless outbound mode configuration."}},"type":"object"},"aws-native:connectcampaignsv2:CampaignSource":{"description":"The possible source of the campaign","properties":{"customerProfilesSegmentArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Customer Profiles segment."},"eventTrigger":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignEventTrigger","description":"The event trigger of the campaign."}},"type":"object"},"aws-native:connectcampaignsv2:CampaignTag":{"properties":{"key":{"type":"string","description":"The key name of the tag."},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key","value"]},"aws-native:connectcampaignsv2:CampaignTelephonyChannelSubtypeConfig":{"description":"Telephony Channel Subtype config","properties":{"capacity":{"type":"number","description":"The allocation of telephony capacity between multiple running outbound campaigns."},"connectQueueId":{"type":"string","description":"The identifier of the Amazon Connect queue associated with telephony outbound requests of an outbound campaign."},"defaultOutboundConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignTelephonyOutboundConfig","description":"The default telephony outbound configuration of an outbound campaign."},"outboundMode":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignTelephonyOutboundMode","description":"The outbound mode of telephony for an outbound campaign."}},"type":"object","required":["defaultOutboundConfig","outboundMode"]},"aws-native:connectcampaignsv2:CampaignTelephonyOutboundConfig":{"description":"Default Telephone Outbound config","properties":{"answerMachineDetectionConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignAnswerMachineDetectionConfig","description":"The answering machine detection configuration."},"connectContactFlowId":{"type":"string","description":"The identifier of the published Amazon Connect contact flow."},"connectSourcePhoneNumber":{"type":"string","description":"The Amazon Connect source phone number."},"ringTimeout":{"type":"integer","description":"The ring timeout configuration for outbound calls. Specifies how long to wait for the call to be answered before timing out."}},"type":"object","required":["connectContactFlowId"]},"aws-native:connectcampaignsv2:CampaignTelephonyOutboundMode":{"description":"Telephony Outbound Mode","properties":{"agentlessConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignAgentlessConfig","description":"The agentless outbound mode configuration for telephony."},"predictiveConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignPredictiveConfig","description":"Contains predictive outbound mode configuration."},"previewConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignPreviewConfig","description":"Contains preview outbound mode configuration."},"progressiveConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignProgressiveConfig","description":"Contains progressive telephony outbound mode configuration."}},"type":"object"},"aws-native:connectcampaignsv2:CampaignTimeRange":{"description":"Time range in 24 hour format","properties":{"endTime":{"type":"string"},"startTime":{"type":"string"}},"type":"object","required":["endTime","startTime"]},"aws-native:connectcampaignsv2:CampaignTimeWindow":{"description":"Time window config","properties":{"openHours":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignOpenHours","description":"The open hours configuration."},"restrictedPeriods":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignRestrictedPeriods","description":"The restricted periods configuration."}},"type":"object","required":["openHours"]},"aws-native:connectcampaignsv2:CampaignTimeoutConfig":{"description":"Timeout Config for preview contacts","properties":{"durationInSeconds":{"type":"integer","description":"Duration in seconds for the countdown timer."}},"type":"object"},"aws-native:connectcampaignsv2:CampaignType":{"description":"Campaign type","type":"string","enum":[{"name":"Managed","value":"MANAGED"},{"name":"Journey","value":"JOURNEY"}]},"aws-native:connectcampaignsv2:CampaignWhatsAppChannelSubtypeConfig":{"description":"WhatsApp Channel Subtype config","properties":{"capacity":{"type":"number","description":"The allocation of WhatsApp capacity between multiple running outbound campaigns."},"defaultOutboundConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignWhatsAppOutboundConfig","description":"The default WhatsApp outbound configuration of an outbound campaign."},"outboundMode":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignWhatsAppOutboundMode","description":"The outbound mode for WhatsApp of an outbound campaign."}},"type":"object","required":["defaultOutboundConfig","outboundMode"]},"aws-native:connectcampaignsv2:CampaignWhatsAppOutboundConfig":{"description":"Default WhatsApp outbound config","properties":{"connectSourcePhoneNumberArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon Connect source WhatsApp phone number."},"wisdomTemplateArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon Q in Connect template."}},"type":"object","required":["connectSourcePhoneNumberArn","wisdomTemplateArn"]},"aws-native:connectcampaignsv2:CampaignWhatsAppOutboundMode":{"description":"WhatsApp Outbound Mode","properties":{"agentlessConfig":{"$ref":"#/types/aws-native:connectcampaignsv2:CampaignAgentlessConfig"}},"type":"object"},"aws-native:controltower:EnabledBaselineParameter":{"properties":{"key":{"type":"string"},"value":{"oneOf":[{"type":"string"},{"$ref":"pulumi.json#/Any"},{"type":"number"},{"type":"array","items":{"oneOf":[{"type":"boolean"},{"type":"number"},{"$ref":"pulumi.json#/Any"},{"type":"string"}]}},{"type":"boolean"}]}},"type":"object"},"aws-native:controltower:EnabledBaselineTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:controltower:EnabledControlParameter":{"properties":{"key":{"type":"string","description":"The key of a key/value pair. It is of type `string` ."},"value":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"number"},{"$ref":"pulumi.json#/Any"},{"type":"boolean"}]}},{"type":"string"},{"type":"number"},{"$ref":"pulumi.json#/Any"},{"type":"boolean"}],"description":"The value of a key/value pair. It can be of type `array` , `string` , `number` , `object` , or `boolean` . [Note: The *Type* field that follows may show a single type such as Number, which is only one possible type.]"}},"type":"object","required":["key","value"]},"aws-native:controltower:EnabledControlTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:."}},"type":"object","required":["key","value"]},"aws-native:controltower:LandingZoneDriftStatus":{"type":"string","enum":[{"name":"Drifted","value":"DRIFTED"},{"name":"InSync","value":"IN_SYNC"}]},"aws-native:controltower:LandingZoneRemediationTypesItem":{"type":"string","enum":[{"name":"InheritanceDrift","value":"INHERITANCE_DRIFT"}]},"aws-native:controltower:LandingZoneStatus":{"type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Processing","value":"PROCESSING"},{"name":"Failed","value":"FAILED"}]},"aws-native:controltower:LandingZoneTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with `aws:` . digits, whitespace, `_` , `.` , `:` , `/` , `=` , `+` , `@` , `-` , and `\"` .\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) ."},"value":{"type":"string","description":"The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_` , `.` , `/` , `=` , `+` , and `-` .\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) ."}},"type":"object"},"aws-native:customerprofiles:CalculatedAttributeDefinitionAttributeDetails":{"description":"Mathematical expression and a list of attribute items specified in that expression.","properties":{"attributes":{"type":"array","items":{"$ref":"#/types/aws-native:customerprofiles:CalculatedAttributeDefinitionAttributeItem"},"description":"Mathematical expression and a list of attribute items specified in that expression."},"expression":{"type":"string","description":"Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of \\\"{ObjectTypeName.AttributeName}\\\"."}},"type":"object","required":["attributes","expression"]},"aws-native:customerprofiles:CalculatedAttributeDefinitionAttributeItem":{"description":"The details of a single attribute item specified in the mathematical expression.","properties":{"name":{"type":"string"}},"type":"object","required":["name"]},"aws-native:customerprofiles:CalculatedAttributeDefinitionConditions":{"description":"The conditions including range, object count, and threshold for the calculated attribute.","properties":{"objectCount":{"type":"integer","description":"The number of profile objects used for the calculated attribute."},"range":{"$ref":"#/types/aws-native:customerprofiles:CalculatedAttributeDefinitionRange","description":"The relative time period over which data is included in the aggregation."},"threshold":{"$ref":"#/types/aws-native:customerprofiles:CalculatedAttributeDefinitionThreshold","description":"The threshold for the calculated attribute."}},"type":"object"},"aws-native:customerprofiles:CalculatedAttributeDefinitionRange":{"description":"The relative time period over which data is included in the aggregation.","properties":{"timestampFormat":{"type":"string","description":"The format the timestamp field in your JSON object is specified. This value should be one of EPOCHMILLI or ISO_8601. E.g. if your object type is MyType and source JSON is {\"generatedAt\": {\"timestamp\": \"2001-07-04T12:08:56.235Z\"}}, then TimestampFormat should be \"ISO_8601\".","replaceOnChanges":true},"timestampSource":{"type":"string","description":"An expression specifying the field in your JSON object from which the date should be parsed. The expression should follow the structure of \\\"{ObjectTypeName.\u003cLocation of timestamp field in JSON pointer format\u003e}\\\". E.g. if your object type is MyType and source JSON is {\"generatedAt\": {\"timestamp\": \"1737587945945\"}}, then TimestampSource should be \"{MyType.generatedAt.timestamp}\".","replaceOnChanges":true},"unit":{"$ref":"#/types/aws-native:customerprofiles:CalculatedAttributeDefinitionRangeUnit","description":"The unit of time."},"value":{"type":"integer","description":"The amount of time of the specified unit."},"valueRange":{"$ref":"#/types/aws-native:customerprofiles:CalculatedAttributeDefinitionValueRange","description":"A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute. Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value."}},"type":"object","required":["unit"]},"aws-native:customerprofiles:CalculatedAttributeDefinitionRangeUnit":{"description":"The unit of time.","type":"string","enum":[{"name":"Days","value":"DAYS"}]},"aws-native:customerprofiles:CalculatedAttributeDefinitionReadiness":{"description":"The readiness status of the calculated attribute.","properties":{"message":{"type":"string","description":"Any information pertaining to the status of the calculated attribute if required."},"progressPercentage":{"type":"integer","description":"The progress percentage for including historical data in your calculated attribute."}},"type":"object"},"aws-native:customerprofiles:CalculatedAttributeDefinitionStatistic":{"description":"The aggregation operation to perform for the calculated attribute.","type":"string","enum":[{"name":"FirstOccurrence","value":"FIRST_OCCURRENCE"},{"name":"LastOccurrence","value":"LAST_OCCURRENCE"},{"name":"Count","value":"COUNT"},{"name":"Sum","value":"SUM"},{"name":"Minimum","value":"MINIMUM"},{"name":"Maximum","value":"MAXIMUM"},{"name":"Average","value":"AVERAGE"},{"name":"MaxOccurrence","value":"MAX_OCCURRENCE"}]},"aws-native:customerprofiles:CalculatedAttributeDefinitionStatus":{"description":"The status of the calculated attribute definition.","type":"string","enum":[{"name":"InProgress","value":"IN_PROGRESS"},{"name":"Preparing","value":"PREPARING"},{"name":"Completed","value":"COMPLETED"},{"name":"Failed","value":"FAILED"}]},"aws-native:customerprofiles:CalculatedAttributeDefinitionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:customerprofiles:CalculatedAttributeDefinitionThreshold":{"description":"The threshold for the calculated attribute.","properties":{"operator":{"$ref":"#/types/aws-native:customerprofiles:CalculatedAttributeDefinitionThresholdOperator","description":"The operator of the threshold."},"value":{"type":"string","description":"The value of the threshold."}},"type":"object","required":["operator","value"]},"aws-native:customerprofiles:CalculatedAttributeDefinitionThresholdOperator":{"description":"The operator of the threshold.","type":"string","enum":[{"name":"EqualTo","value":"EQUAL_TO"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"LessThan","value":"LESS_THAN"},{"name":"NotEqualTo","value":"NOT_EQUAL_TO"}]},"aws-native:customerprofiles:CalculatedAttributeDefinitionValueRange":{"description":"A structure specifying the endpoints of the relative time period over which data is included in the aggregation.","properties":{"end":{"type":"integer","description":"The ending point for this range. Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future."},"start":{"type":"integer","description":"The starting point for this range. Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future."}},"type":"object","required":["end","start"]},"aws-native:customerprofiles:DestinationDetailsProperties":{"description":"Details regarding the Kinesis stream.","properties":{"status":{"$ref":"#/types/aws-native:customerprofiles:EventStreamStatus","description":"The status of enabling the Kinesis stream as a destination for export."},"uri":{"type":"string","description":"The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name."}},"type":"object","required":["status","uri"]},"aws-native:customerprofiles:DomainAttributeTypesSelector":{"description":"Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.","properties":{"address":{"type":"array","items":{"type":"string"},"description":"The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress. You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule."},"attributeMatchingModel":{"$ref":"#/types/aws-native:customerprofiles:DomainAttributeTypesSelectorAttributeMatchingModel","description":"Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY."},"emailAddress":{"type":"array","items":{"type":"string"},"description":"The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress. You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule."},"phoneNumber":{"type":"array","items":{"type":"string"},"description":"The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber. You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule."}},"type":"object","required":["attributeMatchingModel"]},"aws-native:customerprofiles:DomainAttributeTypesSelectorAttributeMatchingModel":{"description":"Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.","type":"string","enum":[{"name":"OneToOne","value":"ONE_TO_ONE"},{"name":"ManyToMany","value":"MANY_TO_MANY"}]},"aws-native:customerprofiles:DomainAutoMerging":{"description":"Configuration information about the auto-merging process.","properties":{"conflictResolution":{"$ref":"#/types/aws-native:customerprofiles:DomainConflictResolution","description":"Determines how the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same `FirstName` and `LastName` , `ConflictResolution` specifies which `EmailAddress` should be used."},"consolidation":{"$ref":"#/types/aws-native:customerprofiles:DomainConsolidation","description":"A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged."},"enabled":{"type":"boolean","description":"The flag that enables the auto-merging of duplicate profiles."},"minAllowedConfidenceScoreForMerging":{"type":"number","description":"A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles."}},"type":"object","required":["enabled"]},"aws-native:customerprofiles:DomainConflictResolution":{"description":"How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used? ","properties":{"conflictResolvingModel":{"$ref":"#/types/aws-native:customerprofiles:DomainConflictResolutionConflictResolvingModel","description":"How the auto-merging process should resolve conflicts between different profiles."},"sourceName":{"type":"string","description":"The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel."}},"type":"object","required":["conflictResolvingModel"]},"aws-native:customerprofiles:DomainConflictResolutionConflictResolvingModel":{"description":"How the auto-merging process should resolve conflicts between different profiles.","type":"string","enum":[{"name":"Recency","value":"RECENCY"},{"name":"Source","value":"SOURCE"}]},"aws-native:customerprofiles:DomainConsolidation":{"description":"A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.","properties":{"matchingAttributesList":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"A list of matching criteria."}},"type":"object","required":["matchingAttributesList"]},"aws-native:customerprofiles:DomainDataStore":{"description":"Configuration and status of the data store for the domain.","properties":{"enabled":{"type":"boolean","description":"Whether the data store is enabled."},"readiness":{"$ref":"#/types/aws-native:customerprofiles:DomainReadiness"}},"type":"object"},"aws-native:customerprofiles:DomainExportingConfig":{"description":"Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.","properties":{"s3Exporting":{"$ref":"#/types/aws-native:customerprofiles:DomainS3ExportingConfig"}},"type":"object"},"aws-native:customerprofiles:DomainJobSchedule":{"description":"The day and time when do you want to start the Identity Resolution Job every week.","properties":{"dayOfTheWeek":{"$ref":"#/types/aws-native:customerprofiles:DomainJobScheduleDayOfTheWeek","description":"The day when the Identity Resolution Job should run every week."},"time":{"type":"string","description":"The time when the Identity Resolution Job should run every week."}},"type":"object","required":["dayOfTheWeek","time"]},"aws-native:customerprofiles:DomainJobScheduleDayOfTheWeek":{"description":"The day when the Identity Resolution Job should run every week.","type":"string","enum":[{"name":"Sunday","value":"SUNDAY"},{"name":"Monday","value":"MONDAY"},{"name":"Tuesday","value":"TUESDAY"},{"name":"Wednesday","value":"WEDNESDAY"},{"name":"Thursday","value":"THURSDAY"},{"name":"Friday","value":"FRIDAY"},{"name":"Saturday","value":"SATURDAY"}]},"aws-native:customerprofiles:DomainMatching":{"description":"The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.","properties":{"autoMerging":{"$ref":"#/types/aws-native:customerprofiles:DomainAutoMerging","description":"Configuration information about the auto-merging process."},"enabled":{"type":"boolean","description":"The flag that enables the matching process of duplicate profiles."},"exportingConfig":{"$ref":"#/types/aws-native:customerprofiles:DomainExportingConfig","description":"The S3 location where Identity Resolution Jobs write result files."},"jobSchedule":{"$ref":"#/types/aws-native:customerprofiles:DomainJobSchedule","description":"The day and time when do you want to start the Identity Resolution Job every week."}},"type":"object","required":["enabled"]},"aws-native:customerprofiles:DomainMatchingRule":{"description":"Specifies how does the rule-based matching process should match profiles.","properties":{"rule":{"type":"array","items":{"type":"string"},"description":"A single rule level of the `MatchRules` . Configures how the rule-based matching process should match profiles."}},"type":"object","required":["rule"]},"aws-native:customerprofiles:DomainReadiness":{"description":"Progress information for data store setup.","properties":{"message":{"type":"string","description":"A message describing the current progress."},"progressPercentage":{"type":"integer","description":"The percentage of progress completed."}},"type":"object"},"aws-native:customerprofiles:DomainRuleBasedMatching":{"description":"The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.","properties":{"attributeTypesSelector":{"$ref":"#/types/aws-native:customerprofiles:DomainAttributeTypesSelector","description":"Configures information about the `AttributeTypesSelector` where the rule-based identity resolution uses to match profiles."},"conflictResolution":{"$ref":"#/types/aws-native:customerprofiles:DomainConflictResolution","description":"Determines how the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same `FirstName` and `LastName` , `ConflictResolution` specifies which `EmailAddress` should be used."},"enabled":{"type":"boolean","description":"The flag that enables the rule-based matching process of duplicate profiles."},"exportingConfig":{"$ref":"#/types/aws-native:customerprofiles:DomainExportingConfig","description":"The S3 location where Identity Resolution Jobs write result files."},"matchingRules":{"type":"array","items":{"$ref":"#/types/aws-native:customerprofiles:DomainMatchingRule"},"description":"Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules."},"maxAllowedRuleLevelForMatching":{"type":"integer","description":"Indicates the maximum allowed rule level for matching."},"maxAllowedRuleLevelForMerging":{"type":"integer","description":"Indicates the maximum allowed rule level for merging."},"status":{"$ref":"#/types/aws-native:customerprofiles:DomainRuleBasedMatchingStatus","description":"The status of rule-based matching rule."}},"type":"object","required":["enabled"]},"aws-native:customerprofiles:DomainRuleBasedMatchingStatus":{"description":"The status of rule-based matching rule.","type":"string","enum":[{"name":"Pending","value":"PENDING"},{"name":"InProgress","value":"IN_PROGRESS"},{"name":"Active","value":"ACTIVE"}]},"aws-native:customerprofiles:DomainS3ExportingConfig":{"description":"The S3 location where Identity Resolution Jobs write result files.","properties":{"s3BucketName":{"type":"string","description":"The name of the S3 bucket where Identity Resolution Jobs write result files."},"s3KeyName":{"type":"string","description":"The S3 key name of the location where Identity Resolution Jobs write result files."}},"type":"object","required":["s3BucketName"]},"aws-native:customerprofiles:DomainStats":{"description":"Usage-specific statistics about the domain.","properties":{"meteringProfileCount":{"type":"number","description":"The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on."},"objectCount":{"type":"number","description":"The total number of objects in domain."},"profileCount":{"type":"number","description":"The total number of profiles currently in the domain."},"totalSize":{"type":"number","description":"The total size, in bytes, of all objects in the domain."}},"type":"object"},"aws-native:customerprofiles:DomainTag":{"properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:customerprofiles:EventStreamState":{"description":"The operational state of destination stream for export.","type":"string","enum":[{"name":"Running","value":"RUNNING"},{"name":"Stopped","value":"STOPPED"}]},"aws-native:customerprofiles:EventStreamStatus":{"description":"The status of enabling the Kinesis stream as a destination for export.","type":"string","enum":[{"name":"Healthy","value":"HEALTHY"},{"name":"Unhealthy","value":"UNHEALTHY"}]},"aws-native:customerprofiles:EventStreamTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:customerprofiles:EventTriggerCondition":{"description":"Specifies the circumstances under which the event should trigger the destination.","properties":{"eventTriggerDimensions":{"type":"array","items":{"$ref":"#/types/aws-native:customerprofiles:EventTriggerDimension"}},"logicalOperator":{"$ref":"#/types/aws-native:customerprofiles:EventTriggerLogicalOperator"}},"type":"object","required":["eventTriggerDimensions","logicalOperator"]},"aws-native:customerprofiles:EventTriggerDimension":{"description":"A specific event dimension to be assessed.","properties":{"objectAttributes":{"type":"array","items":{"$ref":"#/types/aws-native:customerprofiles:EventTriggerObjectAttribute"}}},"type":"object","required":["objectAttributes"]},"aws-native:customerprofiles:EventTriggerLimits":{"description":"Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.","properties":{"eventExpiration":{"type":"integer","description":"Specifies that an event will only trigger the destination if it is processed within a certain latency period."},"periods":{"type":"array","items":{"$ref":"#/types/aws-native:customerprofiles:EventTriggerPeriod"},"description":"A list of time periods during which the limits apply."}},"type":"object"},"aws-native:customerprofiles:EventTriggerLogicalOperator":{"description":"The operator used to combine multiple dimensions.","type":"string","enum":[{"name":"Any","value":"ANY"},{"name":"All","value":"ALL"},{"name":"None","value":"NONE"}]},"aws-native:customerprofiles:EventTriggerObjectAttribute":{"description":"The criteria that a specific object attribute must meet to trigger the destination.","properties":{"comparisonOperator":{"$ref":"#/types/aws-native:customerprofiles:EventTriggerObjectAttributeComparisonOperator","description":"The operator used to compare an attribute against a list of values."},"fieldName":{"type":"string","description":"A field defined within an object type."},"source":{"type":"string","description":"An attribute contained within a source object."},"values":{"type":"array","items":{"type":"string"},"description":"A list of attribute values used for comparison."}},"type":"object","required":["comparisonOperator","values"]},"aws-native:customerprofiles:EventTriggerObjectAttributeComparisonOperator":{"description":"The operator used to compare an attribute against a list of values.","type":"string","enum":[{"name":"Inclusive","value":"INCLUSIVE"},{"name":"Exclusive","value":"EXCLUSIVE"},{"name":"Contains","value":"CONTAINS"},{"name":"BeginsWith","value":"BEGINS_WITH"},{"name":"EndsWith","value":"ENDS_WITH"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"LessThan","value":"LESS_THAN"},{"name":"GreaterThanOrEqual","value":"GREATER_THAN_OR_EQUAL"},{"name":"LessThanOrEqual","value":"LESS_THAN_OR_EQUAL"},{"name":"Equal","value":"EQUAL"},{"name":"Before","value":"BEFORE"},{"name":"After","value":"AFTER"},{"name":"On","value":"ON"},{"name":"Between","value":"BETWEEN"},{"name":"NotBetween","value":"NOT_BETWEEN"}]},"aws-native:customerprofiles:EventTriggerPeriod":{"description":"Defines a limit and the time period during which it is enforced.","properties":{"maxInvocationsPerProfile":{"type":"integer","description":"The maximum allowed number of destination invocations per profile."},"unit":{"$ref":"#/types/aws-native:customerprofiles:EventTriggerPeriodUnit","description":"The unit of time."},"unlimited":{"type":"boolean","description":"If set to true, there is no limit on the number of destination invocations per profile. The default is false."},"value":{"type":"integer","description":"The amount of time of the specified unit."}},"type":"object","required":["unit","value"]},"aws-native:customerprofiles:EventTriggerPeriodUnit":{"description":"The unit of time.","type":"string","enum":[{"name":"Hours","value":"HOURS"},{"name":"Days","value":"DAYS"},{"name":"Weeks","value":"WEEKS"},{"name":"Months","value":"MONTHS"}]},"aws-native:customerprofiles:EventTriggerTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:customerprofiles:IntegrationConnectorOperator":{"properties":{"marketo":{"$ref":"#/types/aws-native:customerprofiles:IntegrationMarketoConnectorOperator","description":"The operation to be performed on the provided Marketo source fields."},"s3":{"$ref":"#/types/aws-native:customerprofiles:IntegrationS3ConnectorOperator","description":"The operation to be performed on the provided Amazon S3 source fields."},"salesforce":{"$ref":"#/types/aws-native:customerprofiles:IntegrationSalesforceConnectorOperator","description":"The operation to be performed on the provided Salesforce source fields."},"serviceNow":{"$ref":"#/types/aws-native:customerprofiles:IntegrationServiceNowConnectorOperator","description":"The operation to be performed on the provided ServiceNow source fields."},"zendesk":{"$ref":"#/types/aws-native:customerprofiles:IntegrationZendeskConnectorOperator","description":"The operation to be performed on the provided Zendesk source fields."}},"type":"object"},"aws-native:customerprofiles:IntegrationConnectorType":{"type":"string","enum":[{"name":"Salesforce","value":"Salesforce"},{"name":"Marketo","value":"Marketo"},{"name":"ServiceNow","value":"ServiceNow"},{"name":"Zendesk","value":"Zendesk"},{"name":"S3","value":"S3"}]},"aws-native:customerprofiles:IntegrationFlowDefinition":{"properties":{"description":{"type":"string","description":"A description of the flow you want to create."},"flowName":{"type":"string","description":"The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed."},"kmsArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key you provide for encryption."},"sourceFlowConfig":{"$ref":"#/types/aws-native:customerprofiles:IntegrationSourceFlowConfig","description":"The configuration that controls how Customer Profiles retrieves data from the source."},"tasks":{"type":"array","items":{"$ref":"#/types/aws-native:customerprofiles:IntegrationTask"},"description":"A list of tasks that Customer Profiles performs while transferring the data in the flow run."},"triggerConfig":{"$ref":"#/types/aws-native:customerprofiles:IntegrationTriggerConfig","description":"The trigger settings that determine how and when the flow runs."}},"type":"object","required":["flowName","kmsArn","sourceFlowConfig","tasks","triggerConfig"]},"aws-native:customerprofiles:IntegrationIncrementalPullConfig":{"properties":{"datetimeTypeFieldName":{"type":"string","description":"A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source."}},"type":"object"},"aws-native:customerprofiles:IntegrationMarketoConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"LessThan","value":"LESS_THAN"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Between","value":"BETWEEN"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:customerprofiles:IntegrationMarketoSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Marketo flow source."}},"type":"object","required":["object"]},"aws-native:customerprofiles:IntegrationObjectTypeMapping":{"properties":{"key":{"type":"string","description":"The key."},"value":{"type":"string","description":"The value."}},"type":"object","required":["key","value"]},"aws-native:customerprofiles:IntegrationOperatorPropertiesKeys":{"type":"string","enum":[{"name":"Value","value":"VALUE"},{"name":"Values","value":"VALUES"},{"name":"DataType","value":"DATA_TYPE"},{"name":"UpperBound","value":"UPPER_BOUND"},{"name":"LowerBound","value":"LOWER_BOUND"},{"name":"SourceDataType","value":"SOURCE_DATA_TYPE"},{"name":"DestinationDataType","value":"DESTINATION_DATA_TYPE"},{"name":"ValidationAction","value":"VALIDATION_ACTION"},{"name":"MaskValue","value":"MASK_VALUE"},{"name":"MaskLength","value":"MASK_LENGTH"},{"name":"TruncateLength","value":"TRUNCATE_LENGTH"},{"name":"MathOperationFieldsOrder","value":"MATH_OPERATION_FIELDS_ORDER"},{"name":"ConcatFormat","value":"CONCAT_FORMAT"},{"name":"SubfieldCategoryMap","value":"SUBFIELD_CATEGORY_MAP"}]},"aws-native:customerprofiles:IntegrationS3ConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"LessThan","value":"LESS_THAN"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Between","value":"BETWEEN"},{"name":"LessThanOrEqualTo","value":"LESS_THAN_OR_EQUAL_TO"},{"name":"GreaterThanOrEqualTo","value":"GREATER_THAN_OR_EQUAL_TO"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"NotEqualTo","value":"NOT_EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:customerprofiles:IntegrationS3SourceProperties":{"properties":{"bucketName":{"type":"string","description":"The Amazon S3 bucket name where the source files are stored."},"bucketPrefix":{"type":"string","description":"The object key for the Amazon S3 bucket in which the source files are stored."}},"type":"object","required":["bucketName"]},"aws-native:customerprofiles:IntegrationSalesforceConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"LessThan","value":"LESS_THAN"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Contains","value":"CONTAINS"},{"name":"Between","value":"BETWEEN"},{"name":"LessThanOrEqualTo","value":"LESS_THAN_OR_EQUAL_TO"},{"name":"GreaterThanOrEqualTo","value":"GREATER_THAN_OR_EQUAL_TO"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"NotEqualTo","value":"NOT_EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:customerprofiles:IntegrationSalesforceSourceProperties":{"properties":{"enableDynamicFieldUpdate":{"type":"boolean","description":"The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow."},"includeDeletedRecords":{"type":"boolean","description":"Indicates whether Amazon AppFlow includes deleted files in the flow run."},"object":{"type":"string","description":"The object specified in the Salesforce flow source."}},"type":"object","required":["object"]},"aws-native:customerprofiles:IntegrationScheduledTriggerProperties":{"properties":{"dataPullMode":{"$ref":"#/types/aws-native:customerprofiles:IntegrationScheduledTriggerPropertiesDataPullMode","description":"Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run."},"firstExecutionFrom":{"type":"number","description":"Specifies the date range for the records to import from the connector in the first flow run."},"scheduleEndTime":{"type":"number","description":"Specifies the scheduled end time for a scheduled-trigger flow."},"scheduleExpression":{"type":"string","description":"The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes)."},"scheduleOffset":{"type":"integer","description":"Specifies the optional offset that is added to the time interval for a schedule-triggered flow."},"scheduleStartTime":{"type":"number","description":"Specifies the scheduled start time for a scheduled-trigger flow. The value must be a date/time value in EPOCH format."},"timezone":{"type":"string","description":"Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York."}},"type":"object","required":["scheduleExpression"]},"aws-native:customerprofiles:IntegrationScheduledTriggerPropertiesDataPullMode":{"description":"Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.","type":"string","enum":[{"name":"Incremental","value":"Incremental"},{"name":"Complete","value":"Complete"}]},"aws-native:customerprofiles:IntegrationScope":{"description":"Scope of the integration, such as 'PROFILE' or 'DOMAIN'","type":"string","enum":[{"name":"Profile","value":"PROFILE"},{"name":"Domain","value":"DOMAIN"}]},"aws-native:customerprofiles:IntegrationServiceNowConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"LessThan","value":"LESS_THAN"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Contains","value":"CONTAINS"},{"name":"Between","value":"BETWEEN"},{"name":"LessThanOrEqualTo","value":"LESS_THAN_OR_EQUAL_TO"},{"name":"GreaterThanOrEqualTo","value":"GREATER_THAN_OR_EQUAL_TO"},{"name":"EqualTo","value":"EQUAL_TO"},{"name":"NotEqualTo","value":"NOT_EQUAL_TO"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:customerprofiles:IntegrationServiceNowSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the ServiceNow flow source."}},"type":"object","required":["object"]},"aws-native:customerprofiles:IntegrationSourceConnectorProperties":{"properties":{"marketo":{"$ref":"#/types/aws-native:customerprofiles:IntegrationMarketoSourceProperties","description":"The properties that are applied when Marketo is being used as a source."},"s3":{"$ref":"#/types/aws-native:customerprofiles:IntegrationS3SourceProperties","description":"The properties that are applied when Amazon S3 is being used as the flow source."},"salesforce":{"$ref":"#/types/aws-native:customerprofiles:IntegrationSalesforceSourceProperties","description":"The properties that are applied when Salesforce is being used as a source."},"serviceNow":{"$ref":"#/types/aws-native:customerprofiles:IntegrationServiceNowSourceProperties","description":"The properties that are applied when ServiceNow is being used as a source."},"zendesk":{"$ref":"#/types/aws-native:customerprofiles:IntegrationZendeskSourceProperties","description":"The properties that are applied when using Zendesk as a flow source."}},"type":"object"},"aws-native:customerprofiles:IntegrationSourceFlowConfig":{"properties":{"connectorProfileName":{"type":"string","description":"The name of the Amazon AppFlow connector profile. This name must be unique for each connector profile in the AWS account ."},"connectorType":{"$ref":"#/types/aws-native:customerprofiles:IntegrationConnectorType","description":"The type of connector, such as Salesforce, Marketo, and so on."},"incrementalPullConfig":{"$ref":"#/types/aws-native:customerprofiles:IntegrationIncrementalPullConfig","description":"Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull."},"sourceConnectorProperties":{"$ref":"#/types/aws-native:customerprofiles:IntegrationSourceConnectorProperties","description":"Specifies the information that is required to query a particular source connector."}},"type":"object","required":["connectorType","sourceConnectorProperties"]},"aws-native:customerprofiles:IntegrationTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:customerprofiles:IntegrationTask":{"properties":{"connectorOperator":{"$ref":"#/types/aws-native:customerprofiles:IntegrationConnectorOperator","description":"The operation to be performed on the provided source fields."},"destinationField":{"type":"string","description":"A field in a destination connector, or a field value against which Amazon AppFlow validates a source field."},"sourceFields":{"type":"array","items":{"type":"string"},"description":"The source fields to which a particular task is applied."},"taskProperties":{"type":"array","items":{"$ref":"#/types/aws-native:customerprofiles:IntegrationTaskPropertiesMap"},"description":"A map used to store task-related information. The service looks for particular information based on the TaskType."},"taskType":{"$ref":"#/types/aws-native:customerprofiles:IntegrationTaskType","description":"Specifies the particular task implementation that Amazon AppFlow performs."}},"type":"object","required":["sourceFields","taskType"]},"aws-native:customerprofiles:IntegrationTaskPropertiesMap":{"properties":{"operatorPropertyKey":{"$ref":"#/types/aws-native:customerprofiles:IntegrationOperatorPropertiesKeys","description":"The task property key."},"property":{"type":"string","description":"The task property value."}},"type":"object","required":["operatorPropertyKey","property"]},"aws-native:customerprofiles:IntegrationTaskType":{"type":"string","enum":[{"name":"Arithmetic","value":"Arithmetic"},{"name":"Filter","value":"Filter"},{"name":"Map","value":"Map"},{"name":"Mask","value":"Mask"},{"name":"Merge","value":"Merge"},{"name":"Truncate","value":"Truncate"},{"name":"Validate","value":"Validate"}]},"aws-native:customerprofiles:IntegrationTriggerConfig":{"properties":{"triggerProperties":{"$ref":"#/types/aws-native:customerprofiles:IntegrationTriggerProperties","description":"Specifies the configuration details of a schedule-triggered flow that you define. Currently, these settings only apply to the Scheduled trigger type."},"triggerType":{"$ref":"#/types/aws-native:customerprofiles:IntegrationTriggerType","description":"Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event."}},"type":"object","required":["triggerType"]},"aws-native:customerprofiles:IntegrationTriggerProperties":{"properties":{"scheduled":{"$ref":"#/types/aws-native:customerprofiles:IntegrationScheduledTriggerProperties","description":"Specifies the configuration details of a schedule-triggered flow that you define."}},"type":"object"},"aws-native:customerprofiles:IntegrationTriggerType":{"type":"string","enum":[{"name":"Scheduled","value":"Scheduled"},{"name":"Event","value":"Event"},{"name":"OnDemand","value":"OnDemand"}]},"aws-native:customerprofiles:IntegrationZendeskConnectorOperator":{"type":"string","enum":[{"name":"Projection","value":"PROJECTION"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"Addition","value":"ADDITION"},{"name":"Multiplication","value":"MULTIPLICATION"},{"name":"Division","value":"DIVISION"},{"name":"Subtraction","value":"SUBTRACTION"},{"name":"MaskAll","value":"MASK_ALL"},{"name":"MaskFirstN","value":"MASK_FIRST_N"},{"name":"MaskLastN","value":"MASK_LAST_N"},{"name":"ValidateNonNull","value":"VALIDATE_NON_NULL"},{"name":"ValidateNonZero","value":"VALIDATE_NON_ZERO"},{"name":"ValidateNonNegative","value":"VALIDATE_NON_NEGATIVE"},{"name":"ValidateNumeric","value":"VALIDATE_NUMERIC"},{"name":"NoOp","value":"NO_OP"}]},"aws-native:customerprofiles:IntegrationZendeskSourceProperties":{"properties":{"object":{"type":"string","description":"The object specified in the Zendesk flow source."}},"type":"object","required":["object"]},"aws-native:customerprofiles:ObjectTypeField":{"description":"Represents a field in a ProfileObjectType.","properties":{"contentType":{"$ref":"#/types/aws-native:customerprofiles:ObjectTypeFieldContentType","description":"The content type of the field. Used for determining equality when searching."},"source":{"type":"string","description":"A field of a ProfileObject. For example: _source.FirstName, where \"_source\" is a ProfileObjectType of a Zendesk user and \"FirstName\" is a field in that ObjectType."},"target":{"type":"string","description":"The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode."}},"type":"object"},"aws-native:customerprofiles:ObjectTypeFieldContentType":{"description":"The content type of the field. Used for determining equality when searching.","type":"string","enum":[{"name":"String","value":"STRING"},{"name":"Number","value":"NUMBER"},{"name":"PhoneNumber","value":"PHONE_NUMBER"},{"name":"EmailAddress","value":"EMAIL_ADDRESS"},{"name":"Name","value":"NAME"}]},"aws-native:customerprofiles:ObjectTypeFieldMap":{"properties":{"name":{"type":"string","description":"Name of the field."},"objectTypeField":{"$ref":"#/types/aws-native:customerprofiles:ObjectTypeField","description":"Represents a field in a ProfileObjectType."}},"type":"object"},"aws-native:customerprofiles:ObjectTypeKey":{"description":"An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.","properties":{"fieldNames":{"type":"array","items":{"type":"string"},"description":"The reference for the key name of the fields map. "},"standardIdentifiers":{"type":"array","items":{"$ref":"#/types/aws-native:customerprofiles:ObjectTypeKeyStandardIdentifiersItem"},"description":"The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles."}},"type":"object"},"aws-native:customerprofiles:ObjectTypeKeyMap":{"properties":{"name":{"type":"string","description":"Name of the key."},"objectTypeKeyList":{"type":"array","items":{"$ref":"#/types/aws-native:customerprofiles:ObjectTypeKey"},"description":"A list of ObjectTypeKey."}},"type":"object"},"aws-native:customerprofiles:ObjectTypeKeyStandardIdentifiersItem":{"type":"string","enum":[{"name":"Profile","value":"PROFILE"},{"name":"Unique","value":"UNIQUE"},{"name":"Secondary","value":"SECONDARY"},{"name":"LookupOnly","value":"LOOKUP_ONLY"},{"name":"NewOnly","value":"NEW_ONLY"},{"name":"Asset","value":"ASSET"},{"name":"Case","value":"CASE"},{"name":"Order","value":"ORDER"},{"name":"AirPreference","value":"AIR_PREFERENCE"},{"name":"AirBooking","value":"AIR_BOOKING"},{"name":"AirSegment","value":"AIR_SEGMENT"},{"name":"HotelPreference","value":"HOTEL_PREFERENCE"},{"name":"HotelStayRevenue","value":"HOTEL_STAY_REVENUE"},{"name":"HotelReservation","value":"HOTEL_RESERVATION"},{"name":"Loyalty","value":"LOYALTY"},{"name":"LoyaltyTransaction","value":"LOYALTY_TRANSACTION"},{"name":"LoyaltyPromotion","value":"LOYALTY_PROMOTION"},{"name":"WebAnalytics","value":"WEB_ANALYTICS"},{"name":"Device","value":"DEVICE"}]},"aws-native:customerprofiles:ObjectTypeTag":{"properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:customerprofiles:SegmentDefinitionAddressDimension":{"description":"The address based criteria for the segment.","properties":{"city":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"country":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"county":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"postalCode":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"province":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"state":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"}},"type":"object"},"aws-native:customerprofiles:SegmentDefinitionAttributeDimension":{"description":"Specifies attribute based criteria for a segment.","properties":{"dimensionType":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionAttributeDimensionType"},"values":{"type":"array","items":{"type":"string"}}},"type":"object","required":["dimensionType","values"]},"aws-native:customerprofiles:SegmentDefinitionAttributeDimensionType":{"description":"The type of segment dimension to use.","type":"string","enum":[{"name":"Inclusive","value":"INCLUSIVE"},{"name":"Exclusive","value":"EXCLUSIVE"},{"name":"Contains","value":"CONTAINS"},{"name":"BeginsWith","value":"BEGINS_WITH"},{"name":"EndsWith","value":"ENDS_WITH"},{"name":"Before","value":"BEFORE"},{"name":"After","value":"AFTER"},{"name":"Between","value":"BETWEEN"},{"name":"NotBetween","value":"NOT_BETWEEN"},{"name":"On","value":"ON"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"LessThan","value":"LESS_THAN"},{"name":"GreaterThanOrEqual","value":"GREATER_THAN_OR_EQUAL"},{"name":"LessThanOrEqual","value":"LESS_THAN_OR_EQUAL"},{"name":"Equal","value":"EQUAL"}]},"aws-native:customerprofiles:SegmentDefinitionCalculatedAttributeDimension":{"description":"Specifies calculated attribute based criteria for a segment.","properties":{"conditionOverrides":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionConditionOverrides"},"dimensionType":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionAttributeDimensionType"},"values":{"type":"array","items":{"type":"string"}}},"type":"object","required":["dimensionType","values"]},"aws-native:customerprofiles:SegmentDefinitionConditionOverrides":{"description":"Overrides the condition block within the original calculated attribute definition.","properties":{"range":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionRangeOverride"}},"type":"object"},"aws-native:customerprofiles:SegmentDefinitionDateDimension":{"description":"Specifies date based criteria for a segment.","properties":{"dimensionType":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionDateDimensionType"},"values":{"type":"array","items":{"type":"string"}}},"type":"object","required":["dimensionType","values"]},"aws-native:customerprofiles:SegmentDefinitionDateDimensionType":{"description":"The type of segment dimension to use for a date dimension.","type":"string","enum":[{"name":"Before","value":"BEFORE"},{"name":"After","value":"AFTER"},{"name":"Between","value":"BETWEEN"},{"name":"NotBetween","value":"NOT_BETWEEN"},{"name":"On","value":"ON"}]},"aws-native:customerprofiles:SegmentDefinitionDimension0Properties":{"description":"The criteria that define the dimensions for the segment.","properties":{"profileAttributes":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileAttributes"}},"type":"object","required":["profileAttributes"]},"aws-native:customerprofiles:SegmentDefinitionDimension1Properties":{"description":"The criteria that define the dimensions for the segment.","properties":{"calculatedAttributes":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionCalculatedAttributeDimension"}}},"type":"object"},"aws-native:customerprofiles:SegmentDefinitionExtraLengthValueProfileDimension":{"description":"Specifies criteria for a segment using extended-length string values.","properties":{"dimensionType":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionStringDimensionType"},"values":{"type":"array","items":{"type":"string"}}},"type":"object","required":["dimensionType","values"]},"aws-native:customerprofiles:SegmentDefinitionGroup":{"description":"An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.","properties":{"dimensions":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionDimension0Properties"},{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionDimension1Properties"}]},"description":"Defines the attributes to segment on."},"sourceSegments":{"type":"array","items":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionSourceSegment"},"description":"Defines the starting source of data."},"sourceType":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionIncludeOptions","description":"Defines how to interact with the source data."},"type":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionIncludeOptions","description":"Defines how to interact with the profiles found in the current filtering."}},"type":"object"},"aws-native:customerprofiles:SegmentDefinitionIncludeOptions":{"description":"Specifies the operator on how to handle multiple groups within the same segment.","type":"string","enum":[{"name":"All","value":"ALL"},{"name":"Any","value":"ANY"},{"name":"None","value":"NONE"}]},"aws-native:customerprofiles:SegmentDefinitionProfileAttributes":{"description":"Specifies the dimension settings within profile attributes for a segment.","properties":{"accountNumber":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"additionalInformation":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionExtraLengthValueProfileDimension"},"address":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionAddressDimension"},"attributes":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionAttributeDimension"}},"billingAddress":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionAddressDimension"},"birthDate":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionDateDimension"},"businessEmailAddress":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"businessName":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"businessPhoneNumber":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"emailAddress":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"firstName":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"genderString":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"homePhoneNumber":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"lastName":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"mailingAddress":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionAddressDimension"},"middleName":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"mobilePhoneNumber":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"partyTypeString":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"personalEmailAddress":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"phoneNumber":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileDimension"},"profileType":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileTypeDimension"},"shippingAddress":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionAddressDimension"}},"type":"object"},"aws-native:customerprofiles:SegmentDefinitionProfileDimension":{"description":"Specifies profile based criteria for a segment.","properties":{"dimensionType":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionStringDimensionType"},"values":{"type":"array","items":{"type":"string"}}},"type":"object","required":["dimensionType","values"]},"aws-native:customerprofiles:SegmentDefinitionProfileType":{"description":"The type of profile.","type":"string","enum":[{"name":"AccountProfile","value":"ACCOUNT_PROFILE"},{"name":"Profile","value":"PROFILE"}]},"aws-native:customerprofiles:SegmentDefinitionProfileTypeDimension":{"description":"Specifies profile type based criteria for a segment.","properties":{"dimensionType":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileTypeDimensionType"},"values":{"type":"array","items":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionProfileType"}}},"type":"object","required":["dimensionType","values"]},"aws-native:customerprofiles:SegmentDefinitionProfileTypeDimensionType":{"description":"The type of segment dimension to use for a profile type dimension.","type":"string","enum":[{"name":"Inclusive","value":"INCLUSIVE"},{"name":"Exclusive","value":"EXCLUSIVE"}]},"aws-native:customerprofiles:SegmentDefinitionRangeOverride":{"description":"Defines the range to be applied to the calculated attribute definition.","properties":{"end":{"type":"integer","description":"The ending point for this overridden range. Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future."},"start":{"type":"integer","description":"The starting point for this overridden range. Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future."},"unit":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionRangeOverrideUnit","description":"The unit to be applied to the range."}},"type":"object","required":["start","unit"]},"aws-native:customerprofiles:SegmentDefinitionRangeOverrideUnit":{"description":"The unit to be applied to the range.","type":"string","enum":[{"name":"Days","value":"DAYS"}]},"aws-native:customerprofiles:SegmentDefinitionSegmentGroup":{"properties":{"groups":{"type":"array","items":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionGroup"},"description":"Holds the list of groups within the segment definition."},"include":{"$ref":"#/types/aws-native:customerprofiles:SegmentDefinitionIncludeOptions","description":"Defines whether to include or exclude the profiles that fit the segment criteria."}},"type":"object"},"aws-native:customerprofiles:SegmentDefinitionSegmentType":{"description":"The SQL query that defines the segment criteria.","type":"string","enum":[{"name":"Classic","value":"CLASSIC"},{"name":"Enhanced","value":"ENHANCED"}]},"aws-native:customerprofiles:SegmentDefinitionSourceSegment":{"description":"The base segment to build the segment on.","properties":{"segmentDefinitionName":{"type":"string","description":"The name of the source segment."}},"type":"object"},"aws-native:customerprofiles:SegmentDefinitionStringDimensionType":{"description":"The type of segment dimension to use for a string dimension.","type":"string","enum":[{"name":"Inclusive","value":"INCLUSIVE"},{"name":"Exclusive","value":"EXCLUSIVE"},{"name":"Contains","value":"CONTAINS"},{"name":"BeginsWith","value":"BEGINS_WITH"},{"name":"EndsWith","value":"ENDS_WITH"}]},"aws-native:customerprofiles:SegmentDefinitionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:databrew:DatasetCsvOptions":{"description":"Csv options","properties":{"delimiter":{"type":"string","description":"A single character that specifies the delimiter being used in the CSV file."},"headerRow":{"type":"boolean","description":"A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated."}},"type":"object"},"aws-native:databrew:DatasetDataCatalogInputDefinition":{"properties":{"catalogId":{"type":"string","description":"Catalog id"},"databaseName":{"type":"string","description":"Database name"},"tableName":{"type":"string","description":"Table name"},"tempDirectory":{"$ref":"#/types/aws-native:databrew:DatasetS3Location","description":"An Amazon location that AWS Glue Data Catalog can use as a temporary directory."}},"type":"object"},"aws-native:databrew:DatasetDatabaseInputDefinition":{"properties":{"databaseTableName":{"type":"string","description":"Database table name"},"glueConnectionName":{"type":"string","description":"Glue connection name"},"queryString":{"type":"string","description":"Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs."},"tempDirectory":{"$ref":"#/types/aws-native:databrew:DatasetS3Location","description":"An Amazon location that AWS Glue Data Catalog can use as a temporary directory."}},"type":"object","required":["glueConnectionName"]},"aws-native:databrew:DatasetDatetimeOptions":{"properties":{"format":{"type":"string","description":"Date/time format of a date parameter"},"localeCode":{"type":"string","description":"Locale code for a date parameter"},"timezoneOffset":{"type":"string","description":"Timezone offset"}},"type":"object","required":["format"]},"aws-native:databrew:DatasetExcelOptions":{"properties":{"headerRow":{"type":"boolean","description":"A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated."},"sheetIndexes":{"type":"array","items":{"type":"integer"},"description":"One or more sheet numbers in the Excel file that will be included in the dataset."},"sheetNames":{"type":"array","items":{"type":"string"},"description":"One or more named sheets in the Excel file that will be included in the dataset."}},"type":"object"},"aws-native:databrew:DatasetFilesLimit":{"properties":{"maxFiles":{"type":"integer","description":"Maximum number of files"},"order":{"$ref":"#/types/aws-native:databrew:DatasetFilesLimitOrder","description":"Order"},"orderedBy":{"$ref":"#/types/aws-native:databrew:DatasetFilesLimitOrderedBy","description":"Ordered by"}},"type":"object","required":["maxFiles"]},"aws-native:databrew:DatasetFilesLimitOrder":{"description":"Order","type":"string","enum":[{"name":"Ascending","value":"ASCENDING"},{"name":"Descending","value":"DESCENDING"}]},"aws-native:databrew:DatasetFilesLimitOrderedBy":{"description":"Ordered by","type":"string","enum":[{"name":"LastModifiedDate","value":"LAST_MODIFIED_DATE"}]},"aws-native:databrew:DatasetFilterExpression":{"properties":{"expression":{"type":"string","description":"Filtering expression for a parameter"},"valuesMap":{"type":"array","items":{"$ref":"#/types/aws-native:databrew:DatasetFilterValue"},"description":"The map of substitution variable names to their values used in this filter expression."}},"type":"object","required":["expression","valuesMap"]},"aws-native:databrew:DatasetFilterValue":{"description":"A key-value pair to associate expression variable names with their values","properties":{"value":{"type":"string","description":"The value to be associated with the substitution variable."},"valueReference":{"type":"string","description":"Variable name"}},"type":"object","required":["value","valueReference"]},"aws-native:databrew:DatasetFormat":{"description":"Dataset format","type":"string","enum":[{"name":"Csv","value":"CSV"},{"name":"Json","value":"JSON"},{"name":"Parquet","value":"PARQUET"},{"name":"Excel","value":"EXCEL"},{"name":"Orc","value":"ORC"}]},"aws-native:databrew:DatasetFormatOptions":{"description":"Format options for dataset","properties":{"csv":{"$ref":"#/types/aws-native:databrew:DatasetCsvOptions","description":"Options that define how CSV input is to be interpreted by DataBrew."},"excel":{"$ref":"#/types/aws-native:databrew:DatasetExcelOptions","description":"Options that define how Excel input is to be interpreted by DataBrew."},"json":{"$ref":"#/types/aws-native:databrew:DatasetJsonOptions","description":"Options that define how JSON input is to be interpreted by DataBrew."}},"type":"object"},"aws-native:databrew:DatasetInput":{"description":"Input","properties":{"dataCatalogInputDefinition":{"$ref":"#/types/aws-native:databrew:DatasetDataCatalogInputDefinition","description":"The AWS Glue Data Catalog parameters for the data."},"databaseInputDefinition":{"$ref":"#/types/aws-native:databrew:DatasetDatabaseInputDefinition","description":"Connection information for dataset input files stored in a database."},"metadata":{"$ref":"#/types/aws-native:databrew:DatasetMetadata","description":"Contains additional resource information needed for specific datasets."},"s3InputDefinition":{"$ref":"#/types/aws-native:databrew:DatasetS3Location","description":"The Amazon S3 location where the data is stored."}},"type":"object"},"aws-native:databrew:DatasetJsonOptions":{"description":"Json options","properties":{"multiLine":{"type":"boolean","description":"A value that specifies whether JSON input contains embedded new line characters."}},"type":"object"},"aws-native:databrew:DatasetMetadata":{"properties":{"sourceArn":{"type":"string","description":"Arn of the source of the dataset. For e.g.: AppFlow Flow ARN."}},"type":"object"},"aws-native:databrew:DatasetParameter":{"properties":{"createColumn":{"type":"boolean","description":"Add the value of this parameter as a column in a dataset."},"datetimeOptions":{"$ref":"#/types/aws-native:databrew:DatasetDatetimeOptions","description":"Additional parameter options such as a format and a timezone. Required for datetime parameters."},"filter":{"$ref":"#/types/aws-native:databrew:DatasetFilterExpression","description":"The optional filter expression structure to apply additional matching criteria to the parameter."},"name":{"type":"string","description":"The name of the parameter that is used in the dataset's Amazon S3 path."},"type":{"$ref":"#/types/aws-native:databrew:DatasetParameterType","description":"Parameter type"}},"type":"object","required":["name","type"]},"aws-native:databrew:DatasetParameterType":{"description":"Parameter type","type":"string","enum":[{"name":"String","value":"String"},{"name":"Number","value":"Number"},{"name":"Datetime","value":"Datetime"}]},"aws-native:databrew:DatasetPathOptions":{"description":"Path options for dataset","properties":{"filesLimit":{"$ref":"#/types/aws-native:databrew:DatasetFilesLimit","description":"If provided, this structure imposes a limit on a number of files that should be selected."},"lastModifiedDateCondition":{"$ref":"#/types/aws-native:databrew:DatasetFilterExpression","description":"If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 ."},"parameters":{"type":"array","items":{"$ref":"#/types/aws-native:databrew:DatasetPathParameter"},"description":"A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions."}},"type":"object"},"aws-native:databrew:DatasetPathParameter":{"description":"A key-value pair to associate dataset parameter name with its definition.","properties":{"datasetParameter":{"$ref":"#/types/aws-native:databrew:DatasetParameter","description":"The path parameter definition."},"pathParameterName":{"type":"string","description":"The name of the path parameter."}},"type":"object","required":["datasetParameter","pathParameterName"]},"aws-native:databrew:DatasetS3Location":{"description":"Input location","properties":{"bucket":{"type":"string","description":"The Amazon S3 bucket name."},"bucketOwner":{"type":"string","description":"The AWS account ID of the bucket owner."},"key":{"type":"string","description":"The unique name of the object in the bucket."}},"type":"object","required":["bucket"]},"aws-native:databrew:DatasetSource":{"description":"Source type of the dataset","type":"string","enum":[{"name":"S3","value":"S3"},{"name":"DataCatalog","value":"DATA-CATALOG"},{"name":"Database","value":"DATABASE"}]},"aws-native:databrew:DatasetTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:databrew:JobAllowedStatistics":{"properties":{"statistics":{"type":"array","items":{"type":"string"},"description":"One or more column statistics to allow for columns that contain detected entities."}},"type":"object","required":["statistics"]},"aws-native:databrew:JobColumnSelector":{"properties":{"name":{"type":"string","description":"The name of a column from a dataset."},"regex":{"type":"string","description":"A regular expression for selecting a column from a dataset."}},"type":"object"},"aws-native:databrew:JobColumnStatisticsConfiguration":{"properties":{"selectors":{"type":"array","items":{"$ref":"#/types/aws-native:databrew:JobColumnSelector"},"description":"List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns."},"statistics":{"$ref":"#/types/aws-native:databrew:JobStatisticsConfiguration","description":"Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations."}},"type":"object","required":["statistics"]},"aws-native:databrew:JobCsvOutputOptions":{"description":"Output Csv options","properties":{"delimiter":{"type":"string","description":"A single character that specifies the delimiter used to create CSV job output."}},"type":"object"},"aws-native:databrew:JobDataCatalogOutput":{"properties":{"catalogId":{"type":"string","description":"The unique identifier of the AWS account that holds the Data Catalog that stores the data."},"databaseName":{"type":"string","description":"The name of a database in the Data Catalog."},"databaseOptions":{"$ref":"#/types/aws-native:databrew:JobDatabaseTableOutputOptions","description":"Represents options that specify how and where DataBrew writes the database output generated by recipe jobs."},"overwrite":{"type":"boolean","description":"A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions."},"s3Options":{"$ref":"#/types/aws-native:databrew:JobS3TableOutputOptions","description":"Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs."},"tableName":{"type":"string","description":"The name of a table in the Data Catalog."}},"type":"object","required":["databaseName","tableName"]},"aws-native:databrew:JobDatabaseOutput":{"properties":{"databaseOptions":{"$ref":"#/types/aws-native:databrew:JobDatabaseTableOutputOptions","description":"Represents options that specify how and where DataBrew writes the database output generated by recipe jobs."},"databaseOutputMode":{"$ref":"#/types/aws-native:databrew:JobDatabaseOutputDatabaseOutputMode","description":"Database table name"},"glueConnectionName":{"type":"string","description":"Glue connection name"}},"type":"object","required":["databaseOptions","glueConnectionName"]},"aws-native:databrew:JobDatabaseOutputDatabaseOutputMode":{"description":"Database table name","type":"string","enum":[{"name":"NewTable","value":"NEW_TABLE"}]},"aws-native:databrew:JobDatabaseTableOutputOptions":{"properties":{"tableName":{"type":"string","description":"A prefix for the name of a table DataBrew will create in the database."},"tempDirectory":{"$ref":"#/types/aws-native:databrew:JobS3Location","description":"Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results."}},"type":"object","required":["tableName"]},"aws-native:databrew:JobEncryptionMode":{"description":"Encryption mode","type":"string","enum":[{"name":"SseKms","value":"SSE-KMS"},{"name":"SseS3","value":"SSE-S3"}]},"aws-native:databrew:JobEntityDetectorConfiguration":{"properties":{"allowedStatistics":{"$ref":"#/types/aws-native:databrew:JobAllowedStatistics","description":"Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities."},"entityTypes":{"type":"array","items":{"type":"string"},"description":"Entity types to detect. Can be any of the following:\n\n- USA_SSN\n- EMAIL\n- USA_ITIN\n- USA_PASSPORT_NUMBER\n- PHONE_NUMBER\n- USA_DRIVING_LICENSE\n- BANK_ACCOUNT\n- CREDIT_CARD\n- IP_ADDRESS\n- MAC_ADDRESS\n- USA_DEA_NUMBER\n- USA_HCPCS_CODE\n- USA_NATIONAL_PROVIDER_IDENTIFIER\n- USA_NATIONAL_DRUG_CODE\n- USA_HEALTH_INSURANCE_CLAIM_NUMBER\n- USA_MEDICARE_BENEFICIARY_IDENTIFIER\n- USA_CPT_CODE\n- PERSON_NAME\n- DATE\n\nThe Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE."}},"type":"object","required":["entityTypes"]},"aws-native:databrew:JobLogSubscription":{"description":"Log subscription","type":"string","enum":[{"name":"Enable","value":"ENABLE"},{"name":"Disable","value":"DISABLE"}]},"aws-native:databrew:JobOutput":{"properties":{"compressionFormat":{"$ref":"#/types/aws-native:databrew:JobOutputCompressionFormat","description":"The compression algorithm used to compress the output text of the job."},"format":{"$ref":"#/types/aws-native:databrew:JobOutputFormat","description":"The data format of the output of the job."},"formatOptions":{"$ref":"#/types/aws-native:databrew:JobOutputFormatOptions","description":"Represents options that define how DataBrew formats job output files."},"location":{"$ref":"#/types/aws-native:databrew:JobS3Location","description":"The location in Amazon S3 where the job writes its output."},"maxOutputFiles":{"type":"integer","description":"The maximum number of files to be generated by the job and written to the output folder."},"overwrite":{"type":"boolean","description":"A value that, if true, means that any data in the location specified for output is overwritten with new output."},"partitionColumns":{"type":"array","items":{"type":"string"},"description":"The names of one or more partition columns for the output of the job."}},"type":"object","required":["location"]},"aws-native:databrew:JobOutputCompressionFormat":{"description":"The compression algorithm used to compress the output text of the job.","type":"string","enum":[{"name":"Gzip","value":"GZIP"},{"name":"Lz4","value":"LZ4"},{"name":"Snappy","value":"SNAPPY"},{"name":"Bzip2","value":"BZIP2"},{"name":"Deflate","value":"DEFLATE"},{"name":"Lzo","value":"LZO"},{"name":"Brotli","value":"BROTLI"},{"name":"Zstd","value":"ZSTD"},{"name":"Zlib","value":"ZLIB"}]},"aws-native:databrew:JobOutputFormat":{"description":"The data format of the output of the job.","type":"string","enum":[{"name":"Csv","value":"CSV"},{"name":"Json","value":"JSON"},{"name":"Parquet","value":"PARQUET"},{"name":"Glueparquet","value":"GLUEPARQUET"},{"name":"Avro","value":"AVRO"},{"name":"Orc","value":"ORC"},{"name":"Xml","value":"XML"},{"name":"Tableauhyper","value":"TABLEAUHYPER"}]},"aws-native:databrew:JobOutputFormatOptions":{"description":"Format options for job Output","properties":{"csv":{"$ref":"#/types/aws-native:databrew:JobCsvOutputOptions","description":"Represents a set of options that define the structure of comma-separated value (CSV) job output."}},"type":"object"},"aws-native:databrew:JobOutputLocation":{"description":"Output location","properties":{"bucket":{"type":"string","description":"The Amazon S3 bucket name."},"bucketOwner":{"type":"string"},"key":{"type":"string","description":"The unique name of the object in the bucket."}},"type":"object","required":["bucket"]},"aws-native:databrew:JobProfileConfiguration":{"properties":{"columnStatisticsConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:databrew:JobColumnStatisticsConfiguration"},"description":"List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations."},"datasetStatisticsConfiguration":{"$ref":"#/types/aws-native:databrew:JobStatisticsConfiguration","description":"Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations."},"entityDetectorConfiguration":{"$ref":"#/types/aws-native:databrew:JobEntityDetectorConfiguration","description":"Configuration of entity detection for a profile job. When undefined, entity detection is disabled."},"profileColumns":{"type":"array","items":{"$ref":"#/types/aws-native:databrew:JobColumnSelector"},"description":"List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns."}},"type":"object"},"aws-native:databrew:JobRecipe":{"properties":{"name":{"type":"string","description":"Recipe name"},"version":{"type":"string","description":"Recipe version"}},"type":"object","required":["name"]},"aws-native:databrew:JobS3Location":{"description":"S3 Output location","properties":{"bucket":{"type":"string","description":"The Amazon S3 bucket name."},"bucketOwner":{"type":"string","description":"The AWS account ID of the bucket owner."},"key":{"type":"string","description":"The unique name of the object in the bucket."}},"type":"object","required":["bucket"]},"aws-native:databrew:JobS3TableOutputOptions":{"properties":{"location":{"$ref":"#/types/aws-native:databrew:JobS3Location","description":"Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job."}},"type":"object","required":["location"]},"aws-native:databrew:JobSample":{"description":"Job Sample","properties":{"mode":{"$ref":"#/types/aws-native:databrew:JobSampleMode","description":"A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:\n\n- FULL_DATASET - The profile job is run on the entire dataset.\n- CUSTOM_ROWS - The profile job is run on the number of rows specified in the `Size` parameter."},"size":{"type":"integer","description":"The `Size` parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.\n\nLong.MAX_VALUE = 9223372036854775807"}},"type":"object"},"aws-native:databrew:JobSampleMode":{"description":"Sample configuration mode for profile jobs.","type":"string","enum":[{"name":"FullDataset","value":"FULL_DATASET"},{"name":"CustomRows","value":"CUSTOM_ROWS"}]},"aws-native:databrew:JobStatisticOverride":{"properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"A map that includes overrides of an evaluation’s parameters."},"statistic":{"type":"string","description":"The name of an evaluation"}},"type":"object","required":["parameters","statistic"]},"aws-native:databrew:JobStatisticsConfiguration":{"properties":{"includedStatistics":{"type":"array","items":{"type":"string"},"description":"List of included evaluations. When the list is undefined, all supported evaluations will be included."},"overrides":{"type":"array","items":{"$ref":"#/types/aws-native:databrew:JobStatisticOverride"},"description":"List of overrides for evaluations."}},"type":"object"},"aws-native:databrew:JobTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:databrew:JobType":{"description":"Job type","type":"string","enum":[{"name":"Profile","value":"PROFILE"},{"name":"Recipe","value":"RECIPE"}]},"aws-native:databrew:JobValidationConfiguration":{"description":"Configuration to attach Rulesets to the job","properties":{"rulesetArn":{"type":"string","description":"Arn of the Ruleset"},"validationMode":{"$ref":"#/types/aws-native:databrew:JobValidationMode","description":"Mode of data quality validation. Default mode is \"CHECK_ALL\" which verifies all rules defined in the selected ruleset."}},"type":"object","required":["rulesetArn"]},"aws-native:databrew:JobValidationMode":{"type":"string","enum":[{"name":"CheckAll","value":"CHECK_ALL"}]},"aws-native:databrew:ProjectSample":{"properties":{"size":{"type":"integer","description":"Sample size"},"type":{"$ref":"#/types/aws-native:databrew:ProjectSampleType","description":"Sample type"}},"type":"object","required":["type"]},"aws-native:databrew:ProjectSampleType":{"description":"Sample type","type":"string","enum":[{"name":"FirstN","value":"FIRST_N"},{"name":"LastN","value":"LAST_N"},{"name":"Random","value":"RANDOM"}]},"aws-native:databrew:ProjectTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:databrew:RecipeAction":{"properties":{"operation":{"type":"string","description":"Step action operation"},"parameters":{"oneOf":[{"$ref":"#/types/aws-native:databrew:RecipeParameters"},{"type":"object","additionalProperties":{"type":"string"}}],"description":"Contextual parameters for the transformation."}},"type":"object","required":["operation"]},"aws-native:databrew:RecipeConditionExpression":{"description":"Condition expressions applied to the step action","properties":{"condition":{"type":"string","description":"Input condition to be applied to the target column"},"targetColumn":{"type":"string","description":"Name of the target column"},"value":{"type":"string","description":"Value of the condition"}},"type":"object","required":["condition","targetColumn"]},"aws-native:databrew:RecipeDataCatalogInputDefinition":{"properties":{"catalogId":{"type":"string","description":"Catalog id"},"databaseName":{"type":"string","description":"Database name"},"tableName":{"type":"string","description":"Table name"},"tempDirectory":{"$ref":"#/types/aws-native:databrew:RecipeS3Location"}},"type":"object"},"aws-native:databrew:RecipeParameters":{"properties":{"aggregateFunction":{"type":"string"},"base":{"type":"string"},"caseStatement":{"type":"string"},"categoryMap":{"type":"string"},"charsToRemove":{"type":"string"},"collapseConsecutiveWhitespace":{"type":"string"},"columnDataType":{"type":"string"},"columnRange":{"type":"string"},"count":{"type":"string"},"customCharacters":{"type":"string"},"customStopWords":{"type":"string"},"customValue":{"type":"string"},"datasetsColumns":{"type":"string"},"dateAddValue":{"type":"string"},"dateTimeFormat":{"type":"string"},"dateTimeParameters":{"type":"string"},"deleteOtherRows":{"type":"string"},"delimiter":{"type":"string"},"endPattern":{"type":"string"},"endPosition":{"type":"string"},"endValue":{"type":"string"},"expandContractions":{"type":"string"},"exponent":{"type":"string"},"falseString":{"type":"string"},"groupByAggFunctionOptions":{"type":"string"},"groupByColumns":{"type":"string"},"hiddenColumns":{"type":"string"},"ignoreCase":{"type":"string"},"includeInSplit":{"type":"string"},"input":{"$ref":"#/types/aws-native:databrew:RecipeParametersInputProperties","description":"Input"},"interval":{"type":"string"},"isText":{"type":"string"},"joinKeys":{"type":"string"},"joinType":{"type":"string"},"leftColumns":{"type":"string"},"limit":{"type":"string"},"lowerBound":{"type":"string"},"mapType":{"type":"string"},"modeType":{"type":"string"},"multiLine":{"type":"boolean"},"numRows":{"type":"string"},"numRowsAfter":{"type":"string"},"numRowsBefore":{"type":"string"},"orderByColumn":{"type":"string"},"orderByColumns":{"type":"string"},"other":{"type":"string"},"pattern":{"type":"string"},"patternOption1":{"type":"string"},"patternOption2":{"type":"string"},"patternOptions":{"type":"string"},"period":{"type":"string"},"position":{"type":"string"},"removeAllPunctuation":{"type":"string"},"removeAllQuotes":{"type":"string"},"removeAllWhitespace":{"type":"string"},"removeCustomCharacters":{"type":"string"},"removeCustomValue":{"type":"string"},"removeLeadingAndTrailingPunctuation":{"type":"string"},"removeLeadingAndTrailingQuotes":{"type":"string"},"removeLeadingAndTrailingWhitespace":{"type":"string"},"removeLetters":{"type":"string"},"removeNumbers":{"type":"string"},"removeSourceColumn":{"type":"string"},"removeSpecialCharacters":{"type":"string"},"rightColumns":{"type":"string"},"sampleSize":{"type":"string"},"sampleType":{"type":"string"},"secondInput":{"type":"string"},"secondaryInputs":{"type":"array","items":{"$ref":"#/types/aws-native:databrew:RecipeSecondaryInput"}},"sheetIndexes":{"type":"array","items":{"type":"integer"}},"sheetNames":{"type":"array","items":{"type":"string"}},"sourceColumn":{"type":"string"},"sourceColumn1":{"type":"string"},"sourceColumn2":{"type":"string"},"sourceColumns":{"type":"string"},"startColumnIndex":{"type":"string"},"startPattern":{"type":"string"},"startPosition":{"type":"string"},"startValue":{"type":"string"},"stemmingMode":{"type":"string"},"stepCount":{"type":"string"},"stepIndex":{"type":"string"},"stopWordsMode":{"type":"string"},"strategy":{"type":"string"},"targetColumn":{"type":"string"},"targetColumnNames":{"type":"string"},"targetDateFormat":{"type":"string"},"targetIndex":{"type":"string"},"timeZone":{"type":"string"},"tokenizerPattern":{"type":"string"},"trueString":{"type":"string"},"udfLang":{"type":"string"},"units":{"type":"string"},"unpivotColumn":{"type":"string"},"upperBound":{"type":"string"},"useNewDataFrame":{"type":"string"},"value":{"type":"string"},"value1":{"type":"string"},"value2":{"type":"string"},"valueColumn":{"type":"string"},"viewFrame":{"type":"string"}},"type":"object"},"aws-native:databrew:RecipeParametersInputProperties":{"description":"Input","properties":{"dataCatalogInputDefinition":{"$ref":"#/types/aws-native:databrew:RecipeDataCatalogInputDefinition"},"s3InputDefinition":{"$ref":"#/types/aws-native:databrew:RecipeS3Location"}},"type":"object"},"aws-native:databrew:RecipeS3Location":{"description":"Input location","properties":{"bucket":{"type":"string"},"key":{"type":"string"}},"type":"object","required":["bucket"]},"aws-native:databrew:RecipeSecondaryInput":{"description":"Secondary input","properties":{"dataCatalogInputDefinition":{"$ref":"#/types/aws-native:databrew:RecipeDataCatalogInputDefinition"},"s3InputDefinition":{"$ref":"#/types/aws-native:databrew:RecipeS3Location"}},"type":"object"},"aws-native:databrew:RecipeStep":{"properties":{"action":{"$ref":"#/types/aws-native:databrew:RecipeAction","description":"The particular action to be performed in the recipe step."},"conditionExpressions":{"type":"array","items":{"$ref":"#/types/aws-native:databrew:RecipeConditionExpression"},"description":"Condition expressions applied to the step action"}},"type":"object","required":["action"]},"aws-native:databrew:RecipeTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:databrew:RulesetColumnSelector":{"description":"Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression","properties":{"name":{"type":"string","description":"The name of a column from a dataset"},"regex":{"type":"string","description":"A regular expression for selecting a column from a dataset"}},"type":"object"},"aws-native:databrew:RulesetRule":{"description":"Data quality rule for a target resource (dataset)","properties":{"checkExpression":{"type":"string","description":"The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, `(:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2)` . Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, `is_between :val1 and :val2` ."},"columnSelectors":{"type":"array","items":{"$ref":"#/types/aws-native:databrew:RulesetColumnSelector"},"description":"List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns."},"disabled":{"type":"boolean","description":"A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false."},"name":{"type":"string","description":"Name of the rule"},"substitutionMap":{"type":"array","items":{"$ref":"#/types/aws-native:databrew:RulesetSubstitutionValue"},"description":"The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, `\":col1\": \"`Column A`\".`"},"threshold":{"$ref":"#/types/aws-native:databrew:RulesetThreshold","description":"The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds."}},"type":"object","required":["checkExpression","name"]},"aws-native:databrew:RulesetSubstitutionValue":{"description":"A key-value pair to associate expression's substitution variable names with their values","properties":{"value":{"type":"string","description":"Value or column name"},"valueReference":{"type":"string","description":"Variable name"}},"type":"object","required":["value","valueReference"]},"aws-native:databrew:RulesetTag":{"description":"A key-value pair to associate with a resource","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:databrew:RulesetThreshold":{"properties":{"type":{"$ref":"#/types/aws-native:databrew:RulesetThresholdType","description":"The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value."},"unit":{"$ref":"#/types/aws-native:databrew:RulesetThresholdUnit","description":"Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation."},"value":{"type":"number","description":"The value of a threshold."}},"type":"object","required":["value"]},"aws-native:databrew:RulesetThresholdType":{"description":"Threshold type for a rule","type":"string","enum":[{"name":"GreaterThanOrEqual","value":"GREATER_THAN_OR_EQUAL"},{"name":"LessThanOrEqual","value":"LESS_THAN_OR_EQUAL"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"LessThan","value":"LESS_THAN"}]},"aws-native:databrew:RulesetThresholdUnit":{"description":"Threshold unit for a rule","type":"string","enum":[{"name":"Count","value":"COUNT"},{"name":"Percentage","value":"PERCENTAGE"}]},"aws-native:databrew:ScheduleTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:datapipeline:PipelineField":{"properties":{"key":{"type":"string","description":"Specifies the name of a field for a particular object. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide."},"refValue":{"type":"string","description":"A field value that you specify as an identifier of another object in the same pipeline definition."},"stringValue":{"type":"string","description":"A field value that you specify as a string. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide."}},"type":"object","required":["key"]},"aws-native:datapipeline:PipelineObject":{"properties":{"fields":{"type":"array","items":{"$ref":"#/types/aws-native:datapipeline:PipelineField"},"description":"Key-value pairs that define the properties of the object."},"id":{"type":"string","description":"The ID of the object."},"name":{"type":"string","description":"The name of the object."}},"type":"object","required":["fields","id","name"]},"aws-native:datapipeline:PipelineParameterAttribute":{"properties":{"key":{"type":"string","description":"The field identifier."},"stringValue":{"type":"string","description":"The field value, expressed as a String."}},"type":"object","required":["key","stringValue"]},"aws-native:datapipeline:PipelineParameterObject":{"properties":{"attributes":{"type":"array","items":{"$ref":"#/types/aws-native:datapipeline:PipelineParameterAttribute"},"description":"The attributes of the parameter object."},"id":{"type":"string","description":"The ID of the parameter object."}},"type":"object","required":["attributes","id"]},"aws-native:datapipeline:PipelineParameterValue":{"properties":{"id":{"type":"string","description":"The ID of the parameter value."},"stringValue":{"type":"string","description":"The field value, expressed as a String."}},"type":"object","required":["id","stringValue"]},"aws-native:datapipeline:PipelineTag":{"properties":{"key":{"type":"string","description":"The key name of a tag."},"value":{"type":"string","description":"The value to associate with the key name."}},"type":"object","required":["key","value"]},"aws-native:datasync:AgentEndpointType":{"description":"The service endpoints that the agent will connect to.","type":"string","enum":[{"name":"Fips","value":"FIPS"},{"name":"Public","value":"PUBLIC"},{"name":"PrivateLink","value":"PRIVATE_LINK"}]},"aws-native:datasync:AgentTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datasync:LocationAzureBlobAzureAccessTier":{"description":"Specifies an access tier for the objects you're transferring into your Azure Blob Storage container.","type":"string","enum":[{"name":"Hot","value":"HOT"},{"name":"Cool","value":"COOL"},{"name":"Archive","value":"ARCHIVE"}]},"aws-native:datasync:LocationAzureBlobAzureBlobAuthenticationType":{"description":"The specific authentication type that you want DataSync to use to access your Azure Blob Container.","type":"string","enum":[{"name":"Sas","value":"SAS"},{"name":"None","value":"NONE"}]},"aws-native:datasync:LocationAzureBlobAzureBlobSasConfiguration":{"description":"Specifies the shared access signature (SAS) that DataSync uses to access your Azure Blob Storage container.","properties":{"azureBlobSasToken":{"type":"string","description":"Specifies the shared access signature (SAS) token, which indicates the permissions DataSync needs to access your Azure Blob Storage container."}},"type":"object","required":["azureBlobSasToken"]},"aws-native:datasync:LocationAzureBlobAzureBlobType":{"description":"Specifies a blob type for the objects you're transferring into your Azure Blob Storage container.","type":"string","enum":[{"name":"Block","value":"BLOCK"}]},"aws-native:datasync:LocationAzureBlobCmkSecretConfig":{"description":"Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.","properties":{"kmsKeyArn":{"type":"string","description":"Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager."},"secretArn":{"type":"string","description":"Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync."}},"type":"object"},"aws-native:datasync:LocationAzureBlobCustomSecretConfig":{"description":"Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.","properties":{"secretAccessRoleArn":{"type":"string","description":"Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn."},"secretArn":{"type":"string","description":"Specifies the ARN for a customer created AWS Secrets Manager secret."}},"type":"object","required":["secretAccessRoleArn","secretArn"]},"aws-native:datasync:LocationAzureBlobManagedSecretConfig":{"description":"Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.","properties":{"secretArn":{"type":"string","description":"Specifies the ARN for an AWS Secrets Manager secret."}},"type":"object","required":["secretArn"]},"aws-native:datasync:LocationAzureBlobTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datasync:LocationEfsEc2Config":{"description":"The subnet and security group that DataSync uses to access target EFS file system.","properties":{"securityGroupArns":{"type":"array","items":{"type":"string"},"description":"The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource."},"subnetArn":{"type":"string","description":"The ARN of the subnet that DataSync uses to access the target EFS file system."}},"type":"object","required":["securityGroupArns","subnetArn"]},"aws-native:datasync:LocationEfsInTransitEncryption":{"description":"Protocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Tls12","value":"TLS1_2"}]},"aws-native:datasync:LocationEfsTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datasync:LocationFSxLustreTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datasync:LocationFSxOntapCmkSecretConfig":{"description":"Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.","properties":{"kmsKeyArn":{"type":"string","description":"Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager."},"secretArn":{"type":"string","description":"Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync."}},"type":"object"},"aws-native:datasync:LocationFSxOntapCustomSecretConfig":{"description":"Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.","properties":{"secretAccessRoleArn":{"type":"string","description":"Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn."},"secretArn":{"type":"string","description":"Specifies the ARN for a customer created AWS Secrets Manager secret."}},"type":"object","required":["secretAccessRoleArn","secretArn"]},"aws-native:datasync:LocationFSxOntapManagedSecretConfig":{"description":"Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.","properties":{"secretArn":{"type":"string","description":"Specifies the ARN for an AWS Secrets Manager secret."}},"type":"object","required":["secretArn"]},"aws-native:datasync:LocationFSxOntapNfs":{"description":"NFS protocol configuration for FSx ONTAP file system.","properties":{"mountOptions":{"$ref":"#/types/aws-native:datasync:LocationFSxOntapNfsMountOptions","description":"Specifies how DataSync can access a location using the NFS protocol."}},"type":"object","required":["mountOptions"]},"aws-native:datasync:LocationFSxOntapNfsMountOptions":{"description":"The NFS mount options that DataSync can use to mount your NFS share.","properties":{"version":{"$ref":"#/types/aws-native:datasync:LocationFSxOntapNfsMountOptionsVersion","description":"The specific NFS version that you want DataSync to use to mount your NFS share."}},"type":"object"},"aws-native:datasync:LocationFSxOntapNfsMountOptionsVersion":{"description":"The specific NFS version that you want DataSync to use to mount your NFS share.","type":"string","enum":[{"name":"Automatic","value":"AUTOMATIC"},{"name":"Nfs3","value":"NFS3"},{"name":"Nfs40","value":"NFS4_0"},{"name":"Nfs41","value":"NFS4_1"}]},"aws-native:datasync:LocationFSxOntapProtocol":{"description":"Configuration settings for NFS or SMB protocol.","properties":{"nfs":{"$ref":"#/types/aws-native:datasync:LocationFSxOntapNfs","description":"Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for ONTAP file system's storage virtual machine (SVM)."},"smb":{"$ref":"#/types/aws-native:datasync:LocationFSxOntapSmb","description":"Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM."}},"type":"object"},"aws-native:datasync:LocationFSxOntapSmb":{"description":"SMB protocol configuration for FSx ONTAP file system.","properties":{"cmkSecretConfig":{"$ref":"#/types/aws-native:datasync:LocationFSxOntapCmkSecretConfig"},"customSecretConfig":{"$ref":"#/types/aws-native:datasync:LocationFSxOntapCustomSecretConfig"},"domain":{"type":"string","description":"The name of the Windows domain that the SMB server belongs to."},"managedSecretConfig":{"$ref":"#/types/aws-native:datasync:LocationFSxOntapManagedSecretConfig"},"mountOptions":{"$ref":"#/types/aws-native:datasync:LocationFSxOntapSmbMountOptions","description":"Specifies how DataSync can access a location using the SMB protocol."},"password":{"type":"string","description":"The password of the user who can mount the share and has the permissions to access files and folders in the SMB share."},"user":{"type":"string","description":"The user who can mount the share, has the permissions to access files and folders in the SMB share."}},"type":"object","required":["mountOptions","user"]},"aws-native:datasync:LocationFSxOntapSmbMountOptions":{"description":"The mount options used by DataSync to access the SMB server.","properties":{"version":{"$ref":"#/types/aws-native:datasync:LocationFSxOntapSmbMountOptionsVersion","description":"The specific SMB version that you want DataSync to use to mount your SMB share."}},"type":"object"},"aws-native:datasync:LocationFSxOntapSmbMountOptionsVersion":{"description":"The specific SMB version that you want DataSync to use to mount your SMB share.","type":"string","enum":[{"name":"Automatic","value":"AUTOMATIC"},{"name":"Smb2","value":"SMB2"},{"name":"Smb3","value":"SMB3"}]},"aws-native:datasync:LocationFSxOntapTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datasync:LocationFSxOpenZfsMountOptions":{"description":"The NFS mount options that DataSync can use to mount your NFS share.","properties":{"version":{"$ref":"#/types/aws-native:datasync:LocationFSxOpenZfsMountOptionsVersion","description":"The specific NFS version that you want DataSync to use to mount your NFS share."}},"type":"object"},"aws-native:datasync:LocationFSxOpenZfsMountOptionsVersion":{"description":"The specific NFS version that you want DataSync to use to mount your NFS share.","type":"string","enum":[{"name":"Automatic","value":"AUTOMATIC"},{"name":"Nfs3","value":"NFS3"},{"name":"Nfs40","value":"NFS4_0"},{"name":"Nfs41","value":"NFS4_1"}]},"aws-native:datasync:LocationFSxOpenZfsNfs":{"description":"FSx OpenZFS file system NFS protocol information","properties":{"mountOptions":{"$ref":"#/types/aws-native:datasync:LocationFSxOpenZfsMountOptions","description":"Represents the mount options that are available for DataSync to access an NFS location."}},"type":"object","required":["mountOptions"]},"aws-native:datasync:LocationFSxOpenZfsProtocol":{"description":"Configuration settings for an NFS or SMB protocol, currently only support NFS","properties":{"nfs":{"$ref":"#/types/aws-native:datasync:LocationFSxOpenZfsNfs","description":"Represents the Network File System (NFS) protocol that DataSync uses to access your FSx for OpenZFS file system."}},"type":"object"},"aws-native:datasync:LocationFSxOpenZfsTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datasync:LocationFSxWindowsCmkSecretConfig":{"description":"Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.","properties":{"kmsKeyArn":{"type":"string","description":"Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager."},"secretArn":{"type":"string","description":"Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync."}},"type":"object"},"aws-native:datasync:LocationFSxWindowsCustomSecretConfig":{"description":"Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.","properties":{"secretAccessRoleArn":{"type":"string","description":"Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn."},"secretArn":{"type":"string","description":"Specifies the ARN for a customer created AWS Secrets Manager secret."}},"type":"object","required":["secretAccessRoleArn","secretArn"]},"aws-native:datasync:LocationFSxWindowsManagedSecretConfig":{"description":"Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.","properties":{"secretArn":{"type":"string","description":"Specifies the ARN for an AWS Secrets Manager secret."}},"type":"object","required":["secretArn"]},"aws-native:datasync:LocationFSxWindowsTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datasync:LocationHdfsAuthenticationType":{"description":"The authentication mode used to determine identity of user.","type":"string","enum":[{"name":"Simple","value":"SIMPLE"},{"name":"Kerberos","value":"KERBEROS"}]},"aws-native:datasync:LocationHdfsCmkSecretConfig":{"description":"Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.","properties":{"kmsKeyArn":{"type":"string","description":"Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager."},"secretArn":{"type":"string","description":"Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync."}},"type":"object"},"aws-native:datasync:LocationHdfsCustomSecretConfig":{"description":"Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.","properties":{"secretAccessRoleArn":{"type":"string","description":"Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn."},"secretArn":{"type":"string","description":"Specifies the ARN for a customer created AWS Secrets Manager secret."}},"type":"object","required":["secretAccessRoleArn","secretArn"]},"aws-native:datasync:LocationHdfsManagedSecretConfig":{"description":"Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.","properties":{"secretArn":{"type":"string","description":"Specifies the ARN for an AWS Secrets Manager secret."}},"type":"object","required":["secretArn"]},"aws-native:datasync:LocationHdfsNameNode":{"description":"HDFS Name Node IP and port information.","properties":{"hostname":{"type":"string","description":"The DNS name or IP address of the Name Node in the customer's on premises HDFS cluster."},"port":{"type":"integer","description":"The port on which the Name Node is listening on for client requests."}},"type":"object","required":["hostname","port"]},"aws-native:datasync:LocationHdfsQopConfiguration":{"description":"Configuration information for RPC Protection and Data Transfer Protection. These parameters can be set to AUTHENTICATION, INTEGRITY, or PRIVACY. The default value is PRIVACY.","properties":{"dataTransferProtection":{"$ref":"#/types/aws-native:datasync:LocationHdfsQopConfigurationDataTransferProtection","description":"Configuration for Data Transfer Protection."},"rpcProtection":{"$ref":"#/types/aws-native:datasync:LocationHdfsQopConfigurationRpcProtection","description":"Configuration for RPC Protection."}},"type":"object"},"aws-native:datasync:LocationHdfsQopConfigurationDataTransferProtection":{"description":"Configuration for Data Transfer Protection.","type":"string","enum":[{"name":"Authentication","value":"AUTHENTICATION"},{"name":"Integrity","value":"INTEGRITY"},{"name":"Privacy","value":"PRIVACY"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:datasync:LocationHdfsQopConfigurationRpcProtection":{"description":"Configuration for RPC Protection.","type":"string","enum":[{"name":"Authentication","value":"AUTHENTICATION"},{"name":"Integrity","value":"INTEGRITY"},{"name":"Privacy","value":"PRIVACY"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:datasync:LocationHdfsTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:datasync:LocationNfsMountOptions":{"description":"The NFS mount options that DataSync can use to mount your NFS share.","properties":{"version":{"$ref":"#/types/aws-native:datasync:LocationNfsMountOptionsVersion","description":"The specific NFS version that you want DataSync to use to mount your NFS share."}},"type":"object"},"aws-native:datasync:LocationNfsMountOptionsVersion":{"description":"The specific NFS version that you want DataSync to use to mount your NFS share.","type":"string","enum":[{"name":"Automatic","value":"AUTOMATIC"},{"name":"Nfs3","value":"NFS3"},{"name":"Nfs40","value":"NFS4_0"},{"name":"Nfs41","value":"NFS4_1"}]},"aws-native:datasync:LocationNfsOnPremConfig":{"description":"Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect an NFS server.","properties":{"agentArns":{"type":"array","items":{"type":"string"},"description":"ARN(s) of the agent(s) to use for an NFS location."}},"type":"object","required":["agentArns"]},"aws-native:datasync:LocationNfsTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datasync:LocationObjectStorageCmkSecretConfig":{"description":"Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.","properties":{"kmsKeyArn":{"type":"string","description":"Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager."},"secretArn":{"type":"string","description":"Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync."}},"type":"object"},"aws-native:datasync:LocationObjectStorageCustomSecretConfig":{"description":"Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.","properties":{"secretAccessRoleArn":{"type":"string","description":"Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn."},"secretArn":{"type":"string","description":"Specifies the ARN for a customer created AWS Secrets Manager secret."}},"type":"object","required":["secretAccessRoleArn","secretArn"]},"aws-native:datasync:LocationObjectStorageManagedSecretConfig":{"description":"Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.","properties":{"secretArn":{"type":"string","description":"Specifies the ARN for an AWS Secrets Manager secret."}},"type":"object","required":["secretArn"]},"aws-native:datasync:LocationObjectStorageServerProtocol":{"description":"The protocol that the object storage server uses to communicate.","type":"string","enum":[{"name":"Https","value":"HTTPS"},{"name":"Http","value":"HTTP"}]},"aws-native:datasync:LocationObjectStorageTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datasync:LocationS3S3StorageClass":{"description":"The Amazon S3 storage class you want to store your files in when this location is used as a task destination.","type":"string","enum":[{"name":"Standard","value":"STANDARD"},{"name":"StandardIa","value":"STANDARD_IA"},{"name":"OnezoneIa","value":"ONEZONE_IA"},{"name":"IntelligentTiering","value":"INTELLIGENT_TIERING"},{"name":"Glacier","value":"GLACIER"},{"name":"GlacierInstantRetrieval","value":"GLACIER_INSTANT_RETRIEVAL"},{"name":"DeepArchive","value":"DEEP_ARCHIVE"}]},"aws-native:datasync:LocationS3Tag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datasync:LocationS3s3Config":{"description":"The Amazon Resource Name (ARN) of the AWS IAM role that is used to access an Amazon S3 bucket.","properties":{"bucketAccessRoleArn":{"type":"string","description":"The ARN of the IAM role of the Amazon S3 bucket."}},"type":"object","required":["bucketAccessRoleArn"]},"aws-native:datasync:LocationSmbAuthenticationType":{"description":"The authentication mode used to determine identity of user.","type":"string","enum":[{"name":"Ntlm","value":"NTLM"},{"name":"Kerberos","value":"KERBEROS"}]},"aws-native:datasync:LocationSmbCmkSecretConfig":{"description":"Specifies configuration information for a DataSync-managed secret, such as a password or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.","properties":{"kmsKeyArn":{"type":"string","description":"Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager."},"secretArn":{"type":"string","description":"Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync."}},"type":"object"},"aws-native:datasync:LocationSmbCustomSecretConfig":{"description":"Specifies configuration information for a customer-managed secret, such as a password or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.","properties":{"secretAccessRoleArn":{"type":"string","description":"Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn."},"secretArn":{"type":"string","description":"Specifies the ARN for a customer created AWS Secrets Manager secret."}},"type":"object","required":["secretAccessRoleArn","secretArn"]},"aws-native:datasync:LocationSmbManagedSecretConfig":{"description":"Specifies configuration information for a DataSync-managed secret, such as a password or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.","properties":{"secretArn":{"type":"string","description":"Specifies the ARN for an AWS Secrets Manager secret."}},"type":"object","required":["secretArn"]},"aws-native:datasync:LocationSmbMountOptions":{"description":"The mount options used by DataSync to access the SMB server.","properties":{"version":{"$ref":"#/types/aws-native:datasync:LocationSmbMountOptionsVersion","description":"The specific SMB version that you want DataSync to use to mount your SMB share."}},"type":"object"},"aws-native:datasync:LocationSmbMountOptionsVersion":{"description":"The specific SMB version that you want DataSync to use to mount your SMB share.","type":"string","enum":[{"name":"Automatic","value":"AUTOMATIC"},{"name":"Smb1","value":"SMB1"},{"name":"Smb20","value":"SMB2_0"},{"name":"Smb2","value":"SMB2"},{"name":"Smb3","value":"SMB3"}]},"aws-native:datasync:LocationSmbTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datasync:StorageSystemConnectivityStatus":{"description":"Indicates whether the DataSync agent can access the on-premises storage system.","type":"string","enum":[{"name":"Pass","value":"PASS"},{"name":"Fail","value":"FAIL"},{"name":"Unknown","value":"UNKNOWN"}]},"aws-native:datasync:StorageSystemServerConfiguration":{"description":"The server name and network port required to connect with the management interface of the on-premises storage system.","properties":{"serverHostname":{"type":"string","description":"The domain name or IP address of the storage system's management interface."},"serverPort":{"type":"integer","description":"The network port needed to access the system's management interface"}},"type":"object","required":["serverHostname"]},"aws-native:datasync:StorageSystemServerCredentials":{"description":"The username and password for accessing your on-premises storage system's management interface.","properties":{"password":{"type":"string","description":"The password for your storage system's management interface"},"username":{"type":"string","description":"The username for your storage system's management interface."}},"type":"object","required":["password","username"]},"aws-native:datasync:StorageSystemSystemType":{"description":"The type of on-premises storage system that DataSync Discovery will analyze.","type":"string","enum":[{"name":"NetAppOntap","value":"NetAppONTAP"}]},"aws-native:datasync:StorageSystemTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datasync:TaskFilterRule":{"description":"Specifies which files folders and objects to include or exclude when transferring files from source to destination.","properties":{"filterType":{"$ref":"#/types/aws-native:datasync:TaskFilterRuleFilterType","description":"The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type."},"value":{"type":"string","description":"A single filter string that consists of the patterns to include or exclude. The patterns are delimited by \"|\"."}},"type":"object"},"aws-native:datasync:TaskFilterRuleFilterType":{"description":"The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.","type":"string","enum":[{"name":"SimplePattern","value":"SIMPLE_PATTERN"}]},"aws-native:datasync:TaskManifestConfig":{"description":"Configures a manifest, which is a list of files or objects that you want DataSync to transfer.","properties":{"action":{"$ref":"#/types/aws-native:datasync:TaskManifestConfigAction","description":"Specifies what DataSync uses the manifest for."},"format":{"$ref":"#/types/aws-native:datasync:TaskManifestConfigFormat","description":"Specifies the file format of your manifest."},"source":{"$ref":"#/types/aws-native:datasync:TaskManifestConfigSourceProperties","description":"Specifies the manifest that you want DataSync to use and where it's hosted."}},"type":"object","required":["source"]},"aws-native:datasync:TaskManifestConfigAction":{"description":"Specifies what DataSync uses the manifest for.","type":"string","enum":[{"name":"Transfer","value":"TRANSFER"}]},"aws-native:datasync:TaskManifestConfigFormat":{"description":"Specifies the file format of your manifest.","type":"string","enum":[{"name":"Csv","value":"CSV"}]},"aws-native:datasync:TaskManifestConfigSourceProperties":{"description":"Specifies the manifest that you want DataSync to use and where it's hosted.","properties":{"s3":{"$ref":"#/types/aws-native:datasync:TaskManifestConfigSourceS3"}},"type":"object"},"aws-native:datasync:TaskManifestConfigSourceS3":{"description":"Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.","properties":{"bucketAccessRoleArn":{"type":"string","description":"Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest."},"manifestObjectPath":{"type":"string","description":"Specifies the Amazon S3 object key of your manifest."},"manifestObjectVersionId":{"type":"string","description":"Specifies the object version ID of the manifest that you want DataSync to use."},"s3BucketArn":{"type":"string","description":"Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest."}},"type":"object"},"aws-native:datasync:TaskMode":{"description":"Specifies the task mode for the task.","type":"string","enum":[{"name":"Basic","value":"BASIC"},{"name":"Enhanced","value":"ENHANCED"}]},"aws-native:datasync:TaskOptions":{"description":"Represents the options that are available to control the behavior of a StartTaskExecution operation.","properties":{"atime":{"$ref":"#/types/aws-native:datasync:TaskOptionsAtime","description":"A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to)."},"bytesPerSecond":{"type":"integer","description":"A value that limits the bandwidth used by AWS DataSync."},"gid":{"$ref":"#/types/aws-native:datasync:TaskOptionsGid","description":"The group ID (GID) of the file's owners."},"logLevel":{"$ref":"#/types/aws-native:datasync:TaskOptionsLogLevel","description":"A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide."},"mtime":{"$ref":"#/types/aws-native:datasync:TaskOptionsMtime","description":"A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase."},"objectTags":{"$ref":"#/types/aws-native:datasync:TaskOptionsObjectTags","description":"A value that determines whether object tags should be read from the source object store and written to the destination object store."},"overwriteMode":{"$ref":"#/types/aws-native:datasync:TaskOptionsOverwriteMode","description":"A value that determines whether files at the destination should be overwritten or preserved when copying files."},"posixPermissions":{"$ref":"#/types/aws-native:datasync:TaskOptionsPosixPermissions","description":"A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file."},"preserveDeletedFiles":{"$ref":"#/types/aws-native:datasync:TaskOptionsPreserveDeletedFiles","description":"A value that specifies whether files in the destination that don't exist in the source file system should be preserved."},"preserveDevices":{"$ref":"#/types/aws-native:datasync:TaskOptionsPreserveDevices","description":"A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination."},"securityDescriptorCopyFlags":{"$ref":"#/types/aws-native:datasync:TaskOptionsSecurityDescriptorCopyFlags","description":"A value that determines which components of the SMB security descriptor are copied during transfer."},"taskQueueing":{"$ref":"#/types/aws-native:datasync:TaskOptionsTaskQueueing","description":"A value that determines whether tasks should be queued before executing the tasks."},"transferMode":{"$ref":"#/types/aws-native:datasync:TaskOptionsTransferMode","description":"A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location."},"uid":{"$ref":"#/types/aws-native:datasync:TaskOptionsUid","description":"The user ID (UID) of the file's owner."},"verifyMode":{"$ref":"#/types/aws-native:datasync:TaskOptionsVerifyMode","description":"A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred."}},"type":"object"},"aws-native:datasync:TaskOptionsAtime":{"description":"A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"BestEffort","value":"BEST_EFFORT"}]},"aws-native:datasync:TaskOptionsGid":{"description":"The group ID (GID) of the file's owners.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"IntValue","value":"INT_VALUE"},{"name":"Name","value":"NAME"},{"name":"Both","value":"BOTH"}]},"aws-native:datasync:TaskOptionsLogLevel":{"description":"A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.","type":"string","enum":[{"name":"Off","value":"OFF"},{"name":"Basic","value":"BASIC"},{"name":"Transfer","value":"TRANSFER"}]},"aws-native:datasync:TaskOptionsMtime":{"description":"A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Preserve","value":"PRESERVE"}]},"aws-native:datasync:TaskOptionsObjectTags":{"description":"A value that determines whether object tags should be read from the source object store and written to the destination object store.","type":"string","enum":[{"name":"Preserve","value":"PRESERVE"},{"name":"None","value":"NONE"}]},"aws-native:datasync:TaskOptionsOverwriteMode":{"description":"A value that determines whether files at the destination should be overwritten or preserved when copying files.","type":"string","enum":[{"name":"Always","value":"ALWAYS"},{"name":"Never","value":"NEVER"}]},"aws-native:datasync:TaskOptionsPosixPermissions":{"description":"A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Preserve","value":"PRESERVE"}]},"aws-native:datasync:TaskOptionsPreserveDeletedFiles":{"description":"A value that specifies whether files in the destination that don't exist in the source file system should be preserved.","type":"string","enum":[{"name":"Preserve","value":"PRESERVE"},{"name":"Remove","value":"REMOVE"}]},"aws-native:datasync:TaskOptionsPreserveDevices":{"description":"A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Preserve","value":"PRESERVE"}]},"aws-native:datasync:TaskOptionsSecurityDescriptorCopyFlags":{"description":"A value that determines which components of the SMB security descriptor are copied during transfer.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"OwnerDacl","value":"OWNER_DACL"},{"name":"OwnerDaclSacl","value":"OWNER_DACL_SACL"}]},"aws-native:datasync:TaskOptionsTaskQueueing":{"description":"A value that determines whether tasks should be queued before executing the tasks.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:datasync:TaskOptionsTransferMode":{"description":"A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.","type":"string","enum":[{"name":"Changed","value":"CHANGED"},{"name":"All","value":"ALL"}]},"aws-native:datasync:TaskOptionsUid":{"description":"The user ID (UID) of the file's owner.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"IntValue","value":"INT_VALUE"},{"name":"Name","value":"NAME"},{"name":"Both","value":"BOTH"}]},"aws-native:datasync:TaskOptionsVerifyMode":{"description":"A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.","type":"string","enum":[{"name":"PointInTimeConsistent","value":"POINT_IN_TIME_CONSISTENT"},{"name":"OnlyFilesTransferred","value":"ONLY_FILES_TRANSFERRED"},{"name":"None","value":"NONE"}]},"aws-native:datasync:TaskReportConfig":{"description":"Specifies how you want to configure a task report, which provides detailed information about for your Datasync transfer.","properties":{"destination":{"$ref":"#/types/aws-native:datasync:TaskReportConfigDestinationProperties","description":"Specifies where DataSync uploads your task report."},"objectVersionIds":{"$ref":"#/types/aws-native:datasync:TaskReportConfigObjectVersionIds","description":"Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket."},"outputType":{"$ref":"#/types/aws-native:datasync:TaskReportConfigOutputType","description":"Specifies the type of task report that you want."},"overrides":{"$ref":"#/types/aws-native:datasync:TaskReportConfigOverridesProperties","description":"Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location."},"reportLevel":{"$ref":"#/types/aws-native:datasync:TaskReportConfigReportLevel","description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't."}},"type":"object","required":["destination","outputType"]},"aws-native:datasync:TaskReportConfigDestinationProperties":{"description":"Specifies where DataSync uploads your task report.","properties":{"s3":{"$ref":"#/types/aws-native:datasync:TaskReportConfigDestinationS3"}},"type":"object"},"aws-native:datasync:TaskReportConfigDestinationS3":{"description":"Specifies the Amazon S3 bucket where DataSync uploads your task report.","properties":{"bucketAccessRoleArn":{"type":"string","description":"Specifies the Amazon Resource Name (ARN) of the IAM policy that allows Datasync to upload a task report to your S3 bucket."},"s3BucketArn":{"type":"string","description":"Specifies the ARN of the S3 bucket where Datasync uploads your report."},"subdirectory":{"type":"string","description":"Specifies a bucket prefix for your report."}},"type":"object"},"aws-native:datasync:TaskReportConfigObjectVersionIds":{"description":"Specifies whether your task report includes the new version of each object transferred into an S3 bucket, this only applies if you enable versioning on your bucket.","type":"string","enum":[{"name":"Include","value":"INCLUDE"},{"name":"None","value":"NONE"}]},"aws-native:datasync:TaskReportConfigOutputType":{"description":"Specifies the type of task report that you want.","type":"string","enum":[{"name":"SummaryOnly","value":"SUMMARY_ONLY"},{"name":"Standard","value":"STANDARD"}]},"aws-native:datasync:TaskReportConfigOverridesProperties":{"description":"Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location.","properties":{"deleted":{"$ref":"#/types/aws-native:datasync:TaskReportConfigOverridesPropertiesDeletedProperties","description":"Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source."},"skipped":{"$ref":"#/types/aws-native:datasync:TaskReportConfigOverridesPropertiesSkippedProperties","description":"Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer."},"transferred":{"$ref":"#/types/aws-native:datasync:TaskReportConfigOverridesPropertiesTransferredProperties","description":"Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer."},"verified":{"$ref":"#/types/aws-native:datasync:TaskReportConfigOverridesPropertiesVerifiedProperties","description":"Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)"}},"type":"object"},"aws-native:datasync:TaskReportConfigOverridesPropertiesDeletedProperties":{"description":"Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.","properties":{"reportLevel":{"$ref":"#/types/aws-native:datasync:TaskReportConfigOverridesPropertiesDeletedPropertiesReportLevel","description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't."}},"type":"object"},"aws-native:datasync:TaskReportConfigOverridesPropertiesDeletedPropertiesReportLevel":{"description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.","type":"string","enum":[{"name":"ErrorsOnly","value":"ERRORS_ONLY"},{"name":"SuccessesAndErrors","value":"SUCCESSES_AND_ERRORS"}]},"aws-native:datasync:TaskReportConfigOverridesPropertiesSkippedProperties":{"description":"Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.","properties":{"reportLevel":{"$ref":"#/types/aws-native:datasync:TaskReportConfigOverridesPropertiesSkippedPropertiesReportLevel","description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't."}},"type":"object"},"aws-native:datasync:TaskReportConfigOverridesPropertiesSkippedPropertiesReportLevel":{"description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.","type":"string","enum":[{"name":"ErrorsOnly","value":"ERRORS_ONLY"},{"name":"SuccessesAndErrors","value":"SUCCESSES_AND_ERRORS"}]},"aws-native:datasync:TaskReportConfigOverridesPropertiesTransferredProperties":{"description":"Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.","properties":{"reportLevel":{"$ref":"#/types/aws-native:datasync:TaskReportConfigOverridesPropertiesTransferredPropertiesReportLevel","description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't."}},"type":"object"},"aws-native:datasync:TaskReportConfigOverridesPropertiesTransferredPropertiesReportLevel":{"description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.","type":"string","enum":[{"name":"ErrorsOnly","value":"ERRORS_ONLY"},{"name":"SuccessesAndErrors","value":"SUCCESSES_AND_ERRORS"}]},"aws-native:datasync:TaskReportConfigOverridesPropertiesVerifiedProperties":{"description":"Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)","properties":{"reportLevel":{"$ref":"#/types/aws-native:datasync:TaskReportConfigOverridesPropertiesVerifiedPropertiesReportLevel","description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't."}},"type":"object"},"aws-native:datasync:TaskReportConfigOverridesPropertiesVerifiedPropertiesReportLevel":{"description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.","type":"string","enum":[{"name":"ErrorsOnly","value":"ERRORS_ONLY"},{"name":"SuccessesAndErrors","value":"SUCCESSES_AND_ERRORS"}]},"aws-native:datasync:TaskReportConfigReportLevel":{"description":"Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.","type":"string","enum":[{"name":"ErrorsOnly","value":"ERRORS_ONLY"},{"name":"SuccessesAndErrors","value":"SUCCESSES_AND_ERRORS"}]},"aws-native:datasync:TaskSchedule":{"description":"Specifies the schedule you want your task to use for repeated executions.","properties":{"scheduleExpression":{"type":"string","description":"A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location"},"status":{"$ref":"#/types/aws-native:datasync:TaskScheduleStatus","description":"Specifies status of a schedule."}},"type":"object"},"aws-native:datasync:TaskScheduleStatus":{"description":"Specifies status of a schedule.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:datasync:TaskStatus":{"description":"The status of the task that was described.","type":"string","enum":[{"name":"Available","value":"AVAILABLE"},{"name":"Creating","value":"CREATING"},{"name":"Queued","value":"QUEUED"},{"name":"Running","value":"RUNNING"},{"name":"Unavailable","value":"UNAVAILABLE"}]},"aws-native:datasync:TaskTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for an AWS resource tag."},"value":{"type":"string","description":"The value for an AWS resource tag."}},"type":"object","required":["key","value"]},"aws-native:datazone:ConnectionAmazonQPropertiesInput":{"description":"Amazon Q properties of the connection.","properties":{"authMode":{"type":"string","description":"The authentication mode of the connection's AmazonQ properties"},"isEnabled":{"type":"boolean","description":"Specifies whether Amazon Q is enabled for the connection"},"profileArn":{"type":"string"}},"type":"object"},"aws-native:datazone:ConnectionAthenaPropertiesInput":{"description":"Athena Properties Input","properties":{"workgroupName":{"type":"string"}},"type":"object","required":["workgroupName"]},"aws-native:datazone:ConnectionAuthenticationConfigurationInput":{"description":"Authentication Configuration Input","properties":{"authenticationType":{"$ref":"#/types/aws-native:datazone:ConnectionAuthenticationType"},"basicAuthenticationCredentials":{"$ref":"#/types/aws-native:datazone:ConnectionBasicAuthenticationCredentials"},"customAuthenticationCredentials":{"type":"object","additionalProperties":{"type":"string"}},"kmsKeyArn":{"type":"string"},"oAuth2Properties":{"$ref":"#/types/aws-native:datazone:ConnectionOAuth2Properties"},"secretArn":{"type":"string"}},"type":"object"},"aws-native:datazone:ConnectionAuthenticationType":{"description":"Authentication Type","type":"string","enum":[{"name":"Basic","value":"BASIC"},{"name":"Oauth2","value":"OAUTH2"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:datazone:ConnectionAuthorizationCodeProperties":{"description":"Authorization Code Properties","properties":{"authorizationCode":{"type":"string"},"redirectUri":{"type":"string"}},"type":"object"},"aws-native:datazone:ConnectionAwsLocation":{"description":"AWS Location of project","properties":{"accessRole":{"type":"string","description":"The access role of a connection."},"awsAccountId":{"type":"string","description":"The account ID of a connection."},"awsRegion":{"type":"string","description":"The Region of a connection."},"iamConnectionId":{"type":"string","description":"The IAM connection ID of a connection."}},"type":"object"},"aws-native:datazone:ConnectionBasicAuthenticationCredentials":{"description":"Basic Authentication Credentials","properties":{"password":{"type":"string"},"userName":{"type":"string"}},"type":"object"},"aws-native:datazone:ConnectionGlueConnectionInput":{"description":"Glue Connection Input","properties":{"athenaProperties":{"type":"object","additionalProperties":{"type":"string"}},"authenticationConfiguration":{"$ref":"#/types/aws-native:datazone:ConnectionAuthenticationConfigurationInput"},"connectionProperties":{"type":"object","additionalProperties":{"type":"string"}},"connectionType":{"type":"string"},"description":{"type":"string"},"matchCriteria":{"type":"string"},"name":{"type":"string"},"physicalConnectionRequirements":{"$ref":"#/types/aws-native:datazone:ConnectionPhysicalConnectionRequirements"},"pythonProperties":{"type":"object","additionalProperties":{"type":"string"}},"sparkProperties":{"type":"object","additionalProperties":{"type":"string"}},"validateCredentials":{"type":"boolean"},"validateForComputeEnvironments":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:datazone:ConnectionGlueOAuth2Credentials":{"description":"Glue OAuth2 Credentials","properties":{"accessToken":{"type":"string"},"jwtToken":{"type":"string"},"refreshToken":{"type":"string"},"userManagedClientApplicationClientSecret":{"type":"string"}},"type":"object"},"aws-native:datazone:ConnectionGluePropertiesInput":{"description":"Glue Properties Input","properties":{"glueConnectionInput":{"$ref":"#/types/aws-native:datazone:ConnectionGlueConnectionInput"}},"type":"object"},"aws-native:datazone:ConnectionHyperPodPropertiesInput":{"description":"HyperPod Properties Input","properties":{"clusterName":{"type":"string"}},"type":"object","required":["clusterName"]},"aws-native:datazone:ConnectionIamPropertiesInput":{"description":"IAM Properties Input","properties":{"glueLineageSyncEnabled":{"type":"boolean"}},"type":"object"},"aws-native:datazone:ConnectionLineageSyncSchedule":{"description":"Lineage Sync Schedule","properties":{"schedule":{"type":"string"}},"type":"object"},"aws-native:datazone:ConnectionMlflowPropertiesInput":{"description":"MLflow Properties Input","properties":{"trackingServerArn":{"type":"string","description":"The ARN of the MLflow tracking server"}},"type":"object"},"aws-native:datazone:ConnectionOAuth2ClientApplication":{"description":"OAuth2 Client Application","properties":{"awsManagedClientApplicationReference":{"type":"string"},"userManagedClientApplicationClientId":{"type":"string"}},"type":"object"},"aws-native:datazone:ConnectionOAuth2GrantType":{"description":"OAuth2 Grant Type","type":"string","enum":[{"name":"AuthorizationCode","value":"AUTHORIZATION_CODE"},{"name":"ClientCredentials","value":"CLIENT_CREDENTIALS"},{"name":"JwtBearer","value":"JWT_BEARER"}]},"aws-native:datazone:ConnectionOAuth2Properties":{"description":"OAuth2 Properties","properties":{"authorizationCodeProperties":{"$ref":"#/types/aws-native:datazone:ConnectionAuthorizationCodeProperties"},"oAuth2ClientApplication":{"$ref":"#/types/aws-native:datazone:ConnectionOAuth2ClientApplication"},"oAuth2Credentials":{"$ref":"#/types/aws-native:datazone:ConnectionGlueOAuth2Credentials"},"oAuth2GrantType":{"$ref":"#/types/aws-native:datazone:ConnectionOAuth2GrantType"},"tokenUrl":{"type":"string"},"tokenUrlParametersMap":{"type":"object","additionalProperties":{"type":"string"}}},"type":"object"},"aws-native:datazone:ConnectionPhysicalConnectionRequirements":{"description":"Physical Connection Requirements","properties":{"availabilityZone":{"type":"string"},"securityGroupIdList":{"type":"array","items":{"type":"string"}},"subnetId":{"type":"string"},"subnetIdList":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:datazone:ConnectionPropertiesInput0Properties":{"properties":{"athenaProperties":{"$ref":"#/types/aws-native:datazone:ConnectionAthenaPropertiesInput"}},"type":"object","required":["athenaProperties"]},"aws-native:datazone:ConnectionPropertiesInput1Properties":{"properties":{"glueProperties":{"$ref":"#/types/aws-native:datazone:ConnectionGluePropertiesInput"}},"type":"object","required":["glueProperties"]},"aws-native:datazone:ConnectionPropertiesInput2Properties":{"properties":{"hyperPodProperties":{"$ref":"#/types/aws-native:datazone:ConnectionHyperPodPropertiesInput"}},"type":"object","required":["hyperPodProperties"]},"aws-native:datazone:ConnectionPropertiesInput3Properties":{"properties":{"iamProperties":{"$ref":"#/types/aws-native:datazone:ConnectionIamPropertiesInput"}},"type":"object","required":["iamProperties"]},"aws-native:datazone:ConnectionPropertiesInput4Properties":{"properties":{"redshiftProperties":{"$ref":"#/types/aws-native:datazone:ConnectionRedshiftPropertiesInput"}},"type":"object","required":["redshiftProperties"]},"aws-native:datazone:ConnectionPropertiesInput5Properties":{"properties":{"sparkEmrProperties":{"$ref":"#/types/aws-native:datazone:ConnectionSparkEmrPropertiesInput"}},"type":"object","required":["sparkEmrProperties"]},"aws-native:datazone:ConnectionPropertiesInput6Properties":{"properties":{"amazonQProperties":{"$ref":"#/types/aws-native:datazone:ConnectionAmazonQPropertiesInput"}},"type":"object","required":["amazonQProperties"]},"aws-native:datazone:ConnectionPropertiesInput7Properties":{"properties":{"sparkGlueProperties":{"$ref":"#/types/aws-native:datazone:ConnectionSparkGluePropertiesInput"}},"type":"object","required":["sparkGlueProperties"]},"aws-native:datazone:ConnectionPropertiesInput8Properties":{"properties":{"s3Properties":{"$ref":"#/types/aws-native:datazone:ConnectionS3PropertiesInput"}},"type":"object","required":["s3Properties"]},"aws-native:datazone:ConnectionPropertiesInput9Properties":{"properties":{"mlflowProperties":{"$ref":"#/types/aws-native:datazone:ConnectionMlflowPropertiesInput"}},"type":"object","required":["mlflowProperties"]},"aws-native:datazone:ConnectionRedshiftCredentials0Properties":{"properties":{"secretArn":{"type":"string"}},"type":"object","required":["secretArn"]},"aws-native:datazone:ConnectionRedshiftCredentials1Properties":{"properties":{"usernamePassword":{"$ref":"#/types/aws-native:datazone:ConnectionUsernamePassword"}},"type":"object","required":["usernamePassword"]},"aws-native:datazone:ConnectionRedshiftLineageSyncConfigurationInput":{"description":"Redshift Lineage Sync Configuration Input","properties":{"enabled":{"type":"boolean"},"schedule":{"$ref":"#/types/aws-native:datazone:ConnectionLineageSyncSchedule"}},"type":"object"},"aws-native:datazone:ConnectionRedshiftPropertiesInput":{"description":"Redshift Properties Input","properties":{"credentials":{"oneOf":[{"$ref":"#/types/aws-native:datazone:ConnectionRedshiftCredentials0Properties"},{"$ref":"#/types/aws-native:datazone:ConnectionRedshiftCredentials1Properties"}]},"databaseName":{"type":"string"},"host":{"type":"string"},"lineageSync":{"$ref":"#/types/aws-native:datazone:ConnectionRedshiftLineageSyncConfigurationInput"},"port":{"type":"number"},"storage":{"oneOf":[{"$ref":"#/types/aws-native:datazone:ConnectionRedshiftStorageProperties0Properties"},{"$ref":"#/types/aws-native:datazone:ConnectionRedshiftStorageProperties1Properties"}]}},"type":"object"},"aws-native:datazone:ConnectionRedshiftStorageProperties0Properties":{"properties":{"clusterName":{"type":"string"}},"type":"object","required":["clusterName"]},"aws-native:datazone:ConnectionRedshiftStorageProperties1Properties":{"properties":{"workgroupName":{"type":"string"}},"type":"object","required":["workgroupName"]},"aws-native:datazone:ConnectionS3PropertiesInput":{"description":"S3 Properties Input","properties":{"s3AccessGrantLocationId":{"type":"string","description":"The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection."},"s3Uri":{"type":"string","description":"The Amazon S3 URI that's part of the Amazon S3 properties of a connection."}},"type":"object","required":["s3Uri"]},"aws-native:datazone:ConnectionScope":{"description":"The scope of the connection.","type":"string","enum":[{"name":"Domain","value":"DOMAIN"},{"name":"Project","value":"PROJECT"}]},"aws-native:datazone:ConnectionSparkEmrPropertiesInput":{"description":"Spark EMR Properties Input.","properties":{"computeArn":{"type":"string"},"instanceProfileArn":{"type":"string"},"javaVirtualEnv":{"type":"string"},"logUri":{"type":"string"},"managedEndpointArn":{"type":"string"},"pythonVirtualEnv":{"type":"string"},"runtimeRole":{"type":"string"},"trustedCertificatesS3Uri":{"type":"string"}},"type":"object"},"aws-native:datazone:ConnectionSparkGlueArgs":{"description":"Spark Glue Args.","properties":{"connection":{"type":"string"}},"type":"object"},"aws-native:datazone:ConnectionSparkGluePropertiesInput":{"description":"Spark Glue Properties Input.","properties":{"additionalArgs":{"$ref":"#/types/aws-native:datazone:ConnectionSparkGlueArgs"},"glueConnectionName":{"type":"string"},"glueVersion":{"type":"string"},"idleTimeout":{"type":"number"},"javaVirtualEnv":{"type":"string"},"numberOfWorkers":{"type":"number"},"pythonVirtualEnv":{"type":"string"},"workerType":{"type":"string"}},"type":"object"},"aws-native:datazone:ConnectionUsernamePassword":{"description":"The username and password to be used for authentication.","properties":{"password":{"type":"string"},"username":{"type":"string"}},"type":"object","required":["password","username"]},"aws-native:datazone:DataSourceConfigurationInput0Properties":{"description":"Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration or sageMakerRunConfiguration.","properties":{"glueRunConfiguration":{"$ref":"#/types/aws-native:datazone:DataSourceGlueRunConfigurationInput"}},"type":"object"},"aws-native:datazone:DataSourceConfigurationInput1Properties":{"description":"Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration or sageMakerRunConfiguration.","properties":{"redshiftRunConfiguration":{"$ref":"#/types/aws-native:datazone:DataSourceRedshiftRunConfigurationInput"}},"type":"object"},"aws-native:datazone:DataSourceConfigurationInput2Properties":{"description":"Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration or sageMakerRunConfiguration.","properties":{"sageMakerRunConfiguration":{"$ref":"#/types/aws-native:datazone:DataSourceSageMakerRunConfigurationInput"}},"type":"object"},"aws-native:datazone:DataSourceEnableSetting":{"description":"Specifies whether the data source is enabled.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:datazone:DataSourceFilterExpression":{"description":"The search filter expression.","properties":{"expression":{"type":"string"},"type":{"$ref":"#/types/aws-native:datazone:DataSourceFilterExpressionType"}},"type":"object","required":["expression","type"]},"aws-native:datazone:DataSourceFilterExpressionType":{"description":"The search filter expression type.","type":"string","enum":[{"name":"Include","value":"INCLUDE"},{"name":"Exclude","value":"EXCLUDE"}]},"aws-native:datazone:DataSourceFormInput":{"description":"The details of a metadata form.","properties":{"content":{"type":"string","description":"The content of the metadata form."},"formName":{"type":"string","description":"The name of the metadata form."},"typeIdentifier":{"type":"string","description":"The ID of the metadata form type."},"typeRevision":{"type":"string","description":"The revision of the metadata form type."}},"type":"object","required":["formName"]},"aws-native:datazone:DataSourceGlueRunConfigurationInput":{"properties":{"autoImportDataQualityResult":{"type":"boolean","description":"Specifies whether to automatically import data quality metrics as part of the data source run."},"catalogName":{"type":"string","description":"The catalog name in the AWS Glue run configuration."},"dataAccessRole":{"type":"string","description":"The data access role included in the configuration details of the AWS Glue data source."},"relationalFilterConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:datazone:DataSourceRelationalFilterConfiguration"},"description":"The relational filter configurations included in the configuration details of the AWS Glue data source."}},"type":"object","required":["relationalFilterConfigurations"]},"aws-native:datazone:DataSourceRecommendationConfiguration":{"description":"The recommendation to be updated as part of the UpdateDataSource action.","properties":{"enableBusinessNameGeneration":{"type":"boolean","description":"Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration."}},"type":"object"},"aws-native:datazone:DataSourceRedshiftClusterStorage":{"description":"The name of an Amazon Redshift cluster.","properties":{"clusterName":{"type":"string","description":"The name of an Amazon Redshift cluster."}},"type":"object","required":["clusterName"]},"aws-native:datazone:DataSourceRedshiftCredentialConfiguration":{"description":"The ARN of a secret manager for an Amazon Redshift cluster.","properties":{"secretManagerArn":{"type":"string","description":"The ARN of a secret manager for an Amazon Redshift cluster."}},"type":"object","required":["secretManagerArn"]},"aws-native:datazone:DataSourceRedshiftRunConfigurationInput":{"description":"The configuration details of the Amazon Redshift data source.","properties":{"dataAccessRole":{"type":"string","description":"The data access role included in the configuration details of the Amazon Redshift data source."},"redshiftCredentialConfiguration":{"$ref":"#/types/aws-native:datazone:DataSourceRedshiftCredentialConfiguration","description":"The details of the credentials required to access an Amazon Redshift cluster."},"redshiftStorage":{"oneOf":[{"$ref":"#/types/aws-native:datazone:DataSourceRedshiftStorage0Properties"},{"$ref":"#/types/aws-native:datazone:DataSourceRedshiftStorage1Properties"}],"description":"The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run."},"relationalFilterConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:datazone:DataSourceRelationalFilterConfiguration"}}},"type":"object","required":["relationalFilterConfigurations"]},"aws-native:datazone:DataSourceRedshiftServerlessStorage":{"description":"The details of the Amazon Redshift Serverless workgroup storage.","properties":{"workgroupName":{"type":"string","description":"The name of the Amazon Redshift Serverless workgroup."}},"type":"object","required":["workgroupName"]},"aws-native:datazone:DataSourceRedshiftStorage0Properties":{"description":"The details of the Amazon Redshift cluster source.","properties":{"redshiftClusterSource":{"$ref":"#/types/aws-native:datazone:DataSourceRedshiftClusterStorage"}},"type":"object","required":["redshiftClusterSource"]},"aws-native:datazone:DataSourceRedshiftStorage1Properties":{"description":"The details of the Amazon Redshift Serverless workgroup source.","properties":{"redshiftServerlessSource":{"$ref":"#/types/aws-native:datazone:DataSourceRedshiftServerlessStorage"}},"type":"object","required":["redshiftServerlessSource"]},"aws-native:datazone:DataSourceRelationalFilterConfiguration":{"description":"The relational filter configuration for the data source.","properties":{"databaseName":{"type":"string","description":"The database name specified in the relational filter configuration for the data source."},"filterExpressions":{"type":"array","items":{"$ref":"#/types/aws-native:datazone:DataSourceFilterExpression"},"description":"The filter expressions specified in the relational filter configuration for the data source."},"schemaName":{"type":"string","description":"The schema name specified in the relational filter configuration for the data source."}},"type":"object","required":["databaseName"]},"aws-native:datazone:DataSourceSageMakerRunConfigurationInput":{"description":"The configuration details of the Amazon SageMaker data source.","properties":{"trackingAssets":{"type":"object","additionalProperties":{"$ref":"pulumi.json#/Any"},"description":"The tracking assets of the Amazon SageMaker run."}},"type":"object","required":["trackingAssets"]},"aws-native:datazone:DataSourceScheduleConfiguration":{"description":"The schedule of the data source runs.","properties":{"schedule":{"type":"string","description":"The schedule of the data source runs."},"timezone":{"type":"string","description":"The timezone of the data source run."}},"type":"object"},"aws-native:datazone:DataSourceStatus":{"description":"The status of the data source.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"FailedCreation","value":"FAILED_CREATION"},{"name":"Ready","value":"READY"},{"name":"Updating","value":"UPDATING"},{"name":"FailedUpdate","value":"FAILED_UPDATE"},{"name":"Running","value":"RUNNING"},{"name":"Deleting","value":"DELETING"},{"name":"FailedDeletion","value":"FAILED_DELETION"}]},"aws-native:datazone:DomainAuthType":{"description":"The type of single sign-on in Amazon DataZone.","type":"string","enum":[{"name":"IamIdc","value":"IAM_IDC"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:datazone:DomainSingleSignOn":{"description":"The single-sign on configuration of the Amazon DataZone domain.","properties":{"idcInstanceArn":{"type":"string","description":"The ARN of the IDC instance."},"type":{"$ref":"#/types/aws-native:datazone:DomainAuthType","description":"The type of single sign-on in Amazon DataZone."},"userAssignment":{"$ref":"#/types/aws-native:datazone:DomainUserAssignment","description":"The single sign-on user assignment in Amazon DataZone."}},"type":"object"},"aws-native:datazone:DomainStatus":{"description":"The status of the Amazon DataZone domain.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Available","value":"AVAILABLE"},{"name":"CreationFailed","value":"CREATION_FAILED"},{"name":"Deleting","value":"DELETING"},{"name":"Deleted","value":"DELETED"},{"name":"DeletionFailed","value":"DELETION_FAILED"}]},"aws-native:datazone:DomainTag":{"description":"A key-value pair to associate with the domain.","properties":{"key":{"type":"string","description":"The key name of the tag."},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key","value"]},"aws-native:datazone:DomainUserAssignment":{"description":"The single sign-on user assignment in Amazon DataZone.","type":"string","enum":[{"name":"Automatic","value":"AUTOMATIC"},{"name":"Manual","value":"MANUAL"}]},"aws-native:datazone:DomainVersion":{"description":"The version of the domain.","type":"string","enum":[{"name":"V1","value":"V1"},{"name":"V2","value":"V2"}]},"aws-native:datazone:EnvironmentActionsAwsConsoleLinkParameters":{"description":"The parameters of the console link specified as part of the environment action","properties":{"uri":{"type":"string","description":"The URI of the console link specified as part of the environment action."}},"type":"object"},"aws-native:datazone:EnvironmentBlueprintConfigurationLakeFormationConfiguration":{"properties":{"locationRegistrationExcludeS3Locations":{"type":"array","items":{"type":"string"}},"locationRegistrationRole":{"type":"string"}},"type":"object"},"aws-native:datazone:EnvironmentBlueprintConfigurationProvisioningConfiguration0Properties":{"properties":{"lakeFormationConfiguration":{"$ref":"#/types/aws-native:datazone:EnvironmentBlueprintConfigurationLakeFormationConfiguration"}},"type":"object","required":["lakeFormationConfiguration"]},"aws-native:datazone:EnvironmentBlueprintConfigurationProvisioningConfigurationProperties":{"properties":{"lakeFormationConfiguration":{"$ref":"#/types/aws-native:datazone:EnvironmentBlueprintConfigurationLakeFormationConfiguration"}},"type":"object","required":["lakeFormationConfiguration"]},"aws-native:datazone:EnvironmentBlueprintConfigurationRegionalParameter":{"properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"A string to string map containing parameters for the region."},"region":{"type":"string","description":"The region specified in the environment parameter."}},"type":"object"},"aws-native:datazone:EnvironmentParameter":{"description":"The parameter details of an environment.","properties":{"name":{"type":"string","description":"The name of an environment parameter."},"value":{"type":"string","description":"The value of an environment parameter."}},"type":"object"},"aws-native:datazone:EnvironmentProfileEnvironmentParameter":{"description":"The parameter details of an environment profile.","properties":{"name":{"type":"string","description":"The name of an environment profile parameter."},"value":{"type":"string","description":"The value of an environment profile parameter."}},"type":"object"},"aws-native:datazone:EnvironmentStatus":{"description":"The status of the Amazon DataZone environment.","type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Creating","value":"CREATING"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"DeleteFailed","value":"DELETE_FAILED"},{"name":"ValidationFailed","value":"VALIDATION_FAILED"},{"name":"Suspended","value":"SUSPENDED"},{"name":"Disabled","value":"DISABLED"},{"name":"Expired","value":"EXPIRED"},{"name":"Deleted","value":"DELETED"},{"name":"Inaccessible","value":"INACCESSIBLE"}]},"aws-native:datazone:FormTypeModel":{"description":"Indicates the smithy model of the API.","properties":{"smithy":{"type":"string"}},"type":"object"},"aws-native:datazone:FormTypeStatus":{"description":"The status of this Amazon DataZone metadata form type.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:datazone:GroupProfileStatus":{"description":"The status of the group profile.","type":"string","enum":[{"name":"Assigned","value":"ASSIGNED"},{"name":"NotAssigned","value":"NOT_ASSIGNED"}]},"aws-native:datazone:OwnerEntityType":{"description":"The type of an entity.","type":"string","enum":[{"name":"DomainUnit","value":"DOMAIN_UNIT"}]},"aws-native:datazone:OwnerProperties":{"description":"The properties of a domain unit's owner.","type":"object"},"aws-native:datazone:OwnerType":{"description":"The owner that you want to add to the entity.","type":"string","enum":[{"name":"User","value":"USER"},{"name":"Group","value":"GROUP"}]},"aws-native:datazone:PolicyGrantAddToProjectMemberPoolPolicyGrantDetail":{"properties":{"includeChildDomainUnits":{"type":"boolean"}},"type":"object"},"aws-native:datazone:PolicyGrantAllDomainUnitsGrantFilter":{"type":"object"},"aws-native:datazone:PolicyGrantAllUsersGrantFilter":{"type":"object"},"aws-native:datazone:PolicyGrantCreateAssetTypePolicyGrantDetail":{"properties":{"includeChildDomainUnits":{"type":"boolean"}},"type":"object"},"aws-native:datazone:PolicyGrantCreateDomainUnitPolicyGrantDetail":{"properties":{"includeChildDomainUnits":{"type":"boolean"}},"type":"object"},"aws-native:datazone:PolicyGrantCreateEnvironmentProfilePolicyGrantDetail":{"properties":{"domainUnitId":{"type":"string"}},"type":"object"},"aws-native:datazone:PolicyGrantCreateFormTypePolicyGrantDetail":{"properties":{"includeChildDomainUnits":{"type":"boolean"}},"type":"object"},"aws-native:datazone:PolicyGrantCreateGlossaryPolicyGrantDetail":{"properties":{"includeChildDomainUnits":{"type":"boolean"}},"type":"object"},"aws-native:datazone:PolicyGrantCreateProjectFromProjectProfilePolicyGrantDetail":{"properties":{"includeChildDomainUnits":{"type":"boolean"},"projectProfiles":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:datazone:PolicyGrantCreateProjectPolicyGrantDetail":{"properties":{"includeChildDomainUnits":{"type":"boolean"}},"type":"object"},"aws-native:datazone:PolicyGrantDetail0Properties":{"properties":{"createDomainUnit":{"$ref":"#/types/aws-native:datazone:PolicyGrantCreateDomainUnitPolicyGrantDetail"}},"type":"object","required":["createDomainUnit"]},"aws-native:datazone:PolicyGrantDetail10Properties":{"properties":{"createEnvironment":{"$ref":"#/types/aws-native:datazone:PolicyGrantUnit"}},"type":"object","required":["createEnvironment"]},"aws-native:datazone:PolicyGrantDetail11Properties":{"properties":{"createEnvironmentFromBlueprint":{"$ref":"#/types/aws-native:datazone:PolicyGrantUnit"}},"type":"object","required":["createEnvironmentFromBlueprint"]},"aws-native:datazone:PolicyGrantDetail12Properties":{"properties":{"createProjectFromProjectProfile":{"$ref":"#/types/aws-native:datazone:PolicyGrantCreateProjectFromProjectProfilePolicyGrantDetail"}},"type":"object","required":["createProjectFromProjectProfile"]},"aws-native:datazone:PolicyGrantDetail1Properties":{"properties":{"overrideDomainUnitOwners":{"$ref":"#/types/aws-native:datazone:PolicyGrantOverrideDomainUnitOwnersPolicyGrantDetail"}},"type":"object","required":["overrideDomainUnitOwners"]},"aws-native:datazone:PolicyGrantDetail2Properties":{"properties":{"addToProjectMemberPool":{"$ref":"#/types/aws-native:datazone:PolicyGrantAddToProjectMemberPoolPolicyGrantDetail"}},"type":"object","required":["addToProjectMemberPool"]},"aws-native:datazone:PolicyGrantDetail3Properties":{"properties":{"overrideProjectOwners":{"$ref":"#/types/aws-native:datazone:PolicyGrantOverrideProjectOwnersPolicyGrantDetail"}},"type":"object","required":["overrideProjectOwners"]},"aws-native:datazone:PolicyGrantDetail4Properties":{"properties":{"createGlossary":{"$ref":"#/types/aws-native:datazone:PolicyGrantCreateGlossaryPolicyGrantDetail"}},"type":"object","required":["createGlossary"]},"aws-native:datazone:PolicyGrantDetail5Properties":{"properties":{"createFormType":{"$ref":"#/types/aws-native:datazone:PolicyGrantCreateFormTypePolicyGrantDetail"}},"type":"object","required":["createFormType"]},"aws-native:datazone:PolicyGrantDetail6Properties":{"properties":{"createAssetType":{"$ref":"#/types/aws-native:datazone:PolicyGrantCreateAssetTypePolicyGrantDetail"}},"type":"object","required":["createAssetType"]},"aws-native:datazone:PolicyGrantDetail7Properties":{"properties":{"createProject":{"$ref":"#/types/aws-native:datazone:PolicyGrantCreateProjectPolicyGrantDetail"}},"type":"object","required":["createProject"]},"aws-native:datazone:PolicyGrantDetail8Properties":{"properties":{"createEnvironmentProfile":{"$ref":"#/types/aws-native:datazone:PolicyGrantCreateEnvironmentProfilePolicyGrantDetail"}},"type":"object","required":["createEnvironmentProfile"]},"aws-native:datazone:PolicyGrantDetail9Properties":{"properties":{"delegateCreateEnvironmentProfile":{"$ref":"#/types/aws-native:datazone:PolicyGrantUnit"}},"type":"object","required":["delegateCreateEnvironmentProfile"]},"aws-native:datazone:PolicyGrantDomainUnitDesignation":{"type":"string","enum":[{"name":"Owner","value":"OWNER"}]},"aws-native:datazone:PolicyGrantDomainUnitFilterForProject":{"properties":{"domainUnit":{"type":"string"},"includeChildDomainUnits":{"type":"boolean"}},"type":"object","required":["domainUnit"]},"aws-native:datazone:PolicyGrantDomainUnitGrantFilter0Properties":{"properties":{"allDomainUnitsGrantFilter":{"$ref":"#/types/aws-native:datazone:PolicyGrantAllDomainUnitsGrantFilter"}},"type":"object","required":["allDomainUnitsGrantFilter"]},"aws-native:datazone:PolicyGrantDomainUnitGrantFilterProperties":{"properties":{"allDomainUnitsGrantFilter":{"$ref":"#/types/aws-native:datazone:PolicyGrantAllDomainUnitsGrantFilter"}},"type":"object","required":["allDomainUnitsGrantFilter"]},"aws-native:datazone:PolicyGrantDomainUnitPolicyGrantPrincipal":{"properties":{"domainUnitDesignation":{"$ref":"#/types/aws-native:datazone:PolicyGrantDomainUnitDesignation"},"domainUnitGrantFilter":{"$ref":"#/types/aws-native:datazone:PolicyGrantDomainUnitGrantFilterProperties"},"domainUnitIdentifier":{"type":"string"}},"type":"object"},"aws-native:datazone:PolicyGrantGroupPolicyGrantPrincipal0Properties":{"properties":{"groupIdentifier":{"type":"string"}},"type":"object","required":["groupIdentifier"]},"aws-native:datazone:PolicyGrantGroupPolicyGrantPrincipalProperties":{"properties":{"groupIdentifier":{"type":"string"}},"type":"object","required":["groupIdentifier"]},"aws-native:datazone:PolicyGrantManagedPolicyType":{"type":"string","enum":[{"name":"CreateDomainUnit","value":"CREATE_DOMAIN_UNIT"},{"name":"OverrideDomainUnitOwners","value":"OVERRIDE_DOMAIN_UNIT_OWNERS"},{"name":"AddToProjectMemberPool","value":"ADD_TO_PROJECT_MEMBER_POOL"},{"name":"OverrideProjectOwners","value":"OVERRIDE_PROJECT_OWNERS"},{"name":"CreateGlossary","value":"CREATE_GLOSSARY"},{"name":"CreateFormType","value":"CREATE_FORM_TYPE"},{"name":"CreateAssetType","value":"CREATE_ASSET_TYPE"},{"name":"CreateProject","value":"CREATE_PROJECT"},{"name":"CreateEnvironmentProfile","value":"CREATE_ENVIRONMENT_PROFILE"},{"name":"DelegateCreateEnvironmentProfile","value":"DELEGATE_CREATE_ENVIRONMENT_PROFILE"},{"name":"CreateEnvironment","value":"CREATE_ENVIRONMENT"},{"name":"CreateEnvironmentFromBlueprint","value":"CREATE_ENVIRONMENT_FROM_BLUEPRINT"},{"name":"CreateProjectFromProjectProfile","value":"CREATE_PROJECT_FROM_PROJECT_PROFILE"}]},"aws-native:datazone:PolicyGrantOverrideDomainUnitOwnersPolicyGrantDetail":{"properties":{"includeChildDomainUnits":{"type":"boolean"}},"type":"object"},"aws-native:datazone:PolicyGrantOverrideProjectOwnersPolicyGrantDetail":{"properties":{"includeChildDomainUnits":{"type":"boolean"}},"type":"object"},"aws-native:datazone:PolicyGrantPrincipal0Properties":{"properties":{"user":{"oneOf":[{"$ref":"#/types/aws-native:datazone:PolicyGrantUserPolicyGrantPrincipal0Properties"},{"$ref":"#/types/aws-native:datazone:PolicyGrantUserPolicyGrantPrincipal1Properties"}]}},"type":"object","required":["user"]},"aws-native:datazone:PolicyGrantPrincipal1Properties":{"properties":{"group":{"$ref":"#/types/aws-native:datazone:PolicyGrantGroupPolicyGrantPrincipalProperties"}},"type":"object","required":["group"]},"aws-native:datazone:PolicyGrantPrincipal2Properties":{"properties":{"project":{"$ref":"#/types/aws-native:datazone:PolicyGrantProjectPolicyGrantPrincipal"}},"type":"object","required":["project"]},"aws-native:datazone:PolicyGrantPrincipal3Properties":{"properties":{"domainUnit":{"$ref":"#/types/aws-native:datazone:PolicyGrantDomainUnitPolicyGrantPrincipal"}},"type":"object","required":["domainUnit"]},"aws-native:datazone:PolicyGrantProjectDesignation":{"type":"string","enum":[{"name":"Owner","value":"OWNER"},{"name":"Contributor","value":"CONTRIBUTOR"},{"name":"ProjectCatalogSteward","value":"PROJECT_CATALOG_STEWARD"}]},"aws-native:datazone:PolicyGrantProjectGrantFilter0Properties":{"properties":{"domainUnitFilter":{"$ref":"#/types/aws-native:datazone:PolicyGrantDomainUnitFilterForProject"}},"type":"object","required":["domainUnitFilter"]},"aws-native:datazone:PolicyGrantProjectGrantFilterProperties":{"properties":{"domainUnitFilter":{"$ref":"#/types/aws-native:datazone:PolicyGrantDomainUnitFilterForProject"}},"type":"object","required":["domainUnitFilter"]},"aws-native:datazone:PolicyGrantProjectPolicyGrantPrincipal":{"properties":{"projectDesignation":{"$ref":"#/types/aws-native:datazone:PolicyGrantProjectDesignation"},"projectGrantFilter":{"$ref":"#/types/aws-native:datazone:PolicyGrantProjectGrantFilterProperties"},"projectIdentifier":{"type":"string"}},"type":"object"},"aws-native:datazone:PolicyGrantTargetEntityType":{"type":"string","enum":[{"name":"DomainUnit","value":"DOMAIN_UNIT"},{"name":"EnvironmentBlueprintConfiguration","value":"ENVIRONMENT_BLUEPRINT_CONFIGURATION"},{"name":"EnvironmentProfile","value":"ENVIRONMENT_PROFILE"},{"name":"AssetType","value":"ASSET_TYPE"}]},"aws-native:datazone:PolicyGrantUnit":{"type":"object"},"aws-native:datazone:PolicyGrantUserPolicyGrantPrincipal0Properties":{"properties":{"userIdentifier":{"type":"string"}},"type":"object","required":["userIdentifier"]},"aws-native:datazone:PolicyGrantUserPolicyGrantPrincipal1Properties":{"properties":{"allUsersGrantFilter":{"$ref":"#/types/aws-native:datazone:PolicyGrantAllUsersGrantFilter"}},"type":"object","required":["allUsersGrantFilter"]},"aws-native:datazone:ProjectEnvironmentConfigurationUserParameter":{"properties":{"environmentConfigurationName":{"type":"string","description":"The environment configuration name."},"environmentId":{"type":"string","description":"The ID of the environment."},"environmentParameters":{"type":"array","items":{"$ref":"#/types/aws-native:datazone:ProjectEnvironmentParameter"},"description":"The environment parameters."}},"type":"object"},"aws-native:datazone:ProjectEnvironmentParameter":{"properties":{"name":{"type":"string","description":"The name of an environment profile parameter."},"value":{"type":"string","description":"The value of an environment profile parameter."}},"type":"object"},"aws-native:datazone:ProjectMembershipMember0Properties":{"properties":{"userIdentifier":{"type":"string"}},"type":"object","required":["userIdentifier"]},"aws-native:datazone:ProjectMembershipMember1Properties":{"properties":{"groupIdentifier":{"type":"string"}},"type":"object","required":["groupIdentifier"]},"aws-native:datazone:ProjectMembershipMemberIdentifierType":{"type":"string","enum":[{"name":"UserIdentifier","value":"USER_IDENTIFIER"},{"name":"GroupIdentifier","value":"GROUP_IDENTIFIER"}]},"aws-native:datazone:ProjectMembershipUserDesignation":{"type":"string","enum":[{"name":"ProjectOwner","value":"PROJECT_OWNER"},{"name":"ProjectContributor","value":"PROJECT_CONTRIBUTOR"},{"name":"ProjectCatalogViewer","value":"PROJECT_CATALOG_VIEWER"},{"name":"ProjectCatalogConsumer","value":"PROJECT_CATALOG_CONSUMER"},{"name":"ProjectCatalogSteward","value":"PROJECT_CATALOG_STEWARD"}]},"aws-native:datazone:ProjectProfileAwsAccount":{"properties":{"awsAccountId":{"type":"string","description":"The account ID of a project."}},"type":"object","required":["awsAccountId"]},"aws-native:datazone:ProjectProfileDeploymentMode":{"type":"string","enum":[{"name":"OnCreate","value":"ON_CREATE"},{"name":"OnDemand","value":"ON_DEMAND"}]},"aws-native:datazone:ProjectProfileEnvironmentConfiguration":{"properties":{"awsAccount":{"$ref":"#/types/aws-native:datazone:ProjectProfileAwsAccount","description":"The AWS account of the environment."},"awsRegion":{"$ref":"#/types/aws-native:datazone:ProjectProfileRegion","description":"The AWS Region of the environment."},"configurationParameters":{"$ref":"#/types/aws-native:datazone:ProjectProfileEnvironmentConfigurationParametersDetails","description":"The configuration parameters of the environment."},"deploymentMode":{"$ref":"#/types/aws-native:datazone:ProjectProfileDeploymentMode","description":"The deployment mode of the environment."},"deploymentOrder":{"type":"number","description":"The deployment order of the environment."},"description":{"type":"string","description":"The environment description."},"environmentBlueprintId":{"type":"string","description":"The environment blueprint ID."},"environmentConfigurationId":{"type":"string"},"name":{"type":"string","description":"The environment name."}},"type":"object","required":["awsRegion","environmentBlueprintId","name"]},"aws-native:datazone:ProjectProfileEnvironmentConfigurationParameter":{"properties":{"isEditable":{"type":"boolean","description":"Specifies whether the environment parameter is editable."},"name":{"type":"string","description":"The name of the environment configuration parameter."},"value":{"type":"string","description":"The value of the environment configuration parameter."}},"type":"object"},"aws-native:datazone:ProjectProfileEnvironmentConfigurationParametersDetails":{"properties":{"parameterOverrides":{"type":"array","items":{"$ref":"#/types/aws-native:datazone:ProjectProfileEnvironmentConfigurationParameter"},"description":"The parameter overrides."},"resolvedParameters":{"type":"array","items":{"$ref":"#/types/aws-native:datazone:ProjectProfileEnvironmentConfigurationParameter"},"description":"The resolved environment configuration parameters."},"ssmPath":{"type":"string","description":"Ssm path environment configuration parameters."}},"type":"object"},"aws-native:datazone:ProjectProfileRegion":{"properties":{"regionName":{"type":"string","description":"The AWS Region name."}},"type":"object","required":["regionName"]},"aws-native:datazone:ProjectProfileStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:datazone:ProjectStatus":{"type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Moving","value":"MOVING"},{"name":"Deleting","value":"DELETING"},{"name":"DeleteFailed","value":"DELETE_FAILED"},{"name":"Updating","value":"UPDATING"},{"name":"UpdateFailed","value":"UPDATE_FAILED"}]},"aws-native:datazone:SubscriptionTargetForm":{"description":"The details of the subscription target configuration.","properties":{"content":{"type":"string","description":"The content of the subscription target configuration."},"formName":{"type":"string","description":"The form name included in the subscription target configuration."}},"type":"object","required":["content","formName"]},"aws-native:datazone:UserProfileDetails0Properties":{"properties":{"iam":{"$ref":"#/types/aws-native:datazone:UserProfileIamUserProfileDetails"}},"type":"object","required":["iam"]},"aws-native:datazone:UserProfileDetails1Properties":{"properties":{"sso":{"$ref":"#/types/aws-native:datazone:UserProfileSsoUserProfileDetails"}},"type":"object","required":["sso"]},"aws-native:datazone:UserProfileIamUserProfileDetails":{"description":"The details of the IAM User Profile.","properties":{"arn":{"type":"string","description":"The ARN of the IAM User Profile."}},"type":"object"},"aws-native:datazone:UserProfileSsoUserProfileDetails":{"description":"The details of the SSO User Profile.","properties":{"firstName":{"type":"string","description":"The First Name of the IAM User Profile."},"lastName":{"type":"string","description":"The Last Name of the IAM User Profile."},"username":{"type":"string","description":"The username of the SSO User Profile."}},"type":"object"},"aws-native:datazone:UserProfileStatus":{"description":"The status of the user profile.","type":"string","enum":[{"name":"Assigned","value":"ASSIGNED"},{"name":"NotAssigned","value":"NOT_ASSIGNED"},{"name":"Activated","value":"ACTIVATED"},{"name":"Deactivated","value":"DEACTIVATED"}]},"aws-native:datazone:UserProfileType":{"description":"The type of the user profile.","type":"string","enum":[{"name":"Iam","value":"IAM"},{"name":"Sso","value":"SSO"}]},"aws-native:datazone:UserProfileUserType":{"description":"The type of the user.","type":"string","enum":[{"name":"IamUser","value":"IAM_USER"},{"name":"IamRole","value":"IAM_ROLE"},{"name":"SsoUser","value":"SSO_USER"}]},"aws-native:deadline:FarmTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:deadline:FleetAcceleratorCapabilities":{"properties":{"count":{"$ref":"#/types/aws-native:deadline:FleetAcceleratorCountRange"},"selections":{"type":"array","items":{"$ref":"#/types/aws-native:deadline:FleetAcceleratorSelection"}}},"type":"object","required":["selections"]},"aws-native:deadline:FleetAcceleratorCountRange":{"properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"type":"object","required":["min"]},"aws-native:deadline:FleetAcceleratorSelection":{"properties":{"name":{"$ref":"#/types/aws-native:deadline:FleetAcceleratorSelectionName"},"runtime":{"type":"string"}},"type":"object","required":["name"]},"aws-native:deadline:FleetAcceleratorSelectionName":{"type":"string","enum":[{"name":"T4","value":"t4"},{"name":"A10g","value":"a10g"},{"name":"L4","value":"l4"},{"name":"L40s","value":"l40s"}]},"aws-native:deadline:FleetAcceleratorTotalMemoryMiBRange":{"properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"type":"object","required":["min"]},"aws-native:deadline:FleetAcceleratorType":{"type":"string","enum":[{"name":"Gpu","value":"gpu"}]},"aws-native:deadline:FleetAmountCapability":{"properties":{"max":{"type":"number","description":"The maximum amount of the fleet worker capability."},"min":{"type":"number","description":"The minimum amount of fleet worker capability."},"name":{"type":"string","description":"The name of the fleet capability."}},"type":"object","required":["min","name"]},"aws-native:deadline:FleetAttributeCapability":{"properties":{"name":{"type":"string","description":"The name of the fleet attribute capability for the worker."},"values":{"type":"array","items":{"type":"string"},"description":"The number of fleet attribute capabilities."}},"type":"object","required":["name","values"]},"aws-native:deadline:FleetAutoScalingMode":{"type":"string","enum":[{"name":"NoScaling","value":"NO_SCALING"},{"name":"EventBasedAutoScaling","value":"EVENT_BASED_AUTO_SCALING"}]},"aws-native:deadline:FleetCapabilities":{"properties":{"amounts":{"type":"array","items":{"$ref":"#/types/aws-native:deadline:FleetAmountCapability"},"description":"Amount capabilities of the fleet."},"attributes":{"type":"array","items":{"$ref":"#/types/aws-native:deadline:FleetAttributeCapability"},"description":"Attribute capabilities of the fleet."}},"type":"object"},"aws-native:deadline:FleetConfiguration0Properties":{"properties":{"customerManaged":{"$ref":"#/types/aws-native:deadline:FleetCustomerManagedFleetConfiguration"}},"type":"object","required":["customerManaged"]},"aws-native:deadline:FleetConfiguration1Properties":{"properties":{"serviceManagedEc2":{"$ref":"#/types/aws-native:deadline:FleetServiceManagedEc2FleetConfiguration"}},"type":"object","required":["serviceManagedEc2"]},"aws-native:deadline:FleetCpuArchitectureType":{"type":"string","enum":[{"name":"X8664","value":"x86_64"},{"name":"Arm64","value":"arm64"}]},"aws-native:deadline:FleetCustomerManagedFleetConfiguration":{"properties":{"mode":{"$ref":"#/types/aws-native:deadline:FleetAutoScalingMode"},"storageProfileId":{"type":"string"},"tagPropagationMode":{"$ref":"#/types/aws-native:deadline:FleetTagPropagationMode"},"workerCapabilities":{"$ref":"#/types/aws-native:deadline:FleetCustomerManagedWorkerCapabilities"}},"type":"object","required":["mode","workerCapabilities"]},"aws-native:deadline:FleetCustomerManagedFleetOperatingSystemFamily":{"type":"string","enum":[{"name":"Windows","value":"WINDOWS"},{"name":"Linux","value":"LINUX"},{"name":"Macos","value":"MACOS"}]},"aws-native:deadline:FleetCustomerManagedWorkerCapabilities":{"properties":{"acceleratorCount":{"$ref":"#/types/aws-native:deadline:FleetAcceleratorCountRange"},"acceleratorTotalMemoryMiB":{"$ref":"#/types/aws-native:deadline:FleetAcceleratorTotalMemoryMiBRange"},"acceleratorTypes":{"type":"array","items":{"$ref":"#/types/aws-native:deadline:FleetAcceleratorType"}},"cpuArchitectureType":{"$ref":"#/types/aws-native:deadline:FleetCpuArchitectureType"},"customAmounts":{"type":"array","items":{"$ref":"#/types/aws-native:deadline:FleetAmountCapability"}},"customAttributes":{"type":"array","items":{"$ref":"#/types/aws-native:deadline:FleetAttributeCapability"}},"memoryMiB":{"$ref":"#/types/aws-native:deadline:FleetMemoryMiBRange"},"osFamily":{"$ref":"#/types/aws-native:deadline:FleetCustomerManagedFleetOperatingSystemFamily"},"vCpuCount":{"$ref":"#/types/aws-native:deadline:FleetVCpuCountRange"}},"type":"object","required":["cpuArchitectureType","memoryMiB","osFamily","vCpuCount"]},"aws-native:deadline:FleetEc2EbsVolume":{"properties":{"iops":{"type":"integer"},"sizeGiB":{"type":"integer"},"throughputMiB":{"type":"integer"}},"type":"object"},"aws-native:deadline:FleetEc2MarketType":{"type":"string","enum":[{"name":"OnDemand","value":"on-demand"},{"name":"Spot","value":"spot"},{"name":"WaitAndSave","value":"wait-and-save"}]},"aws-native:deadline:FleetHostConfiguration":{"properties":{"scriptBody":{"type":"string","description":"The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the `STARTING` state and before the worker processes tasks.\n\nFor more information about using the script, see [Run scripts as an administrator to configure workers](https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/smf-admin.html) in the *Deadline Cloud Developer Guide* .\n\n\u003e The script runs as an administrative user ( `sudo root` on Linux, as an Administrator on Windows)."},"scriptTimeoutSeconds":{"type":"integer","description":"The maximum time that the host configuration can run. If the timeout expires, the worker enters the `NOT RESPONDING` state and shuts down. You are charged for the time that the worker is running the host configuration script.\n\n\u003e You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers. \n\nThe default is 300 seconds (5 minutes)."}},"type":"object","required":["scriptBody"]},"aws-native:deadline:FleetMemoryMiBRange":{"properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"type":"object","required":["min"]},"aws-native:deadline:FleetServiceManagedEc2FleetConfiguration":{"properties":{"instanceCapabilities":{"$ref":"#/types/aws-native:deadline:FleetServiceManagedEc2InstanceCapabilities"},"instanceMarketOptions":{"$ref":"#/types/aws-native:deadline:FleetServiceManagedEc2InstanceMarketOptions"},"storageProfileId":{"type":"string"},"vpcConfiguration":{"$ref":"#/types/aws-native:deadline:FleetVpcConfiguration"}},"type":"object","required":["instanceCapabilities","instanceMarketOptions"]},"aws-native:deadline:FleetServiceManagedEc2InstanceCapabilities":{"properties":{"acceleratorCapabilities":{"$ref":"#/types/aws-native:deadline:FleetAcceleratorCapabilities"},"allowedInstanceTypes":{"type":"array","items":{"type":"string"}},"cpuArchitectureType":{"$ref":"#/types/aws-native:deadline:FleetCpuArchitectureType"},"customAmounts":{"type":"array","items":{"$ref":"#/types/aws-native:deadline:FleetAmountCapability"}},"customAttributes":{"type":"array","items":{"$ref":"#/types/aws-native:deadline:FleetAttributeCapability"}},"excludedInstanceTypes":{"type":"array","items":{"type":"string"}},"memoryMiB":{"$ref":"#/types/aws-native:deadline:FleetMemoryMiBRange"},"osFamily":{"$ref":"#/types/aws-native:deadline:FleetServiceManagedFleetOperatingSystemFamily"},"rootEbsVolume":{"$ref":"#/types/aws-native:deadline:FleetEc2EbsVolume"},"vCpuCount":{"$ref":"#/types/aws-native:deadline:FleetVCpuCountRange"}},"type":"object","required":["cpuArchitectureType","memoryMiB","osFamily","vCpuCount"]},"aws-native:deadline:FleetServiceManagedEc2InstanceMarketOptions":{"properties":{"type":{"$ref":"#/types/aws-native:deadline:FleetEc2MarketType"}},"type":"object","required":["type"]},"aws-native:deadline:FleetServiceManagedFleetOperatingSystemFamily":{"type":"string","enum":[{"name":"Linux","value":"LINUX"},{"name":"Windows","value":"WINDOWS"}]},"aws-native:deadline:FleetStatus":{"type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"CreateInProgress","value":"CREATE_IN_PROGRESS"},{"name":"UpdateInProgress","value":"UPDATE_IN_PROGRESS"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"Suspended","value":"SUSPENDED"}]},"aws-native:deadline:FleetTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:deadline:FleetTagPropagationMode":{"type":"string","enum":[{"name":"NoPropagation","value":"NO_PROPAGATION"},{"name":"PropagateTagsToWorkersAtLaunch","value":"PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH"}]},"aws-native:deadline:FleetVCpuCountRange":{"properties":{"max":{"type":"integer"},"min":{"type":"integer"}},"type":"object","required":["min"]},"aws-native:deadline:FleetVpcConfiguration":{"properties":{"resourceConfigurationArns":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:deadline:LicenseEndpointStatus":{"type":"string","enum":[{"name":"CreateInProgress","value":"CREATE_IN_PROGRESS"},{"name":"DeleteInProgress","value":"DELETE_IN_PROGRESS"},{"name":"Ready","value":"READY"},{"name":"NotReady","value":"NOT_READY"}]},"aws-native:deadline:LicenseEndpointTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:deadline:MonitorTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:deadline:QueueDefaultQueueBudgetAction":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"StopSchedulingAndCompleteTasks","value":"STOP_SCHEDULING_AND_COMPLETE_TASKS"},{"name":"StopSchedulingAndCancelTasks","value":"STOP_SCHEDULING_AND_CANCEL_TASKS"}]},"aws-native:deadline:QueueEnvironmentEnvironmentTemplateType":{"type":"string","enum":[{"name":"Json","value":"JSON"},{"name":"Yaml","value":"YAML"}]},"aws-native:deadline:QueueJobAttachmentSettings":{"properties":{"rootPrefix":{"type":"string","description":"The root prefix."},"s3BucketName":{"type":"string","description":"The Amazon S3 bucket name."}},"type":"object","required":["rootPrefix","s3BucketName"]},"aws-native:deadline:QueueJobRunAsUser":{"properties":{"posix":{"$ref":"#/types/aws-native:deadline:QueuePosixUser","description":"The user and group that the jobs in the queue run as."},"runAs":{"$ref":"#/types/aws-native:deadline:QueueRunAs","description":"Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user."},"windows":{"$ref":"#/types/aws-native:deadline:QueueWindowsUser","description":"Identifies a Microsoft Windows user."}},"type":"object","required":["runAs"]},"aws-native:deadline:QueuePosixUser":{"properties":{"group":{"type":"string","description":"The name of the POSIX user's group."},"user":{"type":"string","description":"The name of the POSIX user."}},"type":"object","required":["group","user"]},"aws-native:deadline:QueueRunAs":{"type":"string","enum":[{"name":"QueueConfiguredUser","value":"QUEUE_CONFIGURED_USER"},{"name":"WorkerAgentUser","value":"WORKER_AGENT_USER"}]},"aws-native:deadline:QueueTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:deadline:QueueWindowsUser":{"properties":{"passwordArn":{"type":"string","description":"The password ARN for the Windows user."},"user":{"type":"string","description":"The user."}},"type":"object","required":["passwordArn","user"]},"aws-native:deadline:StorageProfileFileSystemLocation":{"properties":{"name":{"type":"string","description":"The location name."},"path":{"type":"string","description":"The file path."},"type":{"$ref":"#/types/aws-native:deadline:StorageProfileFileSystemLocationType","description":"The type of file."}},"type":"object","required":["name","path","type"]},"aws-native:deadline:StorageProfileFileSystemLocationType":{"type":"string","enum":[{"name":"Shared","value":"SHARED"},{"name":"Local","value":"LOCAL"}]},"aws-native:deadline:StorageProfileOperatingSystemFamily":{"type":"string","enum":[{"name":"Windows","value":"WINDOWS"},{"name":"Linux","value":"LINUX"},{"name":"Macos","value":"MACOS"}]},"aws-native:detective:GraphTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ "}},"type":"object"},"aws-native:devicefarm:DevicePoolRule":{"description":"Represents a condition for a device pool.","properties":{"attribute":{"$ref":"#/types/aws-native:devicefarm:DevicePoolRuleAttribute","description":"The rule's stringified attribute."},"operator":{"$ref":"#/types/aws-native:devicefarm:DevicePoolRuleOperator","description":"Specifies how Device Farm compares the rule's attribute to the value."},"value":{"type":"string","description":"The rule's value."}},"type":"object"},"aws-native:devicefarm:DevicePoolRuleAttribute":{"description":"The rule's stringified attribute.","type":"string","enum":[{"name":"Arn","value":"ARN"},{"name":"Platform","value":"PLATFORM"},{"name":"FormFactor","value":"FORM_FACTOR"},{"name":"Manufacturer","value":"MANUFACTURER"},{"name":"RemoteAccessEnabled","value":"REMOTE_ACCESS_ENABLED"},{"name":"RemoteDebugEnabled","value":"REMOTE_DEBUG_ENABLED"},{"name":"AppiumVersion","value":"APPIUM_VERSION"},{"name":"InstanceArn","value":"INSTANCE_ARN"},{"name":"InstanceLabels","value":"INSTANCE_LABELS"},{"name":"FleetType","value":"FLEET_TYPE"},{"name":"OsVersion","value":"OS_VERSION"},{"name":"Model","value":"MODEL"},{"name":"Availability","value":"AVAILABILITY"}]},"aws-native:devicefarm:DevicePoolRuleOperator":{"description":"Specifies how Device Farm compares the rule's attribute to the value.","type":"string","enum":[{"name":"Equals","value":"EQUALS"},{"name":"LessThan","value":"LESS_THAN"},{"name":"LessThanOrEquals","value":"LESS_THAN_OR_EQUALS"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"GreaterThanOrEquals","value":"GREATER_THAN_OR_EQUALS"},{"name":"In","value":"IN"},{"name":"NotIn","value":"NOT_IN"},{"name":"Contains","value":"CONTAINS"}]},"aws-native:devicefarm:DevicePoolTag":{"properties":{"key":{"type":"string","description":"One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor in a tag category (key)."}},"type":"object","required":["key","value"]},"aws-native:devicefarm:InstanceProfileTag":{"properties":{"key":{"type":"string","description":"One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor in a tag category (key)."}},"type":"object","required":["key","value"]},"aws-native:devicefarm:NetworkProfileTag":{"properties":{"key":{"type":"string","description":"One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor in a tag category (key)."}},"type":"object","required":["key","value"]},"aws-native:devicefarm:ProjectEnvironmentVariable":{"properties":{"name":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["name","value"]},"aws-native:devicefarm:ProjectTag":{"properties":{"key":{"type":"string","description":"One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor in a tag category (key)."}},"type":"object","required":["key","value"]},"aws-native:devicefarm:ProjectVpcConfig":{"description":"The VPC security groups and subnets that are attached to a project","properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"An array of security group Ids in your Amazon VPC"},"subnetIds":{"type":"array","items":{"type":"string"},"description":"A array of subnet IDs in your Amazon VPC."},"vpcId":{"type":"string","description":"The ID of the Amazon VPC"}},"type":"object","required":["securityGroupIds","subnetIds","vpcId"]},"aws-native:devicefarm:TestGridProjectTag":{"properties":{"key":{"type":"string","description":"One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor in a tag category (key)."}},"type":"object","required":["key","value"]},"aws-native:devicefarm:TestGridProjectVpcConfig":{"description":"The VPC security groups and subnets that are attached to a TestGrid project.","properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"A list of VPC security group IDs in your Amazon VPC."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"A list of VPC subnet IDs in your Amazon VPC."},"vpcId":{"type":"string","description":"A list of VPC IDs.\n\nEach VPC is given a unique ID upon creation."}},"type":"object","required":["securityGroupIds","subnetIds","vpcId"]},"aws-native:devicefarm:VpceConfigurationTag":{"properties":{"key":{"type":"string","description":"One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor in a tag category (key)."}},"type":"object","required":["key","value"]},"aws-native:devopsguru:NotificationChannelConfig":{"description":"Information about notification channels you have configured with DevOps Guru.","properties":{"filters":{"$ref":"#/types/aws-native:devopsguru:NotificationChannelNotificationFilterConfig","description":"The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. If you do not provide filter configurations, the default configurations are to receive notifications for all message types of `High` or `Medium` severity."},"sns":{"$ref":"#/types/aws-native:devopsguru:NotificationChannelSnsChannelConfig","description":"Information about a notification channel configured in DevOps Guru to send notifications when insights are created.\n\nIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see [Permissions for Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html) .\n\nIf you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see [Permissions for AWS KMS–encrypted Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) ."}},"type":"object"},"aws-native:devopsguru:NotificationChannelInsightSeverity":{"description":"DevOps Guru Insight Severity Enum","type":"string","enum":[{"name":"Low","value":"LOW"},{"name":"Medium","value":"MEDIUM"},{"name":"High","value":"HIGH"}]},"aws-native:devopsguru:NotificationChannelNotificationFilterConfig":{"description":"Information about filters of a notification channel configured in DevOpsGuru to filter for insights.","properties":{"messageTypes":{"type":"array","items":{"$ref":"#/types/aws-native:devopsguru:NotificationChannelNotificationMessageType"},"description":"The events that you want to receive notifications for. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created."},"severities":{"type":"array","items":{"$ref":"#/types/aws-native:devopsguru:NotificationChannelInsightSeverity"},"description":"The severity levels that you want to receive notifications for. For example, you can choose to receive notifications only for insights with `HIGH` and `MEDIUM` severity levels. For more information, see [Understanding insight severities](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities) ."}},"type":"object"},"aws-native:devopsguru:NotificationChannelNotificationMessageType":{"description":"DevOps Guru NotificationMessageType Enum","type":"string","enum":[{"name":"NewInsight","value":"NEW_INSIGHT"},{"name":"ClosedInsight","value":"CLOSED_INSIGHT"},{"name":"NewAssociation","value":"NEW_ASSOCIATION"},{"name":"SeverityUpgraded","value":"SEVERITY_UPGRADED"},{"name":"NewRecommendation","value":"NEW_RECOMMENDATION"}]},"aws-native:devopsguru:NotificationChannelSnsChannelConfig":{"description":"Information about a notification channel configured in DevOps Guru to send notifications when insights are created.","properties":{"topicArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic."}},"type":"object"},"aws-native:devopsguru:ResourceCollectionCloudFormationCollectionFilter":{"description":"CloudFormation resource for DevOps Guru to monitor","properties":{"stackNames":{"type":"array","items":{"type":"string"},"description":"An array of CloudFormation stack names."}},"type":"object"},"aws-native:devopsguru:ResourceCollectionFilter":{"description":"Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.","properties":{"cloudFormation":{"$ref":"#/types/aws-native:devopsguru:ResourceCollectionCloudFormationCollectionFilter","description":"Information about AWS CloudFormation stacks. You can use up to 1000 stacks to specify which AWS resources in your account to analyze. For more information, see [Stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the *AWS CloudFormation User Guide* ."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:devopsguru:ResourceCollectionTagCollection"},"description":"The AWS tags used to filter the resources in the resource collection.\n\nTags help you identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function. For more information about using tags, see the [Tagging best practices](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) whitepaper.\n\nEach AWS tag has two parts.\n\n- A tag *key* (for example, `CostCenter` , `Environment` , `Project` , or `Secret` ). Tag *keys* are case-sensitive.\n- A field known as a tag *value* (for example, `111122223333` , `Production` , or a team name). Omitting the tag *value* is the same as using an empty string. Like tag *keys* , tag *values* are case-sensitive. The tag value is a required property when AppBoundaryKey is specified.\n\nTogether these are known as *key* - *value* pairs.\n\n\u003e The string used for a *key* in a tag that you use to define your resource coverage must begin with the prefix `Devops-guru-` . The tag *key* might be `DevOps-Guru-deployment-application` or `devops-guru-rds-application` . When you create a *key* , the case of characters in the *key* can be whatever you choose. After you create a *key* , it is case-sensitive. For example, DevOps Guru works with a *key* named `devops-guru-rds` and a *key* named `DevOps-Guru-RDS` , and these act as two different *keys* . Possible *key* / *value* pairs in your application might be `Devops-Guru-production-application/RDS` or `Devops-Guru-production-application/containers` ."}},"type":"object"},"aws-native:devopsguru:ResourceCollectionTagCollection":{"description":"Tagged resource for DevOps Guru to monitor","properties":{"appBoundaryKey":{"type":"string","description":"A Tag key for DevOps Guru app boundary."},"tagValues":{"type":"array","items":{"type":"string"},"description":"Tag values of DevOps Guru app boundary."}},"type":"object"},"aws-native:devopsguru:ResourceCollectionType":{"description":"The type of ResourceCollection","type":"string","enum":[{"name":"AwsCloudFormation","value":"AWS_CLOUD_FORMATION"},{"name":"AwsTags","value":"AWS_TAGS"}]},"aws-native:directconnect:ConnectionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:directconnect:DirectConnectGatewayTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:directconnect:LagTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:directconnect:PrivateVirtualInterfaceBgpPeer":{"description":"Information about a BGP peer.","properties":{"addressFamily":{"type":"string","description":"The address family for the BGP peer."},"amazonAddress":{"type":"string","description":"The IP address assigned to the Amazon interface."},"asn":{"type":"string","description":"The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration."},"authKey":{"type":"string","description":"The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximum length of 80 characters."},"bgpPeerId":{"type":"string"},"customerAddress":{"type":"string","description":"The IP address assigned to the customer interface."}},"type":"object","required":["addressFamily","asn"]},"aws-native:directconnect:PrivateVirtualInterfaceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:directconnect:PublicVirtualInterfaceBgpPeer":{"description":"Information about a BGP peer.","properties":{"addressFamily":{"type":"string","description":"The address family for the BGP peer."},"amazonAddress":{"type":"string","description":"The IP address assigned to the Amazon interface."},"asn":{"type":"string","description":"The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration."},"authKey":{"type":"string","description":"The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximum length of 80 characters."},"bgpPeerId":{"type":"string"},"customerAddress":{"type":"string","description":"The IP address assigned to the customer interface."}},"type":"object","required":["addressFamily","asn"]},"aws-native:directconnect:PublicVirtualInterfaceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:directconnect:TransitVirtualInterfaceBgpPeer":{"description":"A key-value pair to associate with a resource.","properties":{"addressFamily":{"type":"string","description":"The address family for the BGP peer."},"amazonAddress":{"type":"string","description":"The IP address assigned to the Amazon interface."},"asn":{"type":"string","description":"The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration."},"authKey":{"type":"string","description":"The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximum length of 80 characters."},"bgpPeerId":{"type":"string"},"customerAddress":{"type":"string","description":"The IP address assigned to the customer interface."}},"type":"object","required":["addressFamily","asn"]},"aws-native:directconnect:TransitVirtualInterfaceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:directoryservice:SimpleAdTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag"},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key","value"]},"aws-native:directoryservice:SimpleAdVpcSettings":{"properties":{"subnetIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets."},"vpcId":{"type":"string","description":"The identifier of the VPC in which to create the directory."}},"type":"object","required":["subnetIds","vpcId"]},"aws-native:dms:DataMigrationSettings":{"properties":{"cloudwatchLogsEnabled":{"type":"boolean","description":"The property specifies whether to enable the CloudWatch log."},"numberOfJobs":{"type":"integer","description":"The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target."},"selectionRules":{"type":"string","description":"The property specifies the rules of selecting objects for data migration."}},"type":"object"},"aws-native:dms:DataMigrationSourceDataSettings":{"properties":{"cdcStartPosition":{"type":"string","description":"The property is a point in the database engine's log that defines a time where you can begin CDC."},"cdcStartTime":{"type":"string","description":"The property indicates the start time for a change data capture (CDC) operation. The value is server time in UTC format."},"cdcStopTime":{"type":"string","description":"The property indicates the stop time for a change data capture (CDC) operation. The value is server time in UTC format."},"slotName":{"type":"string","description":"The property sets the name of a previously created logical replication slot for a change data capture (CDC) load of the source instance."}},"type":"object"},"aws-native:dms:DataMigrationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:dms:DataMigrationType":{"description":"The property describes the type of migration.","type":"string","enum":[{"name":"FullLoad","value":"full-load"},{"name":"Cdc","value":"cdc"},{"name":"FullLoadAndCdc","value":"full-load-and-cdc"}]},"aws-native:dms:DataProviderDb2SslModeValue":{"type":"string","enum":[{"name":"None","value":"none"},{"name":"VerifyCa","value":"verify-ca"}]},"aws-native:dms:DataProviderDmsSslModeValue":{"type":"string","enum":[{"name":"None","value":"none"},{"name":"Require","value":"require"},{"name":"VerifyCa","value":"verify-ca"},{"name":"VerifyFull","value":"verify-full"}]},"aws-native:dms:DataProviderEngine":{"description":"The property describes a data engine for the data provider.","type":"string","enum":[{"name":"Aurora","value":"aurora"},{"name":"AuroraPostgresql","value":"aurora_postgresql"},{"name":"Mysql","value":"mysql"},{"name":"Oracle","value":"oracle"},{"name":"Postgres","value":"postgres"},{"name":"Sqlserver","value":"sqlserver"},{"name":"Redshift","value":"redshift"},{"name":"Mariadb","value":"mariadb"},{"name":"Mongodb","value":"mongodb"},{"name":"Docdb","value":"docdb"},{"name":"Db2","value":"db2"},{"name":"Db2Zos","value":"db2_zos"},{"name":"Sybase","value":"sybase"}]},"aws-native:dms:DataProviderMongoDbAuthMechanism":{"type":"string","enum":[{"name":"Default","value":"default"},{"name":"MongodbCr","value":"mongodb_cr"},{"name":"ScramSha1","value":"scram_sha_1"}]},"aws-native:dms:DataProviderMongoDbAuthType":{"type":"string","enum":[{"name":"No","value":"no"},{"name":"Password","value":"password"}]},"aws-native:dms:DataProviderMongoDbSslModeValue":{"type":"string","enum":[{"name":"None","value":"none"},{"name":"Require","value":"require"},{"name":"VerifyFull","value":"verify-full"}]},"aws-native:dms:DataProviderSybaseSslModeValue":{"type":"string","enum":[{"name":"None","value":"none"},{"name":"Require","value":"require"},{"name":"VerifyCa","value":"verify-ca"}]},"aws-native:dms:DataProviderTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:dms:InstanceProfileNetworkType":{"description":"The property describes a network type for the instance profile.","type":"string","enum":[{"name":"Ipv4","value":"IPV4"},{"name":"Dual","value":"DUAL"}]},"aws-native:dms:InstanceProfileTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:dms:MigrationProjectDataProviderDescriptor":{"description":"It is an object that describes Source and Target DataProviders and credentials for connecting to databases that are used in MigrationProject","properties":{"dataProviderArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the data provider."},"dataProviderIdentifier":{"type":"string"},"dataProviderName":{"type":"string","description":"The user-friendly name of the data provider."},"secretsManagerAccessRoleArn":{"type":"string","description":"The ARN of the role used to access AWS Secrets Manager."},"secretsManagerSecretId":{"type":"string","description":"The identifier of the AWS Secrets Manager Secret used to store access credentials for the data provider."}},"type":"object"},"aws-native:dms:MigrationProjectTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, , and -."}},"type":"object","required":["key","value"]},"aws-native:dms:ReplicationConfigComputeConfig":{"description":"Configuration parameters for provisioning a AWS DMS Serverless replication","properties":{"availabilityZone":{"type":"string","description":"The Availability Zone where the AWS DMS Serverless replication using this configuration will run. The default value is a random, system-chosen Availability Zone in the configuration's AWS Region , for example, `\"us-west-2\"` . You can't set this parameter if the `MultiAZ` parameter is set to `true` ."},"dnsNameServers":{"type":"string","description":"A list of custom DNS name servers supported for the AWS DMS Serverless replication to access your source or target database. This list overrides the default name servers supported by the AWS DMS Serverless replication. You can specify a comma-separated list of internet addresses for up to four DNS name servers. For example: `\"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"`"},"kmsKeyId":{"type":"string","description":"An AWS Key Management Service ( AWS  ) key Amazon Resource Name (ARN) that is used to encrypt the data during AWS DMS Serverless replication.\n\nIf you don't specify a value for the `KmsKeyId` parameter, AWS DMS uses your default encryption key.\n\nAWS  creates the default encryption key for your Amazon Web Services account. Your AWS account has a different default encryption key for each AWS Region ."},"maxCapacityUnits":{"type":"integer","description":"Specifies the maximum value of the AWS DMS capacity units (DCUs) for which a given AWS DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the maximum value that you can specify for AWS DMS Serverless is 384. The `MaxCapacityUnits` parameter is the only DCU parameter you are required to specify."},"minCapacityUnits":{"type":"integer","description":"Specifies the minimum value of the AWS DMS capacity units (DCUs) for which a given AWS DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for AWS DMS Serverless is 1. If you don't set this value, AWS DMS sets this parameter to the minimum DCU value allowed, 1. If there is no current source activity, AWS DMS scales down your replication until it reaches the value specified in `MinCapacityUnits` ."},"multiAz":{"type":"boolean","description":"Specifies whether the AWS DMS Serverless replication is a Multi-AZ deployment. You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to `true` ."},"preferredMaintenanceWindow":{"type":"string","description":"The weekly time range during which system maintenance can occur for the AWS DMS Serverless replication, in Universal Coordinated Time (UTC). The format is `ddd:hh24:mi-ddd:hh24:mi` .\n\nThe default is a 30-minute window selected at random from an 8-hour block of time per AWS Region . This maintenance occurs on a random day of the week. Valid values for days of the week include `Mon` , `Tue` , `Wed` , `Thu` , `Fri` , `Sat` , and `Sun` .\n\nConstraints include a minimum 30-minute window."},"replicationSubnetGroupId":{"type":"string","description":"Specifies a subnet group identifier to associate with the AWS DMS Serverless replication."},"vpcSecurityGroupIds":{"type":"array","items":{"type":"string"},"description":"Specifies the virtual private cloud (VPC) security group to use with the AWS DMS Serverless replication. The VPC security group must work with the VPC containing the replication."}},"type":"object","required":["maxCapacityUnits"]},"aws-native:dms:ReplicationConfigReplicationType":{"description":"The type of AWS DMS Serverless replication to provision using this replication configuration","type":"string","enum":[{"name":"FullLoad","value":"full-load"},{"name":"FullLoadAndCdc","value":"full-load-and-cdc"},{"name":"Cdc","value":"cdc"}]},"aws-native:dms:ReplicationConfigTag":{"description":"\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n            resource.\u003c/p\u003e","properties":{"key":{"type":"string","description":"\u003cp\u003eTag key.\u003c/p\u003e"},"value":{"type":"string","description":"\u003cp\u003eTag value.\u003c/p\u003e"}},"type":"object","required":["key","value"]},"aws-native:dms:SchemaConversionApplicationAttributesProperties":{"description":"The property describes schema conversion application attributes for the migration project.","properties":{"s3BucketPath":{"type":"string"},"s3BucketRoleArn":{"type":"string"}},"type":"object"},"aws-native:dms:SettingsProperties":{"description":"The property identifies the exact type of settings for the data provider.","properties":{"docDbSettings":{"$ref":"#/types/aws-native:dms:SettingsPropertiesDocDbSettingsProperties","description":"DocDbSettings property identifier."},"ibmDb2LuwSettings":{"$ref":"#/types/aws-native:dms:SettingsPropertiesIbmDb2LuwSettingsProperties","description":"IbmDb2LuwSettings property identifier."},"ibmDb2zOsSettings":{"$ref":"#/types/aws-native:dms:SettingsPropertiesIbmDb2zOsSettingsProperties","description":"IbmDb2zOsSettings property identifier."},"mariaDbSettings":{"$ref":"#/types/aws-native:dms:SettingsPropertiesMariaDbSettingsProperties","description":"MariaDbSettings property identifier."},"microsoftSqlServerSettings":{"$ref":"#/types/aws-native:dms:SettingsPropertiesMicrosoftSqlServerSettingsProperties","description":"MicrosoftSqlServerSettings property identifier."},"mongoDbSettings":{"$ref":"#/types/aws-native:dms:SettingsPropertiesMongoDbSettingsProperties","description":"MongoDbSettings property identifier."},"mySqlSettings":{"$ref":"#/types/aws-native:dms:SettingsPropertiesMySqlSettingsProperties","description":"MySqlSettings property identifier."},"oracleSettings":{"$ref":"#/types/aws-native:dms:SettingsPropertiesOracleSettingsProperties","description":"OracleSettings property identifier."},"postgreSqlSettings":{"$ref":"#/types/aws-native:dms:SettingsPropertiesPostgreSqlSettingsProperties","description":"PostgreSqlSettings property identifier."},"redshiftSettings":{"$ref":"#/types/aws-native:dms:SettingsPropertiesRedshiftSettingsProperties","description":"RedshiftSettings property identifier."},"sybaseAseSettings":{"$ref":"#/types/aws-native:dms:SettingsPropertiesSybaseAseSettingsProperties","description":"SybaseAseSettings property identifier."}},"type":"object"},"aws-native:dms:SettingsPropertiesDocDbSettingsProperties":{"description":"DocDbSettings property identifier.","properties":{"certificateArn":{"type":"string"},"databaseName":{"type":"string"},"port":{"type":"integer"},"serverName":{"type":"string"},"sslMode":{"$ref":"#/types/aws-native:dms:DataProviderMongoDbSslModeValue"}},"type":"object","required":["databaseName","port","serverName"]},"aws-native:dms:SettingsPropertiesIbmDb2LuwSettingsProperties":{"description":"IbmDb2LuwSettings property identifier.","properties":{"certificateArn":{"type":"string"},"databaseName":{"type":"string"},"port":{"type":"integer"},"serverName":{"type":"string"},"sslMode":{"$ref":"#/types/aws-native:dms:DataProviderDb2SslModeValue"}},"type":"object","required":["databaseName","port","serverName","sslMode"]},"aws-native:dms:SettingsPropertiesIbmDb2zOsSettingsProperties":{"description":"IbmDb2zOsSettings property identifier.","properties":{"certificateArn":{"type":"string"},"databaseName":{"type":"string"},"port":{"type":"integer"},"serverName":{"type":"string"},"sslMode":{"$ref":"#/types/aws-native:dms:DataProviderDb2SslModeValue"}},"type":"object","required":["databaseName","port","serverName","sslMode"]},"aws-native:dms:SettingsPropertiesMariaDbSettingsProperties":{"description":"MariaDbSettings property identifier.","properties":{"certificateArn":{"type":"string"},"port":{"type":"integer"},"serverName":{"type":"string"},"sslMode":{"$ref":"#/types/aws-native:dms:DataProviderDmsSslModeValue"}},"type":"object","required":["port","serverName","sslMode"]},"aws-native:dms:SettingsPropertiesMicrosoftSqlServerSettingsProperties":{"description":"MicrosoftSqlServerSettings property identifier.","properties":{"certificateArn":{"type":"string"},"databaseName":{"type":"string"},"port":{"type":"integer"},"serverName":{"type":"string"},"sslMode":{"$ref":"#/types/aws-native:dms:DataProviderDmsSslModeValue"}},"type":"object","required":["databaseName","port","serverName","sslMode"]},"aws-native:dms:SettingsPropertiesMongoDbSettingsProperties":{"description":"MongoDbSettings property identifier.","properties":{"authMechanism":{"$ref":"#/types/aws-native:dms:DataProviderMongoDbAuthMechanism"},"authSource":{"type":"string"},"authType":{"$ref":"#/types/aws-native:dms:DataProviderMongoDbAuthType"},"certificateArn":{"type":"string"},"databaseName":{"type":"string"},"port":{"type":"integer"},"serverName":{"type":"string"},"sslMode":{"$ref":"#/types/aws-native:dms:DataProviderMongoDbSslModeValue"}},"type":"object","required":["port","serverName"]},"aws-native:dms:SettingsPropertiesMySqlSettingsProperties":{"description":"MySqlSettings property identifier.","properties":{"certificateArn":{"type":"string"},"port":{"type":"integer"},"serverName":{"type":"string"},"sslMode":{"$ref":"#/types/aws-native:dms:DataProviderDmsSslModeValue"}},"type":"object","required":["port","serverName","sslMode"]},"aws-native:dms:SettingsPropertiesOracleSettingsProperties":{"description":"OracleSettings property identifier.","properties":{"asmServer":{"type":"string"},"certificateArn":{"type":"string"},"databaseName":{"type":"string"},"port":{"type":"integer"},"secretsManagerOracleAsmAccessRoleArn":{"type":"string"},"secretsManagerOracleAsmSecretId":{"type":"string"},"secretsManagerSecurityDbEncryptionAccessRoleArn":{"type":"string"},"secretsManagerSecurityDbEncryptionSecretId":{"type":"string"},"serverName":{"type":"string"},"sslMode":{"$ref":"#/types/aws-native:dms:DataProviderDmsSslModeValue"}},"type":"object","required":["databaseName","port","serverName","sslMode"]},"aws-native:dms:SettingsPropertiesPostgreSqlSettingsProperties":{"description":"PostgreSqlSettings property identifier.","properties":{"certificateArn":{"type":"string"},"databaseName":{"type":"string"},"port":{"type":"integer"},"serverName":{"type":"string"},"sslMode":{"$ref":"#/types/aws-native:dms:DataProviderDmsSslModeValue"}},"type":"object","required":["databaseName","port","serverName","sslMode"]},"aws-native:dms:SettingsPropertiesRedshiftSettingsProperties":{"description":"RedshiftSettings property identifier.","properties":{"databaseName":{"type":"string"},"port":{"type":"integer"},"serverName":{"type":"string"}},"type":"object","required":["databaseName","port","serverName"]},"aws-native:dms:SettingsPropertiesSybaseAseSettingsProperties":{"description":"SybaseAseSettings property identifier.","properties":{"certificateArn":{"type":"string"},"databaseName":{"type":"string"},"encryptPassword":{"type":"boolean"},"port":{"type":"integer"},"serverName":{"type":"string"},"sslMode":{"$ref":"#/types/aws-native:dms:DataProviderSybaseSslModeValue"}},"type":"object","required":["port","serverName","sslMode"]},"aws-native:docdb:GlobalClusterEngine":{"description":"The database engine to use for this global cluster.","type":"string","enum":[{"name":"Docdb","value":"docdb"}]},"aws-native:docdb:GlobalClusterTag":{"description":"A key-value pair to associate with an Amazon DocumentDB resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:docdbelastic:ClusterTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:dsql:ClusterTag":{"description":"A map of key and value pairs to use to tag your cluster.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:dsql:EncryptionDetailsProperties":{"description":"The encryption configuration details for the cluster.","properties":{"encryptionStatus":{"type":"string","description":"The status of encryption for the cluster."},"encryptionType":{"type":"string","description":"The type of encryption that protects data in the cluster."},"kmsKeyArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the KMS key that encrypts data in the cluster."}},"type":"object"},"aws-native:dsql:MultiRegionPropertiesProperties":{"description":"The Multi-region properties associated to this cluster.","properties":{"clusters":{"type":"array","items":{"type":"string"},"description":"The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region."},"witnessRegion":{"type":"string","description":"The witness region in a multi-region cluster."}},"type":"object"},"aws-native:dynamodb:GlobalTableAttributeDefinition":{"properties":{"attributeName":{"type":"string","description":"A name for the attribute."},"attributeType":{"type":"string","description":"The data type for the attribute, where:\n\n- `S` - the attribute is of type String\n- `N` - the attribute is of type Number\n- `B` - the attribute is of type Binary"}},"type":"object","required":["attributeName","attributeType"]},"aws-native:dynamodb:GlobalTableCapacityAutoScalingSettings":{"properties":{"maxCapacity":{"type":"integer","description":"The maximum provisioned capacity units for the global table."},"minCapacity":{"type":"integer","description":"The minimum provisioned capacity units for the global table."},"seedCapacity":{"type":"integer","description":"When switching billing mode from `PAY_PER_REQUEST` to `PROVISIONED` , DynamoDB requires you to specify read and write capacity unit values for the table and for each global secondary index. These values will be applied to all replicas. The table will use these provisioned values until CloudFormation creates the autoscaling policies you configured in your template. CloudFormation cannot determine what capacity the table and its global secondary indexes will require in this time period, since they are application-dependent.\n\nIf you want to switch a table's billing mode from `PAY_PER_REQUEST` to `PROVISIONED` , you must specify a value for this property for each autoscaled resource. If you specify different values for the same resource in different regions, CloudFormation will use the highest value found in either the `SeedCapacity` or `ReadCapacityUnits` properties. For example, if your global secondary index `myGSI` has a `SeedCapacity` of 10 in us-east-1 and a fixed `ReadCapacityUnits` of 20 in eu-west-1, CloudFormation will initially set the read capacity for `myGSI` to 20. Note that if you disable `ScaleIn` for `myGSI` in us-east-1, its read capacity units might not be set back to 10.\n\nYou must also specify a value for `SeedCapacity` when you plan to switch a table's billing mode from `PROVISIONED` to `PAY_PER_REQUEST` , because CloudFormation might need to roll back the operation (reverting the billing mode to `PROVISIONED` ) and this cannot succeed without specifying a value for `SeedCapacity` ."},"targetTrackingScalingPolicyConfiguration":{"$ref":"#/types/aws-native:dynamodb:GlobalTableTargetTrackingScalingPolicyConfiguration","description":"Defines a target tracking scaling policy."}},"type":"object","required":["maxCapacity","minCapacity","targetTrackingScalingPolicyConfiguration"]},"aws-native:dynamodb:GlobalTableContributorInsightsSpecification":{"properties":{"enabled":{"type":"boolean","description":"Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false)."},"mode":{"$ref":"#/types/aws-native:dynamodb:GlobalTableContributorInsightsSpecificationMode","description":"Specifies the CloudWatch Contributor Insights mode for a global table. Valid values are `ACCESSED_AND_THROTTLED_KEYS` (tracks all access and throttled events) or `THROTTLED_KEYS` (tracks only throttled events). This setting determines what type of contributor insights data is collected for the global table."}},"type":"object","required":["enabled"]},"aws-native:dynamodb:GlobalTableContributorInsightsSpecificationMode":{"description":"Specifies the CloudWatch Contributor Insights mode for a global table. Valid values are `ACCESSED_AND_THROTTLED_KEYS` (tracks all access and throttled events) or `THROTTLED_KEYS` (tracks only throttled events). This setting determines what type of contributor insights data is collected for the global table.","type":"string","enum":[{"name":"AccessedAndThrottledKeys","value":"ACCESSED_AND_THROTTLED_KEYS"},{"name":"ThrottledKeys","value":"THROTTLED_KEYS"}]},"aws-native:dynamodb:GlobalTableGlobalReadProvisionedThroughputSettings":{"properties":{"readCapacityUnits":{"type":"integer"}},"type":"object"},"aws-native:dynamodb:GlobalTableGlobalSecondaryIndex":{"properties":{"indexName":{"type":"string","description":"The name of the global secondary index. The name must be unique among all other indexes on this table."},"keySchema":{"type":"array","items":{"$ref":"#/types/aws-native:dynamodb:GlobalTableKeySchema"},"description":"The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:\n\n- `HASH` - partition key\n- `RANGE` - sort key\n\n\u003e The partition key of an item is also known as its *hash attribute* . The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n\u003e \n\u003e The sort key of an item is also known as its *range attribute* . The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value."},"projection":{"$ref":"#/types/aws-native:dynamodb:GlobalTableProjection","description":"Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected."},"readOnDemandThroughputSettings":{"$ref":"#/types/aws-native:dynamodb:GlobalTableReadOnDemandThroughputSettings"},"readProvisionedThroughputSettings":{"$ref":"#/types/aws-native:dynamodb:GlobalTableGlobalReadProvisionedThroughputSettings"},"warmThroughput":{"$ref":"#/types/aws-native:dynamodb:GlobalTableWarmThroughput","description":"Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify `ReadUnitsPerSecond` , `WriteUnitsPerSecond` , or both."},"writeOnDemandThroughputSettings":{"$ref":"#/types/aws-native:dynamodb:GlobalTableWriteOnDemandThroughputSettings","description":"Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the `PAY_PER_REQUEST` `BillingMode` ."},"writeProvisionedThroughputSettings":{"$ref":"#/types/aws-native:dynamodb:GlobalTableWriteProvisionedThroughputSettings","description":"Defines write capacity settings for the global secondary index. You must specify a value for this property if the table's `BillingMode` is `PROVISIONED` . All replicas will have the same write capacity settings for this global secondary index."}},"type":"object","required":["indexName","keySchema","projection"]},"aws-native:dynamodb:GlobalTableKeySchema":{"properties":{"attributeName":{"type":"string","description":"The name of a key attribute."},"keyType":{"type":"string","description":"The role that this key attribute will assume:\n\n- `HASH` - partition key\n- `RANGE` - sort key\n\n\u003e The partition key of an item is also known as its *hash attribute* . The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n\u003e \n\u003e The sort key of an item is also known as its *range attribute* . The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value."}},"type":"object","required":["attributeName","keyType"]},"aws-native:dynamodb:GlobalTableKinesisStreamSpecification":{"properties":{"approximateCreationDateTimePrecision":{"$ref":"#/types/aws-native:dynamodb:GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision","description":"The precision for the time and date that the stream was created."},"streamArn":{"type":"string","description":"The ARN for a specific Kinesis data stream."}},"type":"object","required":["streamArn"]},"aws-native:dynamodb:GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision":{"description":"The precision for the time and date that the stream was created.","type":"string","enum":[{"name":"Microsecond","value":"MICROSECOND"},{"name":"Millisecond","value":"MILLISECOND"}]},"aws-native:dynamodb:GlobalTableLocalSecondaryIndex":{"properties":{"indexName":{"type":"string","description":"The name of the local secondary index. The name must be unique among all other indexes on this table."},"keySchema":{"type":"array","items":{"$ref":"#/types/aws-native:dynamodb:GlobalTableKeySchema"},"description":"The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:\n\n- `HASH` - partition key\n- `RANGE` - sort key\n\n\u003e The partition key of an item is also known as its *hash attribute* . The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n\u003e \n\u003e The sort key of an item is also known as its *range attribute* . The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value."},"projection":{"$ref":"#/types/aws-native:dynamodb:GlobalTableProjection","description":"Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected."}},"type":"object","required":["indexName","keySchema","projection"]},"aws-native:dynamodb:GlobalTableMultiRegionConsistency":{"description":"Specifies the consistency mode for a new global table.\n\nYou can specify one of the following consistency modes:\n\n- `EVENTUAL` : Configures a new global table for multi-Region eventual consistency (MREC).\n- `STRONG` : Configures a new global table for multi-Region strong consistency (MRSC).\n\nIf you don't specify this field, the global table consistency mode defaults to `EVENTUAL` . For more information about global tables consistency modes, see [Consistency modes](https://docs.aws.amazon.com/V2globaltables_HowItWorks.html#V2globaltables_HowItWorks.consistency-modes) in DynamoDB developer guide.","type":"string","enum":[{"name":"Eventual","value":"EVENTUAL"},{"name":"Strong","value":"STRONG"}]},"aws-native:dynamodb:GlobalTablePointInTimeRecoverySpecification":{"properties":{"pointInTimeRecoveryEnabled":{"type":"boolean","description":"Indicates whether point in time recovery is enabled (true) or disabled (false) on the table."},"recoveryPeriodInDays":{"type":"integer","description":"The number of preceding days for which continuous backups are taken and maintained. Your table data is only recoverable to any point-in-time from within the configured recovery period. This parameter is optional. If no value is provided, the value will default to 35."}},"type":"object"},"aws-native:dynamodb:GlobalTableProjection":{"properties":{"nonKeyAttributes":{"type":"array","items":{"type":"string"},"description":"Represents the non-key attribute names which will be projected into the index.\n\nFor global and local secondary indexes, the total count of `NonKeyAttributes` summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. This limit only applies when you specify the ProjectionType of `INCLUDE` . You still can specify the ProjectionType of `ALL` to project all attributes from the source table, even if the table has more than 100 attributes."},"projectionType":{"type":"string","description":"The set of attributes that are projected into the index:\n\n- `KEYS_ONLY` - Only the index and primary keys are projected into the index.\n- `INCLUDE` - In addition to the attributes described in `KEYS_ONLY` , the secondary index will include other non-key attributes that you specify.\n- `ALL` - All of the table attributes are projected into the index.\n\nWhen using the DynamoDB console, `ALL` is selected by default."}},"type":"object"},"aws-native:dynamodb:GlobalTableReadOnDemandThroughputSettings":{"properties":{"maxReadRequestUnits":{"type":"integer","description":"Maximum number of read request units for the specified replica of a global table."}},"type":"object"},"aws-native:dynamodb:GlobalTableReadProvisionedThroughputSettings":{"properties":{"readCapacityAutoScalingSettings":{"$ref":"#/types/aws-native:dynamodb:GlobalTableCapacityAutoScalingSettings","description":"Specifies auto scaling settings for the replica table or global secondary index."},"readCapacityUnits":{"type":"integer","description":"Specifies a fixed read capacity for the replica table or global secondary index."}},"type":"object"},"aws-native:dynamodb:GlobalTableReplicaGlobalSecondaryIndexSpecification":{"properties":{"contributorInsightsSpecification":{"$ref":"#/types/aws-native:dynamodb:GlobalTableContributorInsightsSpecification","description":"Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table."},"indexName":{"type":"string","description":"The name of the global secondary index. The name must be unique among all other indexes on this table."},"readOnDemandThroughputSettings":{"$ref":"#/types/aws-native:dynamodb:GlobalTableReadOnDemandThroughputSettings","description":"Sets the read request settings for a replica global secondary index. You can only specify this setting if your resource uses the `PAY_PER_REQUEST` `BillingMode` ."},"readProvisionedThroughputSettings":{"$ref":"#/types/aws-native:dynamodb:GlobalTableReadProvisionedThroughputSettings","description":"Allows you to specify the read capacity settings for a replica global secondary index when the `BillingMode` is set to `PROVISIONED` ."}},"type":"object","required":["indexName"]},"aws-native:dynamodb:GlobalTableReplicaSpecification":{"properties":{"contributorInsightsSpecification":{"$ref":"#/types/aws-native:dynamodb:GlobalTableContributorInsightsSpecification","description":"The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica."},"deletionProtectionEnabled":{"type":"boolean","description":"Determines if a replica is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Amazon DynamoDB Developer Guide* ."},"globalSecondaryIndexes":{"type":"array","items":{"$ref":"#/types/aws-native:dynamodb:GlobalTableReplicaGlobalSecondaryIndexSpecification"},"description":"Defines additional settings for the global secondary indexes of this replica."},"globalTableSettingsReplicationMode":{"$ref":"#/types/aws-native:dynamodb:GlobalTableReplicaSpecificationGlobalTableSettingsReplicationMode"},"kinesisStreamSpecification":{"$ref":"#/types/aws-native:dynamodb:GlobalTableKinesisStreamSpecification","description":"Defines the Kinesis Data Streams configuration for the specified replica."},"pointInTimeRecoverySpecification":{"$ref":"#/types/aws-native:dynamodb:GlobalTablePointInTimeRecoverySpecification","description":"The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica."},"readOnDemandThroughputSettings":{"$ref":"#/types/aws-native:dynamodb:GlobalTableReadOnDemandThroughputSettings","description":"Sets read request settings for the replica table."},"readProvisionedThroughputSettings":{"$ref":"#/types/aws-native:dynamodb:GlobalTableReadProvisionedThroughputSettings","description":"Defines read capacity settings for the replica table."},"region":{"type":"string","description":"The region in which this replica exists."},"replicaStreamSpecification":{"$ref":"#/types/aws-native:dynamodb:GlobalTableReplicaStreamSpecification","description":"Represents the DynamoDB Streams configuration for a global table replica."},"resourcePolicy":{"$ref":"#/types/aws-native:dynamodb:GlobalTableResourcePolicy","description":"A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.\n\nIn a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see [Using resource-based policies for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html) ."},"sseSpecification":{"$ref":"#/types/aws-native:dynamodb:GlobalTableReplicaSseSpecification","description":"Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas."},"tableClass":{"type":"string","description":"The table class of the specified table. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS` ."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:dynamodb:GlobalTableTag"},"description":"An array of key-value pairs to apply to this replica.\n\nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) ."}},"type":"object","required":["region"]},"aws-native:dynamodb:GlobalTableReplicaSpecificationGlobalTableSettingsReplicationMode":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:dynamodb:GlobalTableReplicaSseSpecification":{"properties":{"kmsMasterKeyId":{"type":"string","description":"The AWS  key that should be used for the AWS  encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key `alias/aws/dynamodb` ."}},"type":"object","required":["kmsMasterKeyId"]},"aws-native:dynamodb:GlobalTableReplicaStreamSpecification":{"properties":{"resourcePolicy":{"$ref":"#/types/aws-native:dynamodb:GlobalTableResourcePolicy","description":"A resource-based policy document that contains the permissions for the specified stream of a DynamoDB global table replica. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.\n\nIn a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see [Using resource-based policies for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html) .\n\nYou can update the `ResourcePolicy` property if you've specified more than one table using the [AWS ::DynamoDB::GlobalTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html) resource."}},"type":"object","required":["resourcePolicy"]},"aws-native:dynamodb:GlobalTableResourcePolicy":{"properties":{"policyDocument":{"$ref":"pulumi.json#/Any","description":"A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see [Using resource-based policies for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html) ."}},"type":"object","required":["policyDocument"]},"aws-native:dynamodb:GlobalTableSseSpecification":{"properties":{"sseEnabled":{"type":"boolean","description":"Indicates whether server-side encryption is performed using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to KMS and an AWS managed key is used ( AWS  charges apply). If disabled (false) or not specified,server-side encryption is set to an AWS owned key. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the `ReplicaSpecification.SSESpecification` object. You cannot mix AWS managed and customer managed KMS keys."},"sseType":{"type":"string","description":"Server-side encryption type. The only supported value is:\n\n- `KMS` - Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS  ( AWS  charges apply)."}},"type":"object","required":["sseEnabled"]},"aws-native:dynamodb:GlobalTableStreamSpecification":{"properties":{"streamViewType":{"type":"string","description":"When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table. Valid values for `StreamViewType` are:\n\n- `KEYS_ONLY` - Only the key attributes of the modified item are written to the stream.\n- `NEW_IMAGE` - The entire item, as it appears after it was modified, is written to the stream.\n- `OLD_IMAGE` - The entire item, as it appeared before it was modified, is written to the stream.\n- `NEW_AND_OLD_IMAGES` - Both the new and the old item images of the item are written to the stream."}},"type":"object","required":["streamViewType"]},"aws-native:dynamodb:GlobalTableTag":{"properties":{"key":{"type":"string","description":"The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value."},"value":{"type":"string","description":"The value of the tag. Tag values are case-sensitive and can be null."}},"type":"object","required":["key","value"]},"aws-native:dynamodb:GlobalTableTargetTrackingScalingPolicyConfiguration":{"properties":{"disableScaleIn":{"type":"boolean","description":"Indicates whether scale in by the target tracking scaling policy is disabled. The default value is `false` ."},"scaleInCooldown":{"type":"integer","description":"The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start."},"scaleOutCooldown":{"type":"integer","description":"The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start."},"targetValue":{"type":"number","description":"Defines a target value for the scaling policy."}},"type":"object","required":["targetValue"]},"aws-native:dynamodb:GlobalTableTimeToLiveSpecification":{"properties":{"attributeName":{"type":"string","description":"The name of the attribute used to store the expiration time for items in the table.\n\nCurrently, you cannot directly change the attribute name used to evaluate time to live. In order to do so, you must first disable time to live, and then re-enable it with the new attribute name. It can take up to one hour for changes to time to live to take effect. If you attempt to modify time to live within that time window, your stack operation might be delayed."},"enabled":{"type":"boolean","description":"Indicates whether TTL is to be enabled (true) or disabled (false) on the table."}},"type":"object","required":["enabled"]},"aws-native:dynamodb:GlobalTableWarmThroughput":{"properties":{"readUnitsPerSecond":{"type":"integer","description":"Represents the number of read operations your base table can instantaneously support."},"writeUnitsPerSecond":{"type":"integer","description":"Represents the number of write operations your base table can instantaneously support."}},"type":"object"},"aws-native:dynamodb:GlobalTableWitness":{"properties":{"region":{"type":"string","description":"The name of the AWS Region that serves as a witness for the MRSC global table."}},"type":"object"},"aws-native:dynamodb:GlobalTableWriteOnDemandThroughputSettings":{"properties":{"maxWriteRequestUnits":{"type":"integer","description":"Maximum number of write request settings for the specified replica of a global table."}},"type":"object"},"aws-native:dynamodb:GlobalTableWriteProvisionedThroughputSettings":{"properties":{"writeCapacityAutoScalingSettings":{"$ref":"#/types/aws-native:dynamodb:GlobalTableCapacityAutoScalingSettings","description":"Specifies auto scaling settings for the replica table or global secondary index."}},"type":"object"},"aws-native:dynamodb:TableAttributeDefinition":{"description":"Represents an attribute for describing the schema for the table and indexes.","properties":{"attributeName":{"type":"string","description":"A name for the attribute."},"attributeType":{"type":"string","description":"The data type for the attribute, where:\n  +  ``S`` - the attribute is of type String\n  +  ``N`` - the attribute is of type Number\n  +  ``B`` - the attribute is of type Binary"}},"type":"object","required":["attributeName","attributeType"]},"aws-native:dynamodb:TableContributorInsightsSpecification":{"description":"Configures contributor insights settings for a table or one of its indexes.","properties":{"enabled":{"type":"boolean","description":"Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false)."},"mode":{"$ref":"#/types/aws-native:dynamodb:TableContributorInsightsSpecificationMode","description":"Specifies the CloudWatch Contributor Insights mode for a table. Valid values are ``ACCESSED_AND_THROTTLED_KEYS`` (tracks all access and throttled events) or ``THROTTLED_KEYS`` (tracks only throttled events). This setting determines what type of contributor insights data is collected for the table."}},"type":"object","required":["enabled"]},"aws-native:dynamodb:TableContributorInsightsSpecificationMode":{"description":"Specifies the CloudWatch Contributor Insights mode for a table. Valid values are ``ACCESSED_AND_THROTTLED_KEYS`` (tracks all access and throttled events) or ``THROTTLED_KEYS`` (tracks only throttled events). This setting determines what type of contributor insights data is collected for the table.","type":"string","enum":[{"name":"AccessedAndThrottledKeys","value":"ACCESSED_AND_THROTTLED_KEYS"},{"name":"ThrottledKeys","value":"THROTTLED_KEYS"}]},"aws-native:dynamodb:TableCsv":{"description":"The options for imported source files in CSV format. The values are Delimiter and HeaderList.","properties":{"delimiter":{"type":"string","description":"The delimiter used for separating items in the CSV file being imported."},"headerList":{"type":"array","items":{"type":"string"},"description":"List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header."}},"type":"object"},"aws-native:dynamodb:TableGlobalSecondaryIndex":{"description":"Represents the properties of a global secondary index.","properties":{"contributorInsightsSpecification":{"$ref":"#/types/aws-native:dynamodb:TableContributorInsightsSpecification","description":"The settings used to specify whether to enable CloudWatch Contributor Insights for the global table and define which events to monitor."},"indexName":{"type":"string","description":"The name of the global secondary index. The name must be unique among all other indexes on this table."},"keySchema":{"type":"array","items":{"$ref":"#/types/aws-native:dynamodb:TableKeySchema"},"description":"The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:\n  +  ``HASH`` - partition key\n  +  ``RANGE`` - sort key\n  \n  The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value."},"onDemandThroughput":{"$ref":"#/types/aws-native:dynamodb:TableOnDemandThroughput","description":"The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both. You must use either ``OnDemandThroughput`` or ``ProvisionedThroughput`` based on your table's capacity mode."},"projection":{"$ref":"#/types/aws-native:dynamodb:TableProjection","description":"Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected."},"provisionedThroughput":{"$ref":"#/types/aws-native:dynamodb:TableProvisionedThroughput","description":"Represents the provisioned throughput settings for the specified global secondary index. You must use either ``OnDemandThroughput`` or ``ProvisionedThroughput`` based on your table's capacity mode.\n For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*."},"warmThroughput":{"$ref":"#/types/aws-native:dynamodb:TableWarmThroughput","description":"Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ``ReadUnitsPerSecond``, ``WriteUnitsPerSecond``, or both."}},"type":"object","required":["indexName","keySchema","projection"]},"aws-native:dynamodb:TableImportSourceSpecification":{"description":"Specifies the properties of data being imported from the S3 bucket source to the table.","properties":{"inputCompressionType":{"type":"string","description":"Type of compression to be used on the input coming from the imported table."},"inputFormat":{"type":"string","description":"The format of the source data. Valid values for ``ImportFormat`` are ``CSV``, ``DYNAMODB_JSON`` or ``ION``."},"inputFormatOptions":{"$ref":"#/types/aws-native:dynamodb:TableInputFormatOptions","description":"Additional properties that specify how the input is formatted,"},"s3BucketSource":{"$ref":"#/types/aws-native:dynamodb:TableS3BucketSource","description":"The S3 bucket that provides the source for the import."}},"type":"object","required":["inputFormat","s3BucketSource"]},"aws-native:dynamodb:TableInputFormatOptions":{"description":"The format options for the data that was imported into the target table. There is one value, CsvOption.","properties":{"csv":{"$ref":"#/types/aws-native:dynamodb:TableCsv","description":"The options for imported source files in CSV format. The values are Delimiter and HeaderList."}},"type":"object"},"aws-native:dynamodb:TableKeySchema":{"description":"Represents *a single element* of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.\n A ``KeySchemaElement`` represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one ``KeySchemaElement`` (for the partition key). A composite primary key would require one ``KeySchemaElement`` for the partition key, and another ``KeySchemaElement`` for the sort key.\n A ``KeySchemaElement`` must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.","properties":{"attributeName":{"type":"string","description":"The name of a key attribute."},"keyType":{"type":"string","description":"The role that this key attribute will assume:\n  +  ``HASH`` - partition key\n  +  ``RANGE`` - sort key\n  \n  The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value."}},"type":"object","required":["attributeName","keyType"]},"aws-native:dynamodb:TableKinesisStreamSpecification":{"description":"The Kinesis Data Streams configuration for the specified table.","properties":{"approximateCreationDateTimePrecision":{"$ref":"#/types/aws-native:dynamodb:TableKinesisStreamSpecificationApproximateCreationDateTimePrecision","description":"The precision for the time and date that the stream was created."},"streamArn":{"type":"string","description":"The ARN for a specific Kinesis data stream.\n Length Constraints: Minimum length of 37. Maximum length of 1024."}},"type":"object","required":["streamArn"]},"aws-native:dynamodb:TableKinesisStreamSpecificationApproximateCreationDateTimePrecision":{"description":"The precision for the time and date that the stream was created.","type":"string","enum":[{"name":"Microsecond","value":"MICROSECOND"},{"name":"Millisecond","value":"MILLISECOND"}]},"aws-native:dynamodb:TableLocalSecondaryIndex":{"description":"Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created.","properties":{"indexName":{"type":"string","description":"The name of the local secondary index. The name must be unique among all other indexes on this table."},"keySchema":{"type":"array","items":{"$ref":"#/types/aws-native:dynamodb:TableKeySchema"},"description":"The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:\n  +  ``HASH`` - partition key\n  +  ``RANGE`` - sort key\n  \n  The partition key of an item is also known as its *hash attribute*. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.\n The sort key of an item is also known as its *range attribute*. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value."},"projection":{"$ref":"#/types/aws-native:dynamodb:TableProjection","description":"Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected."}},"type":"object","required":["indexName","keySchema","projection"]},"aws-native:dynamodb:TableOnDemandThroughput":{"description":"Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both.","properties":{"maxReadRequestUnits":{"type":"integer","description":"Maximum number of read request units for the specified table.\n To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxReadRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxReadRequestUnits`` to -1."},"maxWriteRequestUnits":{"type":"integer","description":"Maximum number of write request units for the specified table.\n To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxWriteRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxWriteRequestUnits`` to -1."}},"type":"object"},"aws-native:dynamodb:TablePointInTimeRecoverySpecification":{"description":"The settings used to enable point in time recovery.","properties":{"pointInTimeRecoveryEnabled":{"type":"boolean","description":"Indicates whether point in time recovery is enabled (true) or disabled (false) on the table."},"recoveryPeriodInDays":{"type":"integer","description":"The number of preceding days for which continuous backups are taken and maintained. Your table data is only recoverable to any point-in-time from within the configured recovery period. This parameter is optional. If no value is provided, the value will default to 35."}},"type":"object"},"aws-native:dynamodb:TableProjection":{"description":"Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.","properties":{"nonKeyAttributes":{"type":"array","items":{"type":"string"},"description":"Represents the non-key attribute names which will be projected into the index.\n For global and local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. This limit only applies when you specify the ProjectionType of ``INCLUDE``. You still can specify the ProjectionType of ``ALL`` to project all attributes from the source table, even if the table has more than 100 attributes."},"projectionType":{"type":"string","description":"The set of attributes that are projected into the index:\n  +  ``KEYS_ONLY`` - Only the index and primary keys are projected into the index.\n  +  ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify.\n  +  ``ALL`` - All of the table attributes are projected into the index.\n  \n When using the DynamoDB console, ``ALL`` is selected by default."}},"type":"object"},"aws-native:dynamodb:TableProvisionedThroughput":{"description":"Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html).","properties":{"readCapacityUnits":{"type":"integer","description":"The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*.\n If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0."},"writeCapacityUnits":{"type":"integer","description":"The maximum number of writes consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*.\n If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0."}},"type":"object","required":["readCapacityUnits","writeCapacityUnits"]},"aws-native:dynamodb:TableResourcePolicy":{"description":"Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.\n In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).\n While defining resource-based policies in your CFNshort templates, the following considerations apply:\n  +  The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. \n  +  Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes.\n  +  Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template.\n For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template.\n Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template.\n  \n For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).","properties":{"policyDocument":{"$ref":"pulumi.json#/Any","description":"A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html)."}},"type":"object","required":["policyDocument"]},"aws-native:dynamodb:TableS3BucketSource":{"description":"The S3 bucket that is being imported from.","properties":{"s3Bucket":{"type":"string","description":"The S3 bucket that is being imported from."},"s3BucketOwner":{"type":"string","description":"The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional."},"s3KeyPrefix":{"type":"string","description":"The key prefix shared by all S3 Objects that are being imported."}},"type":"object","required":["s3Bucket"]},"aws-native:dynamodb:TableSseSpecification":{"description":"Represents the settings used to enable server-side encryption.","properties":{"kmsMasterKeyId":{"type":"string","description":"The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``."},"sseEnabled":{"type":"boolean","description":"Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key."},"sseType":{"type":"string","description":"Server-side encryption type. The only supported value is:\n  +  ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply)."}},"type":"object","required":["sseEnabled"]},"aws-native:dynamodb:TableStreamSpecification":{"description":"Represents the DynamoDB Streams configuration for a table in DynamoDB.","properties":{"resourcePolicy":{"$ref":"#/types/aws-native:dynamodb:TableResourcePolicy","description":"Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.\n  When you remove the ``StreamSpecification`` property from the template, DynamoDB disables the stream but retains any attached resource policy until the stream is deleted after 24 hours. When you modify the ``StreamViewType`` property, DynamoDB creates a new stream and retains the old stream's resource policy. The old stream and its resource policy are deleted after the 24-hour retention period.\n  In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html)."},"streamViewType":{"type":"string","description":"When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are:\n  +  ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream.\n  +  ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream.\n  +  ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream.\n  +  ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream."}},"type":"object","required":["streamViewType"]},"aws-native:dynamodb:TableTag":{"description":"Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table. \n AWS-assigned tag names and values are automatically assigned the ``aws:`` prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix ``user:`` in the Cost Allocation Report. You cannot backdate the application of a tag.\n For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the *Amazon DynamoDB Developer Guide*.","properties":{"key":{"type":"string","description":"The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value."},"value":{"type":"string","description":"The value of the tag. Tag values are case-sensitive and can be null."}},"type":"object","required":["key","value"]},"aws-native:dynamodb:TableTimeToLiveSpecification":{"description":"Represents the settings used to enable or disable Time to Live (TTL) for the specified table.","properties":{"attributeName":{"type":"string","description":"The name of the TTL attribute used to store the expiration time for items in the table.\n   +  The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled.\n  +  To update this property, you must first disable TTL and then enable TTL with the new attribute name."},"enabled":{"type":"boolean","description":"Indicates whether TTL is to be enabled (true) or disabled (false) on the table."}},"type":"object","required":["enabled"]},"aws-native:dynamodb:TableWarmThroughput":{"description":"Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the ``UpdateTable`` operation to meet the throughput requirements of an upcoming peak event.","properties":{"readUnitsPerSecond":{"type":"integer","description":"Represents the number of read operations your base table can instantaneously support."},"writeUnitsPerSecond":{"type":"integer","description":"Represents the number of write operations your base table can instantaneously support."}},"type":"object"},"aws-native:ec2:BlockPublicAccessStatesProperties":{"properties":{"internetGatewayBlockMode":{"type":"string","description":"The mode of VPC BPA. Options here are off, block-bidirectional, block-ingress "}},"type":"object"},"aws-native:ec2:CapacityManagerDataExportOutputFormat":{"description":"The format of the exported capacity manager data. Choose 'csv' for comma-separated values or 'parquet' for optimized columnar storage format.","type":"string","enum":[{"name":"Csv","value":"csv"},{"name":"Parquet","value":"parquet"}]},"aws-native:ec2:CapacityManagerDataExportSchedule":{"description":"The schedule for the capacity manager data export. Currently supports hourly exports that provide periodic snapshots of capacity manager data.","type":"string","enum":[{"name":"Hourly","value":"hourly"}]},"aws-native:ec2:CapacityManagerDataExportTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:CapacityReservationCapacityAllocation":{"properties":{"allocationType":{"type":"string","description":"The usage type. `used` indicates that the instance capacity is in use by instances that are running in the Capacity Reservation."},"count":{"type":"integer","description":"The amount of instance capacity associated with the usage. For example a value of `4` indicates that instance capacity for 4 instances is currently in use."}},"type":"object"},"aws-native:ec2:CapacityReservationFleetInstanceMatchCriteria":{"description":"Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.\n\nCurrently, Capacity Reservation Fleets support `open` instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.","type":"string","enum":[{"name":"Open","value":"open"}]},"aws-native:ec2:CapacityReservationFleetInstanceTypeSpecification":{"properties":{"availabilityZone":{"type":"string","description":"The Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone."},"availabilityZoneId":{"type":"string","description":"The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone."},"ebsOptimized":{"type":"boolean","description":"Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances types. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using EBS-optimized instance types."},"instancePlatform":{"type":"string","description":"The type of operating system for which the Capacity Reservation Fleet reserves capacity."},"instanceType":{"type":"string","description":"The instance type for which the Capacity Reservation Fleet reserves capacity."},"priority":{"type":"integer","description":"The priority to assign to the instance type. This value is used to determine which of the instance types specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more information, see [Instance type priority](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority) in the *Amazon EC2 User Guide* ."},"weight":{"type":"number","description":"The number of capacity units provided by the specified instance type. This value, together with the total target capacity that you specify for the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see [Total target capacity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) in the Amazon EC2 User Guide.\n\nValid Range: Minimum value of `0.001` . Maximum value of `99.999` ."}},"type":"object"},"aws-native:ec2:CapacityReservationFleetTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:CapacityReservationFleetTagSpecification":{"properties":{"resourceType":{"type":"string","description":"The type of resource to tag on creation. Specify `capacity-reservation-fleet` .\n\nTo tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html) ."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:CapacityReservationFleetTag"},"description":"The tags to apply to the resource."}},"type":"object"},"aws-native:ec2:CapacityReservationFleetTenancy":{"description":"Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:\n\n- `default` - The Capacity Reservation Fleet is created on hardware that is shared with other AWS accounts .\n- `dedicated` - The Capacity Reservations are created on single-tenant hardware that is dedicated to a single AWS account .","type":"string","enum":[{"name":"Default","value":"default"}]},"aws-native:ec2:CapacityReservationTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:CapacityReservationTagSpecification":{"properties":{"resourceType":{"type":"string","description":"The type of resource to tag. Specify `capacity-reservation` ."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:CapacityReservationTag"},"description":"The tags to apply to the resource."}},"type":"object"},"aws-native:ec2:CarrierGatewayTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:ec2:CommitmentInfoProperties":{"properties":{"commitmentEndDate":{"type":"string","description":"The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( `YYYY-MM-DDThh:mm:ss.sssZ` ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time."},"committedInstanceCount":{"type":"integer","description":"The instance capacity that you committed to when you requested the future-dated Capacity Reservation."}},"type":"object"},"aws-native:ec2:CpuOptionsProperties":{"description":"The CPU options for the instance.","properties":{"coreCount":{"type":"integer","description":"The number of CPU cores for the instance."},"threadsPerCore":{"type":"integer","description":"The number of threads per CPU core."}},"type":"object"},"aws-native:ec2:CreditSpecificationProperties":{"description":"The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited.","properties":{"cpuCredits":{"type":"string","description":"The credit option for CPU usage of the instance.\n\nValid values: `standard` | `unlimited`\n\nT3 instances with `host` tenancy do not support the `unlimited` CPU credit option."}},"type":"object"},"aws-native:ec2:CustomerGatewayTag":{"description":"Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:DestinationOptionsProperties":{"description":"The destination options.","properties":{"fileFormat":{"$ref":"#/types/aws-native:ec2:FlowLogDestinationOptionsPropertiesFileFormat","description":"The format for the flow log. The default is `plain-text` ."},"hiveCompatiblePartitions":{"type":"boolean","description":"Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. The default is `false` ."},"perHourPartition":{"type":"boolean","description":"Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is `false` ."}},"type":"object","required":["fileFormat","hiveCompatiblePartitions","perHourPartition"]},"aws-native:ec2:DhcpOptionsTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:Ec2FleetAcceleratorCountRequest":{"properties":{"max":{"type":"integer","description":"The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set `Max` to `0` ."},"min":{"type":"integer","description":"The minimum number of accelerators. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:Ec2FleetAcceleratorTotalMemoryMiBRequest":{"properties":{"max":{"type":"integer","description":"The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:Ec2FleetBaselineEbsBandwidthMbpsRequest":{"properties":{"max":{"type":"integer","description":"The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:Ec2FleetBaselinePerformanceFactorsRequest":{"properties":{"cpu":{"$ref":"#/types/aws-native:ec2:Ec2FleetCpuPerformanceFactorRequest","description":"The CPU performance to consider, using an instance family as the baseline reference."}},"type":"object"},"aws-native:ec2:Ec2FleetBlockDeviceMapping":{"properties":{"deviceName":{"type":"string","description":"The device name. For available device names, see [Device names for volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html) ."},"ebs":{"$ref":"#/types/aws-native:ec2:Ec2FleetEbsBlockDevice","description":"Parameters used to automatically set up EBS volumes when the instance is launched."},"noDevice":{"type":"string","description":"To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value."},"virtualName":{"type":"string","description":"The virtual device name ( `ephemeral` N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for `ephemeral0` and `ephemeral1` . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.\n\nNVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.\n\nConstraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI."}},"type":"object"},"aws-native:ec2:Ec2FleetCapacityRebalance":{"properties":{"replacementStrategy":{"$ref":"#/types/aws-native:ec2:Ec2FleetCapacityRebalanceReplacementStrategy","description":"The replacement strategy to use. Only available for fleets of type `maintain` .\n\n`launch` - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.\n\n`launch-before-terminate` - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in `TerminationDelay` ), terminates the instances that received a rebalance notification."},"terminationDelay":{"type":"integer","description":"The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.\n\nRequired when `ReplacementStrategy` is set to `launch-before-terminate` .\n\nNot valid when `ReplacementStrategy` is set to `launch` .\n\nValid values: Minimum value of `120` seconds. Maximum value of `7200` seconds."}},"type":"object"},"aws-native:ec2:Ec2FleetCapacityRebalanceReplacementStrategy":{"description":"The replacement strategy to use. Only available for fleets of type `maintain` .\n\n`launch` - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.\n\n`launch-before-terminate` - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in `TerminationDelay` ), terminates the instances that received a rebalance notification.","type":"string","enum":[{"name":"Launch","value":"launch"},{"name":"LaunchBeforeTerminate","value":"launch-before-terminate"}]},"aws-native:ec2:Ec2FleetCapacityReservationOptionsRequest":{"properties":{"usageStrategy":{"$ref":"#/types/aws-native:ec2:Ec2FleetCapacityReservationOptionsRequestUsageStrategy","description":"Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.\n\nIf you specify `use-capacity-reservations-first` , the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy ( `lowest-price` or `prioritized` ) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy ( `lowest-price` or `prioritized` ).\n\nIf you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy."}},"type":"object"},"aws-native:ec2:Ec2FleetCapacityReservationOptionsRequestUsageStrategy":{"description":"Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.\n\nIf you specify `use-capacity-reservations-first` , the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy ( `lowest-price` or `prioritized` ) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy ( `lowest-price` or `prioritized` ).\n\nIf you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.","type":"string","enum":[{"name":"UseCapacityReservationsFirst","value":"use-capacity-reservations-first"}]},"aws-native:ec2:Ec2FleetCpuPerformanceFactorRequest":{"properties":{"references":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:Ec2FleetPerformanceFactorReferenceRequest"},"description":"Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences.\n\n\u003e Currently, only one instance family can be specified in the list."}},"type":"object"},"aws-native:ec2:Ec2FleetEbsBlockDevice":{"properties":{"deleteOnTermination":{"type":"boolean","description":"Indicates whether the EBS volume is deleted on instance termination. For more information, see [Preserving Amazon EBS volumes on instance termination](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) in the *Amazon EC2 User Guide* ."},"encrypted":{"type":"boolean","description":"Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to `true` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html#encryption-parameters) in the *Amazon EBS User Guide* .\n\nIn no case can you remove encryption from an encrypted volume.\n\nEncrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances) .\n\n- If you are creating a block device mapping for a *new (empty) volume* , you can include this parameter, and specify either `true` for an encrypted volume, or `false` for an unencrypted volume. If you omit this parameter, it defaults to `false` (unencrypted).\n- If you are creating a block device mapping from an *existing encrypted or unencrypted snapshot* , you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.\n- If you are creating a block device mapping from an *existing unencrypted volume* , you can include this parameter, but you must specify `false` . If you specify `true` , the request will fail. In this case, we recommend that you omit the parameter.\n- If you are creating a block device mapping from an *existing encrypted volume* , you can include this parameter, and specify either `true` or `false` . However, if you specify `false` , the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter."},"iops":{"type":"integer","description":"The number of I/O operations per second (IOPS). For `gp3` , `io1` , and `io2` volumes, this represents the number of IOPS that are provisioned for the volume. For `gp2` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n\nThe following are the supported values for each volume type:\n\n- `gp3` : 3,000 - 80,000 IOPS\n- `io1` : 100 - 64,000 IOPS\n- `io2` : 100 - 256,000 IOPS\n\nFor `io2` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) . On other instances, you can achieve performance up to 32,000 IOPS.\n\nThis parameter is required for `io1` and `io2` volumes. The default for `gp3` volumes is 3,000 IOPS."},"kmsKeyId":{"type":"string","description":"Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.\n\nThis parameter is only supported on `BlockDeviceMapping` objects called by [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) , [RequestSpotFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html) , and [RequestSpotInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html) ."},"snapshotId":{"type":"string","description":"The ID of the snapshot."},"volumeSize":{"type":"integer","description":"The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.\n\nThe following are the supported sizes for each volume type:\n\n- `gp2` : 1 - 16,384 GiB\n- `gp3` : 1 - 65,536 GiB\n- `io1` : 4 - 16,384 GiB\n- `io2` : 4 - 65,536 GiB\n- `st1` and `sc1` : 125 - 16,384 GiB\n- `standard` : 1 - 1024 GiB"},"volumeType":{"$ref":"#/types/aws-native:ec2:Ec2FleetEbsBlockDeviceVolumeType","description":"The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide* ."}},"type":"object"},"aws-native:ec2:Ec2FleetEbsBlockDeviceVolumeType":{"description":"The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide* .","type":"string","enum":[{"name":"Gp2","value":"gp2"},{"name":"Gp3","value":"gp3"},{"name":"Io1","value":"io1"},{"name":"Io2","value":"io2"},{"name":"Sc1","value":"sc1"},{"name":"St1","value":"st1"},{"name":"Standard","value":"standard"}]},"aws-native:ec2:Ec2FleetExcessCapacityTerminationPolicy":{"description":"Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.\n\nSupported only for fleets of type `maintain` .","type":"string","enum":[{"name":"Termination","value":"termination"},{"name":"NoTermination","value":"no-termination"}]},"aws-native:ec2:Ec2FleetFleetLaunchTemplateConfigRequest":{"properties":{"launchTemplateSpecification":{"$ref":"#/types/aws-native:ec2:Ec2FleetFleetLaunchTemplateSpecificationRequest","description":"The launch template to use. You must specify either the launch template ID or launch template name in the request."},"overrides":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:Ec2FleetFleetLaunchTemplateOverridesRequest"},"description":"Any parameters that you specify override the same parameters in the launch template.\n\nFor fleets of type `request` and `maintain` , a maximum of 300 items is allowed across all launch templates."}},"type":"object"},"aws-native:ec2:Ec2FleetFleetLaunchTemplateOverridesRequest":{"properties":{"availabilityZone":{"type":"string","description":"The Availability Zone in which to launch the instances. For example, `us-east-2a` .\n\nEither `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both."},"availabilityZoneId":{"type":"string","description":"The ID of the Availability Zone in which to launch the instances. For example, `use2-az1` .\n\nEither `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both."},"blockDeviceMappings":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:Ec2FleetBlockDeviceMapping"},"description":"The block device mappings, which define the EBS volumes and instance store volumes to attach to the instance at launch.\n\nSupported only for fleets of type `instant` .\n\nFor more information, see [Block device mappings for volumes on Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) in the *Amazon EC2 User Guide* ."},"instanceRequirements":{"$ref":"#/types/aws-native:ec2:Ec2FleetInstanceRequirementsRequest","description":"The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.\n\n\u003e If you specify `InstanceRequirements` , you can't specify `InstanceType` ."},"instanceType":{"type":"string","description":"The instance type.\n\n`mac1.metal` is not supported as a launch template override.\n\n\u003e If you specify `InstanceType` , you can't specify `InstanceRequirements` ."},"maxPrice":{"type":"string","description":"The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n\n\u003e If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.\n\u003e \n\u003e If you specify a maximum price, it must be more than USD $0.001. Specifying a value below USD $0.001 will result in an `InvalidParameterValue` error message."},"placement":{"$ref":"#/types/aws-native:ec2:Ec2FleetPlacement","description":"The location where the instance launched, if applicable."},"priority":{"type":"number","description":"The priority for the launch template override. The highest priority is launched first.\n\nIf the On-Demand `AllocationStrategy` is set to `prioritized` , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.\n\nIf the Spot `AllocationStrategy` is set to `capacity-optimized-prioritized` , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.\n\nValid values are whole numbers starting at `0` . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides."},"subnetId":{"type":"string","description":"The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, `subnet-1234abcdeexample1, subnet-0987cdef6example2` ). A request of type `instant` can have only one subnet ID."},"weightedCapacity":{"type":"number","description":"The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.\n\nIf the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.\n\n\u003e When specifying weights, the price used in the `lowest-price` and `price-capacity-optimized` allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested `TargetCapacity` , resulting in only 1 instance being launched, the price used is per *instance* hour."}},"type":"object"},"aws-native:ec2:Ec2FleetFleetLaunchTemplateSpecificationRequest":{"properties":{"launchTemplateId":{"type":"string","description":"The ID of the launch template.\n\nYou must specify the `LaunchTemplateId` or the `LaunchTemplateName` , but not both."},"launchTemplateName":{"type":"string","description":"The name of the launch template.\n\nYou must specify the `LaunchTemplateName` or the `LaunchTemplateId` , but not both."},"version":{"type":"string","description":"The launch template version number, `$Latest` , or `$Default` . You must specify a value, otherwise the request fails.\n\nIf the value is `$Latest` , Amazon EC2 uses the latest version of the launch template.\n\nIf the value is `$Default` , Amazon EC2 uses the default version of the launch template."}},"type":"object","required":["version"]},"aws-native:ec2:Ec2FleetInstanceRequirementsRequest":{"properties":{"acceleratorCount":{"$ref":"#/types/aws-native:ec2:Ec2FleetAcceleratorCountRequest","description":"The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.\n\nTo exclude accelerator-enabled instance types, set `Max` to `0` .\n\nDefault: No minimum or maximum limits"},"acceleratorManufacturers":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:Ec2FleetInstanceRequirementsRequestAcceleratorManufacturersItem"},"description":"Indicates whether instance types must have accelerators by specific manufacturers.\n\n- For instance types with AWS devices, specify `amazon-web-services` .\n- For instance types with AMD devices, specify `amd` .\n- For instance types with Habana devices, specify `habana` .\n- For instance types with NVIDIA devices, specify `nvidia` .\n- For instance types with Xilinx devices, specify `xilinx` .\n\nDefault: Any manufacturer"},"acceleratorNames":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:Ec2FleetInstanceRequirementsRequestAcceleratorNamesItem"},"description":"The accelerators that must be on the instance type.\n\n- For instance types with NVIDIA A10G GPUs, specify `a10g` .\n- For instance types with NVIDIA A100 GPUs, specify `a100` .\n- For instance types with NVIDIA H100 GPUs, specify `h100` .\n- For instance types with AWS Inferentia chips, specify `inferentia` .\n- For instance types with AWS Inferentia2 chips, specify `inferentia2` .\n- For instance types with Habana Gaudi HL-205 GPUs, specify `gaudi-hl-205` .\n- For instance types with NVIDIA GRID K520 GPUs, specify `k520` .\n- For instance types with NVIDIA K80 GPUs, specify `k80` .\n- For instance types with NVIDIA L4 GPUs, specify `l4` .\n- For instance types with NVIDIA L40S GPUs, specify `l40s` .\n- For instance types with NVIDIA M60 GPUs, specify `m60` .\n- For instance types with AMD Radeon Pro V520 GPUs, specify `radeon-pro-v520` .\n- For instance types with AWS Trainium chips, specify `trainium` .\n- For instance types with AWS Trainium2 chips, specify `trainium2` .\n- For instance types with NVIDIA T4 GPUs, specify `t4` .\n- For instance types with NVIDIA T4G GPUs, specify `t4g` .\n- For instance types with Xilinx U30 cards, specify `u30` .\n- For instance types with Xilinx VU9P FPGAs, specify `vu9p` .\n- For instance types with NVIDIA V100 GPUs, specify `v100` .\n\nDefault: Any accelerator"},"acceleratorTotalMemoryMiB":{"$ref":"#/types/aws-native:ec2:Ec2FleetAcceleratorTotalMemoryMiBRequest","description":"The minimum and maximum amount of total accelerator memory, in MiB.\n\nDefault: No minimum or maximum limits"},"acceleratorTypes":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:Ec2FleetInstanceRequirementsRequestAcceleratorTypesItem"},"description":"The accelerator types that must be on the instance type.\n\n- For instance types with FPGA accelerators, specify `fpga` .\n- For instance types with GPU accelerators, specify `gpu` .\n- For instance types with Inference accelerators, specify `inference` .\n- For instance types with Media accelerators, specify `media` .\n\nDefault: Any accelerator type"},"allowedInstanceTypes":{"type":"array","items":{"type":"string"},"description":"The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.\n\nYou can use strings with one or more wild cards, represented by an asterisk ( `*` ), to allow an instance type, size, or generation. The following are examples: `m5.8xlarge` , `c5*.*` , `m5a.*` , `r*` , `*3*` .\n\nFor example, if you specify `c5*` ,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*` , Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.\n\n\u003e If you specify `AllowedInstanceTypes` , you can't specify `ExcludedInstanceTypes` . \n\nDefault: All instance types"},"bareMetal":{"$ref":"#/types/aws-native:ec2:Ec2FleetInstanceRequirementsRequestBareMetal","description":"Indicates whether bare metal instance types must be included, excluded, or required.\n\n- To include bare metal instance types, specify `included` .\n- To require only bare metal instance types, specify `required` .\n- To exclude bare metal instance types, specify `excluded` .\n\nDefault: `excluded`"},"baselineEbsBandwidthMbps":{"$ref":"#/types/aws-native:ec2:Ec2FleetBaselineEbsBandwidthMbpsRequest","description":"The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide* .\n\nDefault: No minimum or maximum limits"},"baselinePerformanceFactors":{"$ref":"#/types/aws-native:ec2:Ec2FleetBaselinePerformanceFactorsRequest","description":"The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* ."},"burstablePerformance":{"$ref":"#/types/aws-native:ec2:Ec2FleetInstanceRequirementsRequestBurstablePerformance","description":"Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) .\n\n- To include burstable performance instance types, specify `included` .\n- To require only burstable performance instance types, specify `required` .\n- To exclude burstable performance instance types, specify `excluded` .\n\nDefault: `excluded`"},"cpuManufacturers":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:Ec2FleetInstanceRequirementsRequestCpuManufacturersItem"},"description":"The CPU manufacturers to include.\n\n- For instance types with Intel CPUs, specify `intel` .\n- For instance types with AMD CPUs, specify `amd` .\n- For instance types with AWS CPUs, specify `amazon-web-services` .\n- For instance types with Apple CPUs, specify `apple` .\n\n\u003e Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. \n\nDefault: Any manufacturer"},"excludedInstanceTypes":{"type":"array","items":{"type":"string"},"description":"The instance types to exclude.\n\nYou can use strings with one or more wild cards, represented by an asterisk ( `*` ), to exclude an instance family, type, size, or generation. The following are examples: `m5.8xlarge` , `c5*.*` , `m5a.*` , `r*` , `*3*` .\n\nFor example, if you specify `c5*` ,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*` , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.\n\n\u003e If you specify `ExcludedInstanceTypes` , you can't specify `AllowedInstanceTypes` . \n\nDefault: No excluded instance types"},"instanceGenerations":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:Ec2FleetInstanceRequirementsRequestInstanceGenerationsItem"},"description":"Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .\n\nFor current generation instance types, specify `current` .\n\nFor previous generation instance types, specify `previous` .\n\nDefault: Current and previous generation instance types"},"localStorage":{"$ref":"#/types/aws-native:ec2:Ec2FleetInstanceRequirementsRequestLocalStorage","description":"Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide* .\n\n- To include instance types with instance store volumes, specify `included` .\n- To require only instance types with instance store volumes, specify `required` .\n- To exclude instance types with instance store volumes, specify `excluded` .\n\nDefault: `included`"},"localStorageTypes":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:Ec2FleetInstanceRequirementsRequestLocalStorageTypesItem"},"description":"The type of local storage that is required.\n\n- For instance types with hard disk drive (HDD) storage, specify `hdd` .\n- For instance types with solid state drive (SSD) storage, specify `ssd` .\n\nDefault: `hdd` and `ssd`"},"maxSpotPriceAsPercentageOfOptimalOnDemandPrice":{"type":"integer","description":"[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n\nIf you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.\n\n\u003e Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999` ."},"memoryGiBPerVCpu":{"$ref":"#/types/aws-native:ec2:Ec2FleetMemoryGiBPerVCpuRequest","description":"The minimum and maximum amount of memory per vCPU, in GiB.\n\nDefault: No minimum or maximum limits"},"memoryMiB":{"$ref":"#/types/aws-native:ec2:Ec2FleetMemoryMiBRequest","description":"The minimum and maximum amount of memory, in MiB."},"networkBandwidthGbps":{"$ref":"#/types/aws-native:ec2:Ec2FleetNetworkBandwidthGbpsRequest","description":"The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see [Amazon EC2 instance network bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html) in the *Amazon EC2 User Guide* .\n\nDefault: No minimum or maximum limits"},"networkInterfaceCount":{"$ref":"#/types/aws-native:ec2:Ec2FleetNetworkInterfaceCountRequest","description":"The minimum and maximum number of network interfaces.\n\nDefault: No minimum or maximum limits"},"onDemandMaxPricePercentageOverLowestPrice":{"type":"integer","description":"[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n\nTo indicate no price protection threshold, specify a high value, such as `999999` .\n\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .\n\n\u003e If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. \n\nDefault: `20`"},"requireEncryptionInTransit":{"type":"boolean","description":"Specifies whether instance types must support encrypting in-transit traffic between instances. For more information, including the supported instance types, see [Encryption in transit](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data-protection.html#encryption-transit) in the *Amazon EC2 User Guide* .\n\nDefault: `false`"},"requireHibernateSupport":{"type":"boolean","description":"Indicates whether instance types must support hibernation for On-Demand Instances.\n\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) .\n\nDefault: `false`"},"spotMaxPricePercentageOverLowestPrice":{"type":"integer","description":"[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.\n\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n\nIf you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.\n\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .\n\n\u003e Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999` . \n\nDefault: `100`"},"totalLocalStorageGb":{"$ref":"#/types/aws-native:ec2:Ec2FleetTotalLocalStorageGbRequest","description":"The minimum and maximum amount of total local storage, in GB.\n\nDefault: No minimum or maximum limits"},"vCpuCount":{"$ref":"#/types/aws-native:ec2:Ec2FleetVCpuCountRangeRequest","description":"The minimum and maximum number of vCPUs."}},"type":"object"},"aws-native:ec2:Ec2FleetInstanceRequirementsRequestAcceleratorManufacturersItem":{"type":"string","enum":[{"name":"AmazonWebServices","value":"amazon-web-services"},{"name":"Amd","value":"amd"},{"name":"Habana","value":"habana"},{"name":"Nvidia","value":"nvidia"},{"name":"Xilinx","value":"xilinx"}]},"aws-native:ec2:Ec2FleetInstanceRequirementsRequestAcceleratorNamesItem":{"type":"string","enum":[{"name":"A10g","value":"a10g"},{"name":"A100","value":"a100"},{"name":"H100","value":"h100"},{"name":"Inferentia","value":"inferentia"},{"name":"K520","value":"k520"},{"name":"K80","value":"k80"},{"name":"M60","value":"m60"},{"name":"RadeonProV520","value":"radeon-pro-v520"},{"name":"T4","value":"t4"},{"name":"T4g","value":"t4g"},{"name":"Vu9p","value":"vu9p"},{"name":"V100","value":"v100"},{"name":"L40s","value":"l40s"},{"name":"L4","value":"l4"},{"name":"GaudiHl205","value":"gaudi-hl-205"},{"name":"Inferentia2","value":"inferentia2"},{"name":"Trainium","value":"trainium"},{"name":"Trainium2","value":"trainium2"},{"name":"U30","value":"u30"}]},"aws-native:ec2:Ec2FleetInstanceRequirementsRequestAcceleratorTypesItem":{"type":"string","enum":[{"name":"Gpu","value":"gpu"},{"name":"Fpga","value":"fpga"},{"name":"Inference","value":"inference"},{"name":"Media","value":"media"}]},"aws-native:ec2:Ec2FleetInstanceRequirementsRequestBareMetal":{"description":"Indicates whether bare metal instance types must be included, excluded, or required.\n\n- To include bare metal instance types, specify `included` .\n- To require only bare metal instance types, specify `required` .\n- To exclude bare metal instance types, specify `excluded` .\n\nDefault: `excluded`","type":"string","enum":[{"name":"Included","value":"included"},{"name":"Required","value":"required"},{"name":"Excluded","value":"excluded"}]},"aws-native:ec2:Ec2FleetInstanceRequirementsRequestBurstablePerformance":{"description":"Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) .\n\n- To include burstable performance instance types, specify `included` .\n- To require only burstable performance instance types, specify `required` .\n- To exclude burstable performance instance types, specify `excluded` .\n\nDefault: `excluded`","type":"string","enum":[{"name":"Included","value":"included"},{"name":"Required","value":"required"},{"name":"Excluded","value":"excluded"}]},"aws-native:ec2:Ec2FleetInstanceRequirementsRequestCpuManufacturersItem":{"type":"string","enum":[{"name":"Intel","value":"intel"},{"name":"Amd","value":"amd"},{"name":"AmazonWebServices","value":"amazon-web-services"},{"name":"Apple","value":"apple"}]},"aws-native:ec2:Ec2FleetInstanceRequirementsRequestInstanceGenerationsItem":{"type":"string","enum":[{"name":"Current","value":"current"},{"name":"Previous","value":"previous"}]},"aws-native:ec2:Ec2FleetInstanceRequirementsRequestLocalStorage":{"description":"Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide* .\n\n- To include instance types with instance store volumes, specify `included` .\n- To require only instance types with instance store volumes, specify `required` .\n- To exclude instance types with instance store volumes, specify `excluded` .\n\nDefault: `included`","type":"string","enum":[{"name":"Included","value":"included"},{"name":"Required","value":"required"},{"name":"Excluded","value":"excluded"}]},"aws-native:ec2:Ec2FleetInstanceRequirementsRequestLocalStorageTypesItem":{"type":"string","enum":[{"name":"Hdd","value":"hdd"},{"name":"Ssd","value":"ssd"}]},"aws-native:ec2:Ec2FleetMaintenanceStrategies":{"properties":{"capacityRebalance":{"$ref":"#/types/aws-native:ec2:Ec2FleetCapacityRebalance","description":"The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted."}},"type":"object"},"aws-native:ec2:Ec2FleetMemoryGiBPerVCpuRequest":{"properties":{"max":{"type":"number","description":"The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter."},"min":{"type":"number","description":"The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:Ec2FleetMemoryMiBRequest":{"properties":{"max":{"type":"integer","description":"The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum amount of memory, in MiB. To specify no minimum limit, specify `0` ."}},"type":"object"},"aws-native:ec2:Ec2FleetNetworkBandwidthGbpsRequest":{"properties":{"max":{"type":"number","description":"The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter."},"min":{"type":"number","description":"The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:Ec2FleetNetworkInterfaceCountRequest":{"properties":{"max":{"type":"integer","description":"The maximum number of network interfaces. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum number of network interfaces. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:Ec2FleetOnDemandOptionsRequest":{"properties":{"allocationStrategy":{"type":"string","description":"The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.\n\n`lowest-price` - EC2 Fleet uses price to determine the order, launching the lowest price first.\n\n`prioritized` - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.\n\nDefault: `lowest-price`"},"capacityReservationOptions":{"$ref":"#/types/aws-native:ec2:Ec2FleetCapacityReservationOptionsRequest","description":"The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.\n\nSupported only for fleets of type `instant` ."},"maxTotalPrice":{"type":"string","description":"The maximum amount per hour for On-Demand Instances that you're willing to pay.\n\n\u003e If your fleet includes T instances that are configured as `unlimited` , and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `MaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `MaxTotalPrice` . For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide* ."},"minTargetCapacity":{"type":"integer","description":"The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.\n\nConstraints: Maximum value of `1000` . Supported only for fleets of type `instant` .\n\nAt least one of the following must be specified: `SingleAvailabilityZone` | `SingleInstanceType`"},"singleAvailabilityZone":{"type":"boolean","description":"Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.\n\nSupported only for fleets of type `instant` ."},"singleInstanceType":{"type":"boolean","description":"Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.\n\nSupported only for fleets of type `instant` ."}},"type":"object"},"aws-native:ec2:Ec2FleetPerformanceFactorReferenceRequest":{"properties":{"instanceFamily":{"type":"string","description":"The instance family to use as a baseline reference.\n\n\u003e Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( `.` ) in the instance type name. For example, in the instance type `c6i.large` , the instance family is `c6i` , not `c6` . For more information, see [Amazon EC2 instance type naming conventions](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html) in *Amazon EC2 Instance Types* . \n\nThe following instance families are *not supported* for performance protection:\n\n- `c1`\n- `g3` | `g3s`\n- `hpc7g`\n- `m1` | `m2`\n- `mac1` | `mac2` | `mac2-m1ultra` | `mac2-m2` | `mac2-m2pro`\n- `p3dn` | `p4d` | `p5`\n- `t1`\n- `u-12tb1` | `u-18tb1` | `u-24tb1` | `u-3tb1` | `u-6tb1` | `u-9tb1` | `u7i-12tb` | `u7in-16tb` | `u7in-24tb` | `u7in-32tb`\n\nIf you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.\n\nIf you specify an unsupported instance family as a value for baseline performance, the API returns an empty response response for [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) and an exception for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet.html) , [RequestSpotFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html) , [ModifyFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyFleet.html) , and [ModifySpotFleetRequest](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifySpotFleetRequest.html) ."}},"type":"object"},"aws-native:ec2:Ec2FleetPlacement":{"properties":{"affinity":{"type":"string","description":"The affinity setting for the instance on the Dedicated Host.\n\nThis parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) or [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) ."},"availabilityZone":{"type":"string","description":"The Availability Zone of the instance.\n\nOn input, you can specify `AvailabilityZone` or `AvailabilityZoneId` , but not both. If you specify neither one, Amazon EC2 automatically selects an Availability Zone for you.\n\nThis parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) ."},"groupName":{"type":"string","description":"The name of the placement group that the instance is in.\n\nOn input, you can specify `GroupId` or `GroupName` , but not both."},"hostId":{"type":"string","description":"The ID of the Dedicated Host on which the instance resides.\n\nThis parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) or [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) ."},"hostResourceGroupArn":{"type":"string","description":"The ARN of the host resource group in which to launch the instances.\n\nOn input, if you specify this parameter, either omit the *Tenancy* parameter or set it to `host` .\n\nThis parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) ."},"partitionNumber":{"type":"integer","description":"The number of the partition that the instance is in. Valid only if the placement group strategy is set to `partition` .\n\nThis parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) ."},"spreadDomain":{"type":"string","description":"Reserved for future use."},"tenancy":{"type":"string","description":"The tenancy of the instance. An instance with a tenancy of `dedicated` runs on single-tenant hardware.\n\nThis parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) . The `host` tenancy is not supported for [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) or for T3 instances that are configured for the `unlimited` CPU credit option."}},"type":"object"},"aws-native:ec2:Ec2FleetSpotOptionsRequest":{"properties":{"allocationStrategy":{"$ref":"#/types/aws-native:ec2:Ec2FleetSpotOptionsRequestAllocationStrategy","description":"Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.\n\nIf the allocation strategy is `lowestPrice` , EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.\n\nIf the allocation strategy is `diversified` , EC2 Fleet launches instances from all the Spot Instance pools that you specify.\n\nIf the allocation strategy is `capacityOptimized` , EC2 Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.\n\n*Allowed Values* : `lowestPrice` | `diversified` | `capacityOptimized` | `capacityOptimizedPrioritized`"},"instanceInterruptionBehavior":{"$ref":"#/types/aws-native:ec2:Ec2FleetSpotOptionsRequestInstanceInterruptionBehavior","description":"The behavior when a Spot Instance is interrupted.\n\nDefault: `terminate`"},"instancePoolsToUseCount":{"type":"integer","description":"The number of Spot pools across which to allocate your target Spot capacity. Supported only when Spot `AllocationStrategy` is set to `lowest-price` . EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.\n\nNote that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified."},"maintenanceStrategies":{"$ref":"#/types/aws-native:ec2:Ec2FleetMaintenanceStrategies","description":"The strategies for managing your Spot Instances that are at an elevated risk of being interrupted."},"maxTotalPrice":{"type":"string","description":"The maximum amount per hour for Spot Instances that you're willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n\n\u003e If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter. \u003e If your fleet includes T instances that are configured as `unlimited` , and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `MaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `MaxTotalPrice` . For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide* ."},"minTargetCapacity":{"type":"integer","description":"The minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.\n\nConstraints: Maximum value of `1000` . Supported only for fleets of type `instant` .\n\nAt least one of the following must be specified: `SingleAvailabilityZone` | `SingleInstanceType`"},"singleAvailabilityZone":{"type":"boolean","description":"Indicates that the fleet launches all Spot Instances into a single Availability Zone.\n\nSupported only for fleets of type `instant` ."},"singleInstanceType":{"type":"boolean","description":"Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.\n\nSupported only for fleets of type `instant` ."}},"type":"object"},"aws-native:ec2:Ec2FleetSpotOptionsRequestAllocationStrategy":{"description":"Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.\n\nIf the allocation strategy is `lowestPrice` , EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.\n\nIf the allocation strategy is `diversified` , EC2 Fleet launches instances from all the Spot Instance pools that you specify.\n\nIf the allocation strategy is `capacityOptimized` , EC2 Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.\n\n*Allowed Values* : `lowestPrice` | `diversified` | `capacityOptimized` | `capacityOptimizedPrioritized`","type":"string","enum":[{"name":"LowestPrice","value":"lowest-price"},{"name":"Diversified","value":"diversified"},{"name":"CapacityOptimized","value":"capacityOptimized"},{"name":"CapacityOptimizedPrioritized","value":"capacityOptimizedPrioritized"},{"name":"PriceCapacityOptimized","value":"priceCapacityOptimized"}]},"aws-native:ec2:Ec2FleetSpotOptionsRequestInstanceInterruptionBehavior":{"description":"The behavior when a Spot Instance is interrupted.\n\nDefault: `terminate`","type":"string","enum":[{"name":"Hibernate","value":"hibernate"},{"name":"Stop","value":"stop"},{"name":"Terminate","value":"terminate"}]},"aws-native:ec2:Ec2FleetTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:Ec2FleetTagSpecification":{"properties":{"resourceType":{"$ref":"#/types/aws-native:ec2:Ec2FleetTagSpecificationResourceType","description":"The type of resource to tag."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:Ec2FleetTag"},"description":"The tags to apply to the resource."}},"type":"object"},"aws-native:ec2:Ec2FleetTagSpecificationResourceType":{"description":"The type of resource to tag.","type":"string","enum":[{"name":"ClientVpnEndpoint","value":"client-vpn-endpoint"},{"name":"CustomerGateway","value":"customer-gateway"},{"name":"DedicatedHost","value":"dedicated-host"},{"name":"DhcpOptions","value":"dhcp-options"},{"name":"EgressOnlyInternetGateway","value":"egress-only-internet-gateway"},{"name":"ElasticGpu","value":"elastic-gpu"},{"name":"ElasticIp","value":"elastic-ip"},{"name":"ExportImageTask","value":"export-image-task"},{"name":"ExportInstanceTask","value":"export-instance-task"},{"name":"Fleet","value":"fleet"},{"name":"FpgaImage","value":"fpga-image"},{"name":"HostReservation","value":"host-reservation"},{"name":"Image","value":"image"},{"name":"ImportImageTask","value":"import-image-task"},{"name":"ImportSnapshotTask","value":"import-snapshot-task"},{"name":"Instance","value":"instance"},{"name":"InternetGateway","value":"internet-gateway"},{"name":"KeyPair","value":"key-pair"},{"name":"LaunchTemplate","value":"launch-template"},{"name":"LocalGatewayRouteTableVpcAssociation","value":"local-gateway-route-table-vpc-association"},{"name":"Natgateway","value":"natgateway"},{"name":"NetworkAcl","value":"network-acl"},{"name":"NetworkInsightsAnalysis","value":"network-insights-analysis"},{"name":"NetworkInsightsPath","value":"network-insights-path"},{"name":"NetworkInterface","value":"network-interface"},{"name":"PlacementGroup","value":"placement-group"},{"name":"ReservedInstances","value":"reserved-instances"},{"name":"RouteTable","value":"route-table"},{"name":"SecurityGroup","value":"security-group"},{"name":"Snapshot","value":"snapshot"},{"name":"SpotFleetRequest","value":"spot-fleet-request"},{"name":"SpotInstancesRequest","value":"spot-instances-request"},{"name":"Subnet","value":"subnet"},{"name":"TrafficMirrorFilter","value":"traffic-mirror-filter"},{"name":"TrafficMirrorSession","value":"traffic-mirror-session"},{"name":"TrafficMirrorTarget","value":"traffic-mirror-target"},{"name":"TransitGateway","value":"transit-gateway"},{"name":"TransitGatewayAttachment","value":"transit-gateway-attachment"},{"name":"TransitGatewayConnectPeer","value":"transit-gateway-connect-peer"},{"name":"TransitGatewayMulticastDomain","value":"transit-gateway-multicast-domain"},{"name":"TransitGatewayRouteTable","value":"transit-gateway-route-table"},{"name":"Volume","value":"volume"},{"name":"Vpc","value":"vpc"},{"name":"VpcFlowLog","value":"vpc-flow-log"},{"name":"VpcPeeringConnection","value":"vpc-peering-connection"},{"name":"VpnConnection","value":"vpn-connection"},{"name":"VpnGateway","value":"vpn-gateway"}]},"aws-native:ec2:Ec2FleetTargetCapacitySpecificationRequest":{"properties":{"defaultTargetCapacityType":{"$ref":"#/types/aws-native:ec2:Ec2FleetTargetCapacitySpecificationRequestDefaultTargetCapacityType","description":"The default target capacity type.","replaceOnChanges":true},"onDemandTargetCapacity":{"type":"integer","description":"The number of On-Demand units to request."},"spotTargetCapacity":{"type":"integer","description":"The number of Spot units to request."},"targetCapacityUnitType":{"$ref":"#/types/aws-native:ec2:Ec2FleetTargetCapacitySpecificationRequestTargetCapacityUnitType","description":"The unit for the target capacity. You can specify this parameter only when using attributed-based instance type selection.\n\nDefault: `units` (the number of instances)","replaceOnChanges":true},"totalTargetCapacity":{"type":"integer","description":"The number of units to request, filled using the default target capacity type."}},"type":"object","required":["totalTargetCapacity"]},"aws-native:ec2:Ec2FleetTargetCapacitySpecificationRequestDefaultTargetCapacityType":{"description":"The default target capacity type.","type":"string","enum":[{"name":"OnDemand","value":"on-demand"},{"name":"Spot","value":"spot"}]},"aws-native:ec2:Ec2FleetTargetCapacitySpecificationRequestTargetCapacityUnitType":{"description":"The unit for the target capacity. You can specify this parameter only when using attributed-based instance type selection.\n\nDefault: `units` (the number of instances)","type":"string","enum":[{"name":"Vcpu","value":"vcpu"},{"name":"MemoryMib","value":"memory-mib"},{"name":"Units","value":"units"}]},"aws-native:ec2:Ec2FleetTotalLocalStorageGbRequest":{"properties":{"max":{"type":"number","description":"The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter."},"min":{"type":"number","description":"The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:Ec2FleetType":{"description":"The fleet type. The default value is `maintain` .\n\n- `maintain` - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.\n- `request` - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.\n- `instant` - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.\n\nFor more information, see [EC2 Fleet request types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html) in the *Amazon EC2 User Guide* .","type":"string","enum":[{"name":"Maintain","value":"maintain"},{"name":"Request","value":"request"},{"name":"Instant","value":"instant"}]},"aws-native:ec2:Ec2FleetVCpuCountRangeRequest":{"properties":{"max":{"type":"integer","description":"The maximum number of vCPUs. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum number of vCPUs. To specify no minimum limit, specify `0` ."}},"type":"object"},"aws-native:ec2:EgressOnlyInternetGatewayTag":{"properties":{"key":{"type":"string","description":"The key of the tag.\n\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with `aws:` ."},"value":{"type":"string","description":"The value of the tag.\n\nConstraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters."}},"type":"object","required":["key","value"]},"aws-native:ec2:EipTag":{"description":"Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:EnclaveOptionsProperties":{"description":"Indicates whether the instance is enabled for AWS Nitro Enclaves.","properties":{"enabled":{"type":"boolean","description":"If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves."}},"type":"object"},"aws-native:ec2:FlowLogDestinationOptionsPropertiesFileFormat":{"description":"The format for the flow log. The default is `plain-text` .","type":"string","enum":[{"name":"PlainText","value":"plain-text"},{"name":"Parquet","value":"parquet"}]},"aws-native:ec2:FlowLogLogDestinationType":{"description":"Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3.","type":"string","enum":[{"name":"CloudWatchLogs","value":"cloud-watch-logs"},{"name":"S3","value":"s3"},{"name":"KinesisDataFirehose","value":"kinesis-data-firehose"}]},"aws-native:ec2:FlowLogResourceType":{"description":"The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.","type":"string","enum":[{"name":"NetworkInterface","value":"NetworkInterface"},{"name":"Subnet","value":"Subnet"},{"name":"Vpc","value":"VPC"},{"name":"TransitGateway","value":"TransitGateway"},{"name":"TransitGatewayAttachment","value":"TransitGatewayAttachment"},{"name":"RegionalNatGateway","value":"RegionalNatGateway"}]},"aws-native:ec2:FlowLogTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:FlowLogTrafficType":{"description":"The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.","type":"string","enum":[{"name":"Accept","value":"ACCEPT"},{"name":"All","value":"ALL"},{"name":"Reject","value":"REJECT"}]},"aws-native:ec2:HibernationOptionsProperties":{"description":"Indicates whether an instance is enabled for hibernation.","properties":{"configured":{"type":"boolean","description":"If you set this parameter to true, your instance is enabled for hibernation."}},"type":"object"},"aws-native:ec2:HostAutoPlacement":{"description":"Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.","type":"string","enum":[{"name":"On","value":"on"},{"name":"Off","value":"off"}]},"aws-native:ec2:HostMaintenance":{"description":"Automatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.","type":"string","enum":[{"name":"On","value":"on"},{"name":"Off","value":"off"}]},"aws-native:ec2:HostRecovery":{"description":"Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.","type":"string","enum":[{"name":"On","value":"on"},{"name":"Off","value":"off"}]},"aws-native:ec2:HostTag":{"properties":{"key":{"type":"string","description":"The key of the tag.\n\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with `aws:` ."},"value":{"type":"string","description":"The value of the tag.\n\nConstraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters."}},"type":"object","required":["key","value"]},"aws-native:ec2:InstanceAffinity":{"description":"Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default.","type":"string","enum":[{"name":"Default","value":"default"},{"name":"Host","value":"host"}]},"aws-native:ec2:InstanceAssociationParameter":{"properties":{"key":{"type":"string","description":"The name of an input parameter that is in the associated SSM document."},"value":{"type":"array","items":{"type":"string"},"description":"The value of an input parameter."}},"type":"object","required":["key","value"]},"aws-native:ec2:InstanceBlockDeviceMapping":{"properties":{"deviceName":{"type":"string","description":"The device name (for example, /dev/sdh or xvdh)."},"ebs":{"$ref":"#/types/aws-native:ec2:InstanceEbs","description":"Parameters used to automatically set up EBS volumes when the instance is launched."},"noDevice":{"$ref":"pulumi.json#/Any","description":"To omit the device from the block device mapping, specify an empty string.\n\n\u003e After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ."},"virtualName":{"type":"string","description":"The virtual device name ( `ephemeral` N). The name must be in the form `ephemeral` *X* where *X* is a number starting from zero (0). For example, an instance type with 2 available instance store volumes can specify mappings for `ephemeral0` and `ephemeral1` . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.\n\nNVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.\n\n*Constraints* : For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.\n\n\u003e After the instance is running, modifying this parameter results in instance [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ."}},"type":"object","required":["deviceName"]},"aws-native:ec2:InstanceConnectEndpointTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:InstanceEbs":{"properties":{"deleteOnTermination":{"type":"boolean","description":"Indicates whether the EBS volume is deleted on instance termination."},"encrypted":{"type":"boolean","description":"Indicates whether the volume should be encrypted."},"iops":{"type":"integer","description":"The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting."},"kmsKeyId":{"type":"string","description":"The identifier of the AWS Key Management Service (AWS KMS) customer managed CMK to use for Amazon EBS encryption. If KmsKeyId is specified, the encrypted state must be true. If the encrypted state is true but you do not specify KmsKeyId, your AWS managed CMK for EBS is used."},"snapshotId":{"type":"string","description":"The ID of the snapshot."},"volumeSize":{"type":"integer","description":"The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size."},"volumeType":{"type":"string","description":"The volume type."}},"type":"object"},"aws-native:ec2:InstanceElasticGpuSpecification":{"properties":{"type":{"type":"string","description":"The type of Elastic Graphics accelerator. Amazon Elastic Graphics is no longer available."}},"type":"object","required":["type"]},"aws-native:ec2:InstanceElasticInferenceAccelerator":{"properties":{"count":{"type":"integer","description":"The number of elastic inference accelerators to attach to the instance. Amazon Elastic Inference is no longer available."},"type":{"type":"string","description":"The type of elastic inference accelerator. Amazon Elastic Inference is no longer available."}},"type":"object","required":["type"]},"aws-native:ec2:InstanceEnaSrdSpecification":{"description":"Specifies the ENA Express settings for the network interface that's attached to the instance.","properties":{"enaSrdEnabled":{"type":"boolean","description":"Specifies whether ENA Express is enabled for the network interface when you launch an instance."},"enaSrdUdpSpecification":{"$ref":"#/types/aws-native:ec2:InstanceEnaSrdUdpSpecification","description":"Configures ENA Express for UDP network traffic."}},"type":"object"},"aws-native:ec2:InstanceEnaSrdUdpSpecification":{"description":"Contains ENA Express settings for UDP network traffic for the network interface that's attached to the instance.","properties":{"enaSrdUdpEnabled":{"type":"boolean","description":"Indicates whether UDP traffic uses ENA Express for your instance."}},"type":"object"},"aws-native:ec2:InstanceIpv6Address":{"properties":{"ipv6Address":{"type":"string","description":"The IPv6 address."}},"type":"object","required":["ipv6Address"]},"aws-native:ec2:InstanceLaunchTemplateSpecification":{"properties":{"launchTemplateId":{"type":"string","description":"The ID of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both."},"launchTemplateName":{"type":"string","description":"The name of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both."},"version":{"type":"string","description":"The version number of the launch template."}},"type":"object"},"aws-native:ec2:InstanceLicenseSpecification":{"properties":{"licenseConfigurationArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the license configuration."}},"type":"object","required":["licenseConfigurationArn"]},"aws-native:ec2:InstanceMetadataOptions":{"properties":{"httpEndpoint":{"$ref":"#/types/aws-native:ec2:InstanceMetadataOptionsHttpEndpoint","description":"Enables or disables the HTTP metadata endpoint on your instances. If you specify a value of disabled, you cannot access your instance metadata."},"httpProtocolIpv6":{"$ref":"#/types/aws-native:ec2:InstanceMetadataOptionsHttpProtocolIpv6","description":"Enables or disables the IPv6 endpoint for the instance metadata service. To use this option, the instance must be a Nitro-based instance launched in a subnet that supports IPv6."},"httpPutResponseHopLimit":{"type":"integer","description":"The number of network hops that the metadata token can travel. Maximum is 64."},"httpTokens":{"$ref":"#/types/aws-native:ec2:InstanceMetadataOptionsHttpTokens","description":"Indicates whether IMDSv2 is required."},"instanceMetadataTags":{"$ref":"#/types/aws-native:ec2:InstanceMetadataOptionsInstanceMetadataTags","description":"Indicates whether tags from the instance are propagated to the EBS volumes."}},"type":"object"},"aws-native:ec2:InstanceMetadataOptionsHttpEndpoint":{"description":"Enables or disables the HTTP metadata endpoint on your instances. If you specify a value of disabled, you cannot access your instance metadata.","type":"string","enum":[{"name":"Disabled","value":"disabled"},{"name":"Enabled","value":"enabled"}]},"aws-native:ec2:InstanceMetadataOptionsHttpProtocolIpv6":{"description":"Enables or disables the IPv6 endpoint for the instance metadata service. To use this option, the instance must be a Nitro-based instance launched in a subnet that supports IPv6.","type":"string","enum":[{"name":"Disabled","value":"disabled"},{"name":"Enabled","value":"enabled"}]},"aws-native:ec2:InstanceMetadataOptionsHttpTokens":{"description":"Indicates whether IMDSv2 is required.","type":"string","enum":[{"name":"Optional","value":"optional"},{"name":"Required","value":"required"}]},"aws-native:ec2:InstanceMetadataOptionsInstanceMetadataTags":{"description":"Indicates whether tags from the instance are propagated to the EBS volumes.","type":"string","enum":[{"name":"Disabled","value":"disabled"},{"name":"Enabled","value":"enabled"}]},"aws-native:ec2:InstanceNetworkInterface":{"properties":{"associateCarrierIpAddress":{"type":"boolean","description":"Not currently supported by AWS CloudFormation."},"associatePublicIpAddress":{"type":"boolean","description":"Indicates whether to assign a public IPv4 address to an instance you launch in a VPC."},"deleteOnTermination":{"type":"boolean","description":"If set to true, the interface is deleted when the instance is terminated."},"description":{"type":"string","description":"The description of the network interface."},"deviceIndex":{"type":"string","description":"The position of the network interface in the attachment order. A primary network interface has a device index of 0."},"enaSrdSpecification":{"$ref":"#/types/aws-native:ec2:InstanceEnaSrdSpecification","description":"Configures ENA Express for UDP network traffic."},"groupSet":{"type":"array","items":{"type":"string"},"description":"The IDs of the security groups for the network interface."},"ipv6AddressCount":{"type":"integer","description":"A number of IPv6 addresses to assign to the network interface."},"ipv6Addresses":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:InstanceIpv6Address"},"description":"The IPv6 addresses associated with the network interface."},"networkInterfaceId":{"type":"string","description":"The ID of the network interface."},"privateIpAddress":{"type":"string","description":"The private IPv4 address of the network interface."},"privateIpAddresses":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:InstancePrivateIpAddressSpecification"},"description":"One or more private IPv4 addresses to assign to the network interface."},"secondaryPrivateIpAddressCount":{"type":"integer","description":"The number of secondary private IPv4 addresses."},"subnetId":{"type":"string","description":"The ID of the subnet."}},"type":"object","required":["deviceIndex"]},"aws-native:ec2:InstancePrivateDnsNameOptions":{"properties":{"enableResourceNameDnsARecord":{"type":"boolean","description":"Indicates whether to respond to DNS queries for instance hostnames with DNS A records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide."},"enableResourceNameDnsAaaaRecord":{"type":"boolean","description":"Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide."},"hostnameType":{"$ref":"#/types/aws-native:ec2:InstancePrivateDnsNameOptionsHostnameType","description":"The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide."}},"type":"object"},"aws-native:ec2:InstancePrivateDnsNameOptionsHostnameType":{"description":"The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide.","type":"string","enum":[{"name":"IpName","value":"ip-name"},{"name":"ResourceName","value":"resource-name"}]},"aws-native:ec2:InstancePrivateIpAddressSpecification":{"properties":{"primary":{"type":"boolean","description":"Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary."},"privateIpAddress":{"type":"string","description":"The private IPv4 addresses."}},"type":"object","required":["primary","privateIpAddress"]},"aws-native:ec2:InstanceSsmAssociation":{"properties":{"associationParameters":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:InstanceAssociationParameter"},"description":"The input parameter values to use with the associated SSM document."},"documentName":{"type":"string","description":"The name of an SSM document to associate with the instance."}},"type":"object","required":["documentName"]},"aws-native:ec2:InstanceState":{"description":"The current state of the instance","properties":{"code":{"type":"string","description":"The state of the instance as a 16-bit unsigned integer."},"name":{"type":"string","description":"The current state of the instance."}},"type":"object"},"aws-native:ec2:InstanceTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:InstanceVolume":{"properties":{"device":{"type":"string","description":"The device name (for example, /dev/sdh or xvdh)."},"volumeId":{"type":"string","description":"The ID of the EBS volume. The volume and instance must be within the same Availability Zone."}},"type":"object","required":["device","volumeId"]},"aws-native:ec2:InternetGatewayTag":{"description":"Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:IpamMeteredAccount":{"description":"A metered account is an account that is charged for active IP addresses managed in IPAM","type":"string","enum":[{"name":"IpamOwner","value":"ipam-owner"},{"name":"ResourceOwner","value":"resource-owner"}]},"aws-native:ec2:IpamOperatingRegion":{"description":"The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring","properties":{"regionName":{"type":"string","description":"The name of the region."}},"type":"object","required":["regionName"]},"aws-native:ec2:IpamOrganizationalUnitExclusion":{"description":"If your IPAM is integrated with AWS Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.","properties":{"organizationsEntityPath":{"type":"string","description":"An AWS Organizations entity path. Build the path for the OU(s) using AWS Organizations IDs separated by a '/'. Include all child OUs by ending the path with '/*'."}},"type":"object","required":["organizationsEntityPath"]},"aws-native:ec2:IpamPoolAwsService":{"description":"Limits which service in Amazon Web Services that the pool can be used in.","type":"string","enum":[{"name":"Ec2","value":"ec2"},{"name":"GlobalServices","value":"global-services"}]},"aws-native:ec2:IpamPoolIpamScopeType":{"description":"Determines whether this scope contains publicly routable space or space for a private network","type":"string","enum":[{"name":"Public","value":"public"},{"name":"Private","value":"private"}]},"aws-native:ec2:IpamPoolProvisionedCidr":{"description":"An address space to be inserted into this pool. All allocations must be made from this address space.","properties":{"cidr":{"type":"string","description":"The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is `10.24.34.0/23` . An IPv6 CIDR example is `2001:DB8::/32` ."}},"type":"object","required":["cidr"]},"aws-native:ec2:IpamPoolPublicIpSource":{"description":"The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`.","type":"string","enum":[{"name":"Byoip","value":"byoip"},{"name":"Amazon","value":"amazon"}]},"aws-native:ec2:IpamPoolSourceResource":{"description":"The resource associated with this pool's space. Depending on the ResourceType, setting a SourceResource changes which space can be provisioned in this pool and which types of resources can receive allocations","properties":{"resourceId":{"type":"string","description":"The source resource ID."},"resourceOwner":{"type":"string","description":"The source resource owner."},"resourceRegion":{"type":"string","description":"The source resource Region."},"resourceType":{"type":"string","description":"The source resource type."}},"type":"object","required":["resourceId","resourceOwner","resourceRegion","resourceType"]},"aws-native:ec2:IpamPoolState":{"description":"The state of this pool. This can be one of the following values: \"create-in-progress\", \"create-complete\", \"modify-in-progress\", \"modify-complete\", \"delete-in-progress\", or \"delete-complete\"","type":"string","enum":[{"name":"CreateInProgress","value":"create-in-progress"},{"name":"CreateComplete","value":"create-complete"},{"name":"ModifyInProgress","value":"modify-in-progress"},{"name":"ModifyComplete","value":"modify-complete"},{"name":"DeleteInProgress","value":"delete-in-progress"},{"name":"DeleteComplete","value":"delete-complete"}]},"aws-native:ec2:IpamPoolTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:IpamPrefixListResolverRule":{"description":"CIDR selection rules define the business logic for selecting CIDRs from IPAM.  If a CIDR matches any of the rules, it will be included. If a rule has multiple conditions, the CIDR has to match every condition of that rule. You can create a prefix list resolver without rules, but you'll need to add at least one rule before it can actually automate your prefix list updates.","properties":{"conditions":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:IpamPrefixListResolverRuleCondition"},"description":"Two of the rule types allow you to add conditions to the rules. (1) For IPAM Pool CIDR rules, you can specify an ipamPoolId; if not specified, the rule will apply to all IPAM Pool CIDRs in the scope.  (2) For IPAM Resource CIDR rules, you can specify resourceId, resourceOwner, resourceRegion, cidr, or resourceTag."},"ipamScopeId":{"type":"string","description":"This rule will only match resources that are in this IPAM Scope."},"resourceType":{"$ref":"#/types/aws-native:ec2:IpamPrefixListResolverRuleResourceType","description":"The resourceType property only applies to ipam-resource-cidr rules; this property specifies what type of resources this rule will apply to, such as VPCs or Subnets."},"ruleType":{"$ref":"#/types/aws-native:ec2:IpamPrefixListResolverRuleRuleType","description":"There are three rule types: (1) Static CIDR: A fixed list of CIDRs that don't change (like a manual list replicated across Regions). (2) IPAM pool CIDR: CIDRs from specific IPAM pools (like all CIDRs from your IPAM production pool).  (3) IPAM resource CIDR: CIDRs for AWS resources like VPCs, subnets, and EIPs within a specific IPAM scope."},"staticCidr":{"type":"string","description":"A fixed CIDR that doesn't change"}},"type":"object","required":["ruleType"]},"aws-native:ec2:IpamPrefixListResolverRuleCondition":{"description":"Two of the rule types allow you to add conditions to the rules. (1) For IPAM Pool CIDR rules, you can specify an ipamPoolId; if not specified, the rule will apply to all IPAM Pool CIDRs in the scope.  (2) For IPAM Resource CIDR rules, you can specify resourceId, resourceOwner, resourceRegion, cidr, or resourceTag.","properties":{"cidr":{"type":"string","description":"Condition for the IPAM Resource CIDR rule type.  CIDR (like 10.24.34.0/23)."},"ipamPoolId":{"type":"string","description":"Condition for the IPAM Pool CIDR rule type.  If not chosen, the resolver applies to all IPAM Pool CIDRs in the scope."},"operation":{"$ref":"#/types/aws-native:ec2:IpamPrefixListResolverRuleConditionOperation","description":"Equals, Not equals, or Subnet Of.  The subnet-of operation only applies to cidr conditions."},"resourceId":{"type":"string","description":"Condition for the IPAM Resource CIDR rule type.  The unique ID of a resource (like vpc-1234567890abcdef0)."},"resourceOwner":{"type":"string","description":"Condition for the IPAM Resource CIDR rule type.  Resource owner (like 111122223333)."},"resourceRegion":{"type":"string","description":"Condition for the IPAM Resource CIDR rule type.  Resource region (like us-east-1)."},"resourceTag":{"$ref":"#/types/aws-native:ec2:IpamPrefixListResolverTag","description":"Condition for the IPAM Resource CIDR rule type.  Resource Tag (like dev-vpc-1)."}},"type":"object"},"aws-native:ec2:IpamPrefixListResolverRuleConditionOperation":{"description":"Equals, Not equals, or Subnet Of.  The subnet-of operation only applies to cidr conditions.","type":"string","enum":[{"name":"Equals","value":"equals"},{"name":"NotEquals","value":"not-equals"},{"name":"SubnetOf","value":"subnet-of"}]},"aws-native:ec2:IpamPrefixListResolverRuleResourceType":{"description":"The resourceType property only applies to ipam-resource-cidr rules; this property specifies what type of resources this rule will apply to, such as VPCs or Subnets.","type":"string","enum":[{"name":"Vpc","value":"vpc"},{"name":"Subnet","value":"subnet"},{"name":"Eip","value":"eip"},{"name":"PublicIpv4Pool","value":"public-ipv4-pool"}]},"aws-native:ec2:IpamPrefixListResolverRuleRuleType":{"description":"There are three rule types: (1) Static CIDR: A fixed list of CIDRs that don't change (like a manual list replicated across Regions). (2) IPAM pool CIDR: CIDRs from specific IPAM pools (like all CIDRs from your IPAM production pool).  (3) IPAM resource CIDR: CIDRs for AWS resources like VPCs, subnets, and EIPs within a specific IPAM scope.","type":"string","enum":[{"name":"StaticCidr","value":"static-cidr"},{"name":"IpamResourceCidr","value":"ipam-resource-cidr"},{"name":"IpamPoolCidr","value":"ipam-pool-cidr"}]},"aws-native:ec2:IpamPrefixListResolverTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:IpamResourceDiscoveryAssociationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:IpamResourceDiscoveryIpamOperatingRegion":{"description":"The regions IPAM Resource Discovery is enabled for. Allows for monitoring.","properties":{"regionName":{"type":"string","description":"The name of the region."}},"type":"object","required":["regionName"]},"aws-native:ec2:IpamResourceDiscoveryOrganizationalUnitExclusion":{"description":"If your IPAM is integrated with AWS Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.","properties":{"organizationsEntityPath":{"type":"string","description":"An AWS Organizations entity path. Build the path for the OU(s) using AWS Organizations IDs separated by a '/'. Include all child OUs by ending the path with '/*'."}},"type":"object","required":["organizationsEntityPath"]},"aws-native:ec2:IpamResourceDiscoveryTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:IpamScopeExternalAuthorityConfiguration":{"description":"External service configuration to connect your AWS IPAM scope.","properties":{"externalResourceIdentifier":{"type":"string","description":"Resource identifier of the scope in the external service connecting to your AWS IPAM scope."},"ipamScopeExternalAuthorityType":{"$ref":"#/types/aws-native:ec2:IpamScopeExternalAuthorityConfigurationIpamScopeExternalAuthorityType","description":"An external service connecting to your AWS IPAM scope."}},"type":"object","required":["externalResourceIdentifier","ipamScopeExternalAuthorityType"]},"aws-native:ec2:IpamScopeExternalAuthorityConfigurationIpamScopeExternalAuthorityType":{"description":"An external service connecting to your AWS IPAM scope.","type":"string","enum":[{"name":"Infoblox","value":"infoblox"}]},"aws-native:ec2:IpamScopeTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:IpamScopeType":{"description":"Determines whether this scope contains publicly routable space or space for a private network","type":"string","enum":[{"name":"Public","value":"public"},{"name":"Private","value":"private"}]},"aws-native:ec2:IpamTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:IpamTier":{"description":"The tier of the IPAM.","type":"string","enum":[{"name":"Free","value":"free"},{"name":"Advanced","value":"advanced"}]},"aws-native:ec2:KeyPairKeyFormat":{"description":"The format of the key pair.\n Default: ``pem``","type":"string","enum":[{"name":"Pem","value":"pem"},{"name":"Ppk","value":"ppk"}]},"aws-native:ec2:KeyPairKeyType":{"description":"The type of key pair. Note that ED25519 keys are not supported for Windows instances.\n If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value.\n Default: ``rsa``","type":"string","enum":[{"name":"Rsa","value":"rsa"},{"name":"Ed25519","value":"ed25519"}]},"aws-native:ec2:KeyPairTag":{"description":"Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:LaunchTemplateAcceleratorCount":{"description":"The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.","properties":{"max":{"type":"integer","description":"The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set ``Max`` to ``0``."},"min":{"type":"integer","description":"The minimum number of accelerators. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:LaunchTemplateAcceleratorTotalMemoryMiB":{"description":"The minimum and maximum amount of total accelerator memory, in MiB.","properties":{"max":{"type":"integer","description":"The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:LaunchTemplateBaselineEbsBandwidthMbps":{"description":"The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.","properties":{"max":{"type":"integer","description":"The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:LaunchTemplateBaselinePerformanceFactors":{"description":"The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application.\n Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying ``c6i`` would use the CPU performance of the ``c6i`` family as the baseline reference.","properties":{"cpu":{"$ref":"#/types/aws-native:ec2:LaunchTemplateCpu","description":"The CPU performance to consider, using an instance family as the baseline reference."}},"type":"object"},"aws-native:ec2:LaunchTemplateBlockDeviceMapping":{"description":"Specifies a block device mapping for a launch template. You must specify ``DeviceName`` plus exactly one of the following properties: ``Ebs``, ``NoDevice``, or ``VirtualName``.\n ``BlockDeviceMapping`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"deviceName":{"type":"string","description":"The device name (for example, /dev/sdh or xvdh)."},"ebs":{"$ref":"#/types/aws-native:ec2:LaunchTemplateEbs","description":"Parameters used to automatically set up EBS volumes when the instance is launched."},"noDevice":{"type":"string","description":"To omit the device from the block device mapping, specify an empty string."},"virtualName":{"type":"string","description":"The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume."}},"type":"object"},"aws-native:ec2:LaunchTemplateCapacityReservationSpecification":{"description":"Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.\n ``CapacityReservationSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"capacityReservationPreference":{"type":"string","description":"Indicates the instance's Capacity Reservation preferences. Possible preferences include:\n  +  ``capacity-reservations-only`` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch.\n  +  ``open`` - The instance can run in any ``open`` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy).\n  +  ``none`` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity."},"capacityReservationTarget":{"$ref":"#/types/aws-native:ec2:LaunchTemplateCapacityReservationTarget","description":"Information about the target Capacity Reservation or Capacity Reservation group."}},"type":"object"},"aws-native:ec2:LaunchTemplateCapacityReservationTarget":{"description":"Specifies a target Capacity Reservation.\n ``CapacityReservationTarget`` is a property of the [Amazon EC2 LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) property type.","properties":{"capacityReservationId":{"type":"string","description":"The ID of the Capacity Reservation in which to run the instance."},"capacityReservationResourceGroupArn":{"type":"string","description":"The ARN of the Capacity Reservation resource group in which to run the instance."}},"type":"object"},"aws-native:ec2:LaunchTemplateConnectionTrackingSpecification":{"description":"A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User Guide*.","properties":{"tcpEstablishedTimeout":{"type":"integer","description":"Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds."},"udpStreamTimeout":{"type":"integer","description":"Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds."},"udpTimeout":{"type":"integer","description":"Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds."}},"type":"object"},"aws-native:ec2:LaunchTemplateCpu":{"description":"Specifies the CPU performance to consider when using an instance family as the baseline reference.","properties":{"references":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:LaunchTemplateReference"},"description":"The instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes are compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences."}},"type":"object"},"aws-native:ec2:LaunchTemplateCpuOptions":{"description":"Specifies the CPU options for an instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *User Guide*.\n ``CpuOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"amdSevSnp":{"$ref":"#/types/aws-native:ec2:LaunchTemplateCpuOptionsAmdSevSnp","description":"Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html)."},"coreCount":{"type":"integer","description":"The number of CPU cores for the instance."},"threadsPerCore":{"type":"integer","description":"The number of threads per CPU core. To disable multithreading for the instance, specify a value of ``1``. Otherwise, specify the default value of ``2``."}},"type":"object"},"aws-native:ec2:LaunchTemplateCpuOptionsAmdSevSnp":{"description":"Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html).","type":"string","enum":[{"name":"Enabled","value":"enabled"},{"name":"Disabled","value":"disabled"}]},"aws-native:ec2:LaunchTemplateCreditSpecification":{"description":"Specifies the credit option for CPU usage of a T2, T3, or T3a instance.\n ``CreditSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"cpuCredits":{"type":"string","description":"The credit option for CPU usage of a T instance.\n Valid values: ``standard`` | ``unlimited``"}},"type":"object"},"aws-native:ec2:LaunchTemplateData":{"description":"The information to include in the launch template.\n  You must specify at least one parameter for the launch template data.","properties":{"blockDeviceMappings":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:LaunchTemplateBlockDeviceMapping"},"description":"The block device mapping."},"capacityReservationSpecification":{"$ref":"#/types/aws-native:ec2:LaunchTemplateCapacityReservationSpecification","description":"The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to ``open``, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone)."},"cpuOptions":{"$ref":"#/types/aws-native:ec2:LaunchTemplateCpuOptions","description":"The CPU options for the instance. For more information, see [CPU options for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon EC2 User Guide*."},"creditSpecification":{"$ref":"#/types/aws-native:ec2:LaunchTemplateCreditSpecification","description":"The credit option for CPU usage of the instance. Valid only for T instances."},"disableApiStop":{"type":"boolean","description":"Indicates whether to enable the instance for stop protection. For more information, see [Enable stop protection for your EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html) in the *Amazon EC2 User Guide*."},"disableApiTermination":{"type":"boolean","description":"Indicates whether termination protection is enabled for the instance. The default is ``false``, which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped."},"ebsOptimized":{"type":"boolean","description":"Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance."},"enclaveOptions":{"$ref":"#/types/aws-native:ec2:LaunchTemplateEnclaveOptions","description":"Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the *Nitro Enclaves User Guide*.\n You can't enable AWS Nitro Enclaves and hibernation on the same instance."},"hibernationOptions":{"$ref":"#/types/aws-native:ec2:LaunchTemplateHibernationOptions","description":"Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*."},"iamInstanceProfile":{"$ref":"#/types/aws-native:ec2:LaunchTemplateIamInstanceProfile","description":"The name or Amazon Resource Name (ARN) of an IAM instance profile."},"imageId":{"type":"string","description":"The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.\n Valid formats:\n  +   ``ami-0ac394d6a3example`` \n  +   ``resolve:ssm:parameter-name`` \n  +   ``resolve:ssm:parameter-name:version-number`` \n  +   ``resolve:ssm:parameter-name:label`` \n  \n For more information, see [Use a Systems Manager parameter to find an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI) in the *Amazon Elastic Compute Cloud User Guide*."},"instanceInitiatedShutdownBehavior":{"type":"string","description":"Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).\n Default: ``stop``"},"instanceMarketOptions":{"$ref":"#/types/aws-native:ec2:LaunchTemplateInstanceMarketOptions","description":"The market (purchasing) option for the instances."},"instanceRequirements":{"$ref":"#/types/aws-native:ec2:LaunchTemplateInstanceRequirements","description":"The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n  +  ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n  +  ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n  \n  If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html)AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n  For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*."},"instanceType":{"type":"string","description":"The instance type. For more information, see [Amazon EC2 instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.\n If you specify ``InstanceType``, you can't specify ``InstanceRequirements``."},"kernelId":{"type":"string","description":"The ID of the kernel.\n We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User Provided Kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*."},"keyName":{"type":"string","description":"The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html).\n  If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in."},"licenseSpecifications":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:LaunchTemplateLicenseSpecification"},"description":"The license configurations."},"maintenanceOptions":{"$ref":"#/types/aws-native:ec2:LaunchTemplateMaintenanceOptions","description":"The maintenance options of your instance."},"metadataOptions":{"$ref":"#/types/aws-native:ec2:LaunchTemplateMetadataOptions","description":"The metadata options for the instance. For more information, see [Configure the Instance Metadata Service options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html) in the *Amazon EC2 User Guide*."},"monitoring":{"$ref":"#/types/aws-native:ec2:LaunchTemplateMonitoring","description":"The monitoring for the instance."},"networkInterfaces":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:LaunchTemplateNetworkInterface"},"description":"The network interfaces for the instance."},"networkPerformanceOptions":{"$ref":"#/types/aws-native:ec2:LaunchTemplateNetworkPerformanceOptions","description":"The settings for the network performance options for the instance. For more information, see [EC2 instance bandwidth weighting configuration](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-bandwidth-weighting.html)."},"placement":{"$ref":"#/types/aws-native:ec2:LaunchTemplatePlacement","description":"The placement for the instance."},"privateDnsNameOptions":{"$ref":"#/types/aws-native:ec2:LaunchTemplatePrivateDnsNameOptions","description":"The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*."},"ramDiskId":{"type":"string","description":"The ID of the RAM disk.\n  We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*."},"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The IDs of the security groups. You can specify the IDs of existing security groups and references to resources created by the stack template.\n If you specify a network interface, you must specify any security groups as part of the network interface instead."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"The names of the security groups. For a nondefault VPC, you must use security group IDs instead.\n If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter."},"tagSpecifications":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:TagSpecification"},"description":"The tags to apply to resources that are created during instance launch.\n To tag the launch template itself, use [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#cfn-ec2-launchtemplate-tagspecifications)."},"userData":{"type":"string","description":"The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands when you launch an EC2 instance with user data input](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) in the *Amazon EC2 User Guide*.\n If you are creating the launch template for use with BATCH, the user data must be provided in the [MIME multi-part archive format](https://docs.aws.amazon.com/https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html#lt-user-data) in the *User Guide*."}},"type":"object"},"aws-native:ec2:LaunchTemplateEbs":{"description":"Parameters for a block device for an EBS volume in an Amazon EC2 launch template.\n ``Ebs`` is a property of [AWS::EC2::LaunchTemplate BlockDeviceMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html).","properties":{"deleteOnTermination":{"type":"boolean","description":"Indicates whether the EBS volume is deleted on instance termination."},"ebsCardIndex":{"type":"integer"},"encrypted":{"type":"boolean","description":"Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value."},"iops":{"type":"integer","description":"The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The following are the supported values for each volume type:\n  +  ``gp3``: 3,000 - 80,000 IOPS\n  +  ``io1``: 100 - 64,000 IOPS\n  +  ``io2``: 100 - 256,000 IOPS\n  \n For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html). On other instances, you can achieve performance up to 32,000 IOPS.\n This parameter is supported for ``io1``, ``io2``, and ``gp3`` volumes only."},"kmsKeyId":{"type":"string","description":"Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption."},"snapshotId":{"type":"string","description":"The ID of the snapshot."},"throughput":{"type":"integer","description":"The throughput to provision for a ``gp3`` volume, with a maximum of 2,000 MiB/s.\n Valid Range: Minimum value of 125. Maximum value of 2,000."},"volumeInitializationRate":{"type":"integer","description":"Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.\n This parameter is supported only for volumes created from snapshots. Omit this parameter if:\n  +  You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.\n  If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.\n   +  You want to create a volume that is initialized at the default rate.\n  \n For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide*.\n Valid range: 100 - 300 MiB/s"},"volumeSize":{"type":"integer","description":"The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:\n  +  ``gp2``: 1 - 16,384 GiB\n  +  ``gp3``: 1 - 65,536 GiB\n  +  ``io1``: 4 - 16,384 GiB\n  +  ``io2``: 4 - 65,536 GiB\n  +  ``st1`` and ``sc1``: 125 - 16,384 GiB\n  +  ``standard``: 1 - 1024 GiB"},"volumeType":{"type":"string","description":"The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide*."}},"type":"object"},"aws-native:ec2:LaunchTemplateEnaSrdSpecification":{"description":"ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.\n To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.","properties":{"enaSrdEnabled":{"type":"boolean","description":"Indicates whether ENA Express is enabled for the network interface."},"enaSrdUdpSpecification":{"$ref":"#/types/aws-native:ec2:LaunchTemplateEnaSrdUdpSpecification","description":"Configures ENA Express for UDP network traffic."}},"type":"object"},"aws-native:ec2:LaunchTemplateEnaSrdUdpSpecification":{"description":"ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.","properties":{"enaSrdUdpEnabled":{"type":"boolean","description":"Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express."}},"type":"object"},"aws-native:ec2:LaunchTemplateEnclaveOptions":{"description":"Indicates whether the instance is enabled for AWS Nitro Enclaves.","properties":{"enabled":{"type":"boolean","description":"If this parameter is set to ``true``, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves."}},"type":"object"},"aws-native:ec2:LaunchTemplateHibernationOptions":{"description":"Specifies whether your instance is configured for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html#hibernating-prerequisites). For more information, see [Hibernate Your Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*.\n ``HibernationOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"configured":{"type":"boolean","description":"If you set this parameter to ``true``, the instance is enabled for hibernation.\n Default: ``false``"}},"type":"object"},"aws-native:ec2:LaunchTemplateIamInstanceProfile":{"description":"Specifies an IAM instance profile, which is a container for an IAM role for your instance. You can use an IAM role to distribute your AWS credentials to your instances.\n If you are creating the launch template for use with an ASlong group, you can specify either the name or the ARN of the instance profile, but not both.\n ``IamInstanceProfile`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"arn":{"type":"string","description":"The Amazon Resource Name (ARN) of the instance profile."},"name":{"type":"string","description":"The name of the instance profile."}},"type":"object"},"aws-native:ec2:LaunchTemplateInstanceMarketOptions":{"description":"Specifies the market (purchasing) option for an instance.\n ``InstanceMarketOptions`` is a property of the [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"marketType":{"type":"string","description":"The market type."},"spotOptions":{"$ref":"#/types/aws-native:ec2:LaunchTemplateSpotOptions","description":"The options for Spot Instances."}},"type":"object"},"aws-native:ec2:LaunchTemplateInstanceRequirements":{"description":"The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.\n You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default.\n When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.\n To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:\n  +  ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.\n  +  ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes.\n  \n  If you specify ``InstanceRequirements``, you can't specify ``InstanceType``.\n Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html)AWS CloudFormation resource, you can't specify ``InstanceRequirements``.\n  For more information, see [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html) and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*.","properties":{"acceleratorCount":{"$ref":"#/types/aws-native:ec2:LaunchTemplateAcceleratorCount","description":"The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.\n To exclude accelerator-enabled instance types, set ``Max`` to ``0``.\n Default: No minimum or maximum limits"},"acceleratorManufacturers":{"type":"array","items":{"type":"string"},"description":"Indicates whether instance types must have accelerators by specific manufacturers.\n  +  For instance types with AWS devices, specify ``amazon-web-services``.\n  +  For instance types with AMD devices, specify ``amd``.\n  +  For instance types with Habana devices, specify ``habana``.\n  +  For instance types with NVIDIA devices, specify ``nvidia``.\n  +  For instance types with Xilinx devices, specify ``xilinx``.\n  \n Default: Any manufacturer"},"acceleratorNames":{"type":"array","items":{"type":"string"},"description":"The accelerators that must be on the instance type.\n  +  For instance types with NVIDIA A10G GPUs, specify ``a10g``.\n  +  For instance types with NVIDIA A100 GPUs, specify ``a100``.\n  +  For instance types with NVIDIA H100 GPUs, specify ``h100``.\n  +  For instance types with AWS Inferentia chips, specify ``inferentia``.\n  +  For instance types with NVIDIA GRID K520 GPUs, specify ``k520``.\n  +  For instance types with NVIDIA K80 GPUs, specify ``k80``.\n  +  For instance types with NVIDIA M60 GPUs, specify ``m60``.\n  +  For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``.\n  +  For instance types with NVIDIA T4 GPUs, specify ``t4``.\n  +  For instance types with NVIDIA T4G GPUs, specify ``t4g``.\n  +  For instance types with Xilinx VU9P FPGAs, specify ``vu9p``.\n  +  For instance types with NVIDIA V100 GPUs, specify ``v100``.\n  \n Default: Any accelerator"},"acceleratorTotalMemoryMiB":{"$ref":"#/types/aws-native:ec2:LaunchTemplateAcceleratorTotalMemoryMiB","description":"The minimum and maximum amount of total accelerator memory, in MiB.\n Default: No minimum or maximum limits"},"acceleratorTypes":{"type":"array","items":{"type":"string"},"description":"The accelerator types that must be on the instance type.\n  +  For instance types with FPGA accelerators, specify ``fpga``.\n  +  For instance types with GPU accelerators, specify ``gpu``.\n  +  For instance types with Inference accelerators, specify ``inference``.\n  \n Default: Any accelerator type"},"allowedInstanceTypes":{"type":"array","items":{"type":"string"},"description":"The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.\n  If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``.\n  Default: All instance types"},"bareMetal":{"type":"string","description":"Indicates whether bare metal instance types must be included, excluded, or required.\n  +  To include bare metal instance types, specify ``included``.\n  +  To require only bare metal instance types, specify ``required``.\n  +  To exclude bare metal instance types, specify ``excluded``.\n  \n Default: ``excluded``"},"baselineEbsBandwidthMbps":{"$ref":"#/types/aws-native:ec2:LaunchTemplateBaselineEbsBandwidthMbps","description":"The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.\n Default: No minimum or maximum limits"},"baselinePerformanceFactors":{"$ref":"#/types/aws-native:ec2:LaunchTemplateBaselinePerformanceFactors","description":"The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*."},"burstablePerformance":{"type":"string","description":"Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html).\n  +  To include burstable performance instance types, specify ``included``.\n  +  To require only burstable performance instance types, specify ``required``.\n  +  To exclude burstable performance instance types, specify ``excluded``.\n  \n Default: ``excluded``"},"cpuManufacturers":{"type":"array","items":{"type":"string"},"description":"The CPU manufacturers to include.\n  +  For instance types with Intel CPUs, specify ``intel``.\n  +  For instance types with AMD CPUs, specify ``amd``.\n  +  For instance types with AWS CPUs, specify ``amazon-web-services``.\n  +  For instance types with Apple CPUs, specify ``apple``.\n  \n  Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.\n  Default: Any manufacturer"},"excludedInstanceTypes":{"type":"array","items":{"type":"string"},"description":"The instance types to exclude.\n You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``.\n For example, if you specify ``c5*``,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.\n  If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``.\n  Default: No excluded instance types"},"instanceGenerations":{"type":"array","items":{"type":"string"},"description":"Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.\n For current generation instance types, specify ``current``.\n For previous generation instance types, specify ``previous``.\n Default: Current and previous generation instance types"},"localStorage":{"type":"string","description":"Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*.\n  +  To include instance types with instance store volumes, specify ``included``.\n  +  To require only instance types with instance store volumes, specify ``required``.\n  +  To exclude instance types with instance store volumes, specify ``excluded``.\n  \n Default: ``included``"},"localStorageTypes":{"type":"array","items":{"type":"string"},"description":"The type of local storage that is required.\n  +  For instance types with hard disk drive (HDD) storage, specify ``hdd``.\n  +  For instance types with solid state drive (SSD) storage, specify ``ssd``.\n  \n Default: ``hdd`` and ``ssd``"},"maxSpotPriceAsPercentageOfOptimalOnDemandPrice":{"type":"integer","description":"[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.\n  Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``."},"memoryGiBPerVCpu":{"$ref":"#/types/aws-native:ec2:LaunchTemplateMemoryGiBPerVCpu","description":"The minimum and maximum amount of memory per vCPU, in GiB.\n Default: No minimum or maximum limits"},"memoryMiB":{"$ref":"#/types/aws-native:ec2:LaunchTemplateMemoryMiB","description":"The minimum and maximum amount of memory, in MiB."},"networkBandwidthGbps":{"$ref":"#/types/aws-native:ec2:LaunchTemplateNetworkBandwidthGbps","description":"The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n Default: No minimum or maximum limits"},"networkInterfaceCount":{"$ref":"#/types/aws-native:ec2:LaunchTemplateNetworkInterfaceCount","description":"The minimum and maximum number of network interfaces.\n Default: No minimum or maximum limits"},"onDemandMaxPricePercentageOverLowestPrice":{"type":"integer","description":"[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n To turn off price protection, specify a high value, such as ``999999``.\n This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).\n  If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.\n  Default: ``20``"},"requireHibernateSupport":{"type":"boolean","description":"Indicates whether instance types must support hibernation for On-Demand Instances.\n This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html).\n Default: ``false``"},"spotMaxPricePercentageOverLowestPrice":{"type":"integer","description":"[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.\n The parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n If you set ``TargetCapacityUnitType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.\n This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).\n  Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``.\n  Default: ``100``"},"totalLocalStorageGb":{"$ref":"#/types/aws-native:ec2:LaunchTemplateTotalLocalStorageGb","description":"The minimum and maximum amount of total local storage, in GB.\n Default: No minimum or maximum limits"},"vCpuCount":{"$ref":"#/types/aws-native:ec2:LaunchTemplateVCpuCount","description":"The minimum and maximum number of vCPUs."}},"type":"object"},"aws-native:ec2:LaunchTemplateIpv4PrefixSpecification":{"description":"Specifies an IPv4 prefix for a network interface.\n ``Ipv4PrefixSpecification`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).","properties":{"ipv4Prefix":{"type":"string","description":"The IPv4 prefix. For information, see [Assigning prefixes to network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the *Amazon EC2 User Guide*."}},"type":"object"},"aws-native:ec2:LaunchTemplateIpv6Add":{"description":"Specifies an IPv6 address in an Amazon EC2 launch template.\n ``Ipv6Add`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).","properties":{"ipv6Address":{"type":"string","description":"One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses."}},"type":"object"},"aws-native:ec2:LaunchTemplateIpv6PrefixSpecification":{"description":"Specifies an IPv6 prefix for a network interface.\n ``Ipv6PrefixSpecification`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).","properties":{"ipv6Prefix":{"type":"string","description":"The IPv6 prefix."}},"type":"object"},"aws-native:ec2:LaunchTemplateLicenseSpecification":{"description":"Specifies a license configuration for an instance.\n ``LicenseSpecification`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"licenseConfigurationArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the license configuration."}},"type":"object"},"aws-native:ec2:LaunchTemplateMaintenanceOptions":{"description":"The maintenance options of your instance.","properties":{"autoRecovery":{"type":"string","description":"Disables the automatic recovery behavior of your instance or sets it to default."}},"type":"object"},"aws-native:ec2:LaunchTemplateMemoryGiBPerVCpu":{"description":"The minimum and maximum amount of memory per vCPU, in GiB.","properties":{"max":{"type":"number","description":"The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter."},"min":{"type":"number","description":"The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:LaunchTemplateMemoryMiB":{"description":"The minimum and maximum amount of memory, in MiB.","properties":{"max":{"type":"integer","description":"The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum amount of memory, in MiB. To specify no minimum limit, specify ``0``."}},"type":"object"},"aws-native:ec2:LaunchTemplateMetadataOptions":{"description":"The metadata options for the instance. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide*.\n ``MetadataOptions`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"httpEndpoint":{"type":"string","description":"Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is ``enabled``.\n  If you specify a value of ``disabled``, you will not be able to access your instance metadata."},"httpProtocolIpv6":{"type":"string","description":"Enables or disables the IPv6 endpoint for the instance metadata service.\n Default: ``disabled``"},"httpPutResponseHopLimit":{"type":"integer","description":"The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.\n Default: ``1``\n Possible values: Integers from 1 to 64"},"httpTokens":{"type":"string","description":"Indicates whether IMDSv2 is required.\n  +  ``optional`` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.\n  +  ``required`` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.\n  \n Default: If the value of ``ImdsSupport`` for the Amazon Machine Image (AMI) for your instance is ``v2.0``, the default is ``required``."},"instanceMetadataTags":{"type":"string","description":"Set to ``enabled`` to allow access to instance tags from the instance metadata. Set to ``disabled`` to turn off access to instance tags from the instance metadata. For more information, see [View tags for your EC2 instances using instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-tags-in-IMDS.html).\n Default: ``disabled``"}},"type":"object"},"aws-native:ec2:LaunchTemplateMonitoring":{"description":"Specifies whether detailed monitoring is enabled for an instance. For more information about detailed monitoring, see [Enable or turn off detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html) in the *User Guide*.\n ``Monitoring`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"enabled":{"type":"boolean","description":"Specify ``true`` to enable detailed monitoring. Otherwise, basic monitoring is enabled."}},"type":"object"},"aws-native:ec2:LaunchTemplateNetworkBandwidthGbps":{"description":"The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).\n  Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide*.","properties":{"max":{"type":"number","description":"The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter."},"min":{"type":"number","description":"The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit."}},"type":"object"},"aws-native:ec2:LaunchTemplateNetworkInterface":{"description":"Specifies the parameters for a network interface.\n ``NetworkInterface`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"associateCarrierIpAddress":{"type":"boolean","description":"Associates a Carrier IP address with eth0 for a new network interface.\n Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see [Carrier IP addresses](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the *Developer Guide*."},"associatePublicIpAddress":{"type":"boolean","description":"Associates a public IPv4 address with eth0 for a new network interface.\n AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [Amazon VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/)."},"connectionTrackingSpecification":{"$ref":"#/types/aws-native:ec2:LaunchTemplateConnectionTrackingSpecification","description":"A connection tracking specification for the network interface."},"deleteOnTermination":{"type":"boolean","description":"Indicates whether the network interface is deleted when the instance is terminated."},"description":{"type":"string","description":"A description for the network interface."},"deviceIndex":{"type":"integer","description":"The device index for the network interface attachment. The primary network interface has a device index of 0. If the network interface is of type ``interface``, you must specify a device index.\n If you create a launch template that includes secondary network interfaces but no primary network interface, and you specify it using the ``LaunchTemplate`` property of ``AWS::EC2::Instance``, then you must include a primary network interface using the ``NetworkInterfaces`` property of ``AWS::EC2::Instance``."},"enaQueueCount":{"type":"integer","description":"The number of ENA queues to be created with the instance."},"enaSrdSpecification":{"$ref":"#/types/aws-native:ec2:LaunchTemplateEnaSrdSpecification","description":"The ENA Express configuration for the network interface."},"groups":{"type":"array","items":{"type":"string"},"description":"The IDs of one or more security groups."},"interfaceType":{"type":"string","description":"The type of network interface. To create an Elastic Fabric Adapter (EFA), specify ``efa`` or ``efa``. For more information, see [Elastic Fabric Adapter for AI/ML and HPC workloads on Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*.\n If you are not creating an EFA, specify ``interface`` or omit this parameter.\n If you specify ``efa-only``, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses.\n Valid values: ``interface`` | ``efa`` | ``efa-only``"},"ipv4PrefixCount":{"type":"integer","description":"The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv4Prefix`` option."},"ipv4Prefixes":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:LaunchTemplateIpv4PrefixSpecification"},"description":"One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv4PrefixCount`` option."},"ipv6AddressCount":{"type":"integer","description":"The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses."},"ipv6Addresses":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:LaunchTemplateIpv6Add"},"description":"One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses."},"ipv6PrefixCount":{"type":"integer","description":"The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the ``Ipv6Prefix`` option."},"ipv6Prefixes":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:LaunchTemplateIpv6PrefixSpecification"},"description":"One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the ``Ipv6PrefixCount`` option."},"networkCardIndex":{"type":"integer","description":"The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0."},"networkInterfaceId":{"type":"string","description":"The ID of the network interface."},"primaryIpv6":{"type":"boolean","description":"The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html)."},"privateIpAddress":{"type":"string","description":"The primary private IPv4 address of the network interface."},"privateIpAddresses":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:LaunchTemplatePrivateIpAdd"},"description":"One or more private IPv4 addresses."},"secondaryPrivateIpAddressCount":{"type":"integer","description":"The number of secondary private IPv4 addresses to assign to a network interface."},"subnetId":{"type":"string","description":"The ID of the subnet for the network interface."}},"type":"object"},"aws-native:ec2:LaunchTemplateNetworkInterfaceCount":{"description":"The minimum and maximum number of network interfaces.","properties":{"max":{"type":"integer","description":"The maximum number of network interfaces. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum number of network interfaces. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:LaunchTemplateNetworkPerformanceOptions":{"description":"Contains settings for the network performance options for the instance.","properties":{"bandwidthWeighting":{"type":"string","description":"Specify the bandwidth weighting option to boost the associated type of baseline bandwidth, as follows:\n  + default This option uses the standard bandwidth configuration for your instance type. + vpc-1 This option boosts your networking baseline bandwidth and reduces your EBS baseline bandwidth. + ebs-1 This option boosts your EBS baseline bandwidth and reduces your networking baseline bandwidth."}},"type":"object"},"aws-native:ec2:LaunchTemplatePlacement":{"description":"Specifies the placement of an instance.\n ``Placement`` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"affinity":{"type":"string","description":"The affinity setting for an instance on a Dedicated Host."},"availabilityZone":{"type":"string","description":"The Availability Zone for the instance.\n Either ``AvailabilityZone`` or ``AvailabilityZoneId`` can be specified, but not both"},"groupId":{"type":"string","description":"The Group Id of a placement group. You must specify the Placement Group *Group Id* to launch an instance in a shared placement group."},"groupName":{"type":"string","description":"The name of the placement group for the instance."},"hostId":{"type":"string","description":"The ID of the Dedicated Host for the instance."},"hostResourceGroupArn":{"type":"string","description":"The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the *Tenancy* parameter or set it to ``host``."},"partitionNumber":{"type":"integer","description":"The number of the partition the instance should launch in. Valid only if the placement group strategy is set to ``partition``."},"spreadDomain":{"type":"string","description":"Reserved for future use."},"tenancy":{"type":"string","description":"The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware."}},"type":"object"},"aws-native:ec2:LaunchTemplatePrivateDnsNameOptions":{"description":"The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.","properties":{"enableResourceNameDnsARecord":{"type":"boolean","description":"Indicates whether to respond to DNS queries for instance hostnames with DNS A records."},"enableResourceNameDnsAaaaRecord":{"type":"boolean","description":"Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records."},"hostnameType":{"type":"string","description":"The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*."}},"type":"object"},"aws-native:ec2:LaunchTemplatePrivateIpAdd":{"description":"Specifies a secondary private IPv4 address for a network interface.\n ``PrivateIpAdd`` is a property of [AWS::EC2::LaunchTemplate NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-networkinterface.html).","properties":{"primary":{"type":"boolean","description":"Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary."},"privateIpAddress":{"type":"string","description":"The private IPv4 address."}},"type":"object"},"aws-native:ec2:LaunchTemplateReference":{"description":"Specifies an instance family to use as the baseline reference for CPU performance.","properties":{"instanceFamily":{"type":"string","description":"The instance family to use as a baseline reference.\n  Ensure that you specify the correct value for the instance family. The instance family is everything before the period (``.``) in the instance type name. For example, in the instance type ``c6i.large``, the instance family is ``c6i``, not ``c6``. For more information, see [Amazon EC2 instance type naming conventions](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html) in *Amazon EC2 Instance Types*.\n  The following instance families are *not supported* for performance protection:\n  +   ``c1`` \n  +  ``g3`` | ``g3s``\n  +   ``hpc7g`` \n  +  ``m1`` | ``m2``\n  +  ``mac1`` | ``mac2`` | ``mac2-m1ultra`` | ``mac2-m2`` | ``mac2-m2pro``\n  +  ``p3dn`` | ``p4d`` | ``p5``\n  +   ``t1`` \n  +  ``u-12tb1`` | ``u-18tb1`` | ``u-24tb1`` | ``u-3tb1`` | ``u-6tb1`` | ``u-9tb1`` | ``u7i-12tb`` | ``u7in-16tb`` | ``u7in-24tb`` | ``u7in-32tb``\n  \n If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families."}},"type":"object"},"aws-native:ec2:LaunchTemplateSpotOptions":{"description":"Specifies options for Spot Instances.\n ``SpotOptions`` is a property of [AWS::EC2::LaunchTemplate InstanceMarketOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html).","properties":{"blockDurationMinutes":{"type":"integer","description":"Deprecated."},"instanceInterruptionBehavior":{"type":"string","description":"The behavior when a Spot Instance is interrupted. The default is ``terminate``."},"maxPrice":{"type":"string","description":"The maximum hourly price you're willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. If you do specify this parameter, it must be more than USD $0.001. Specifying a value below USD $0.001 will result in an ``InvalidParameterValue`` error message when the launch template is used to launch an instance.\n  If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter."},"spotInstanceType":{"type":"string","description":"The Spot Instance request type.\n If you are using Spot Instances with an Auto Scaling group, use ``one-time`` requests, as the ASlong service handles requesting new Spot Instances whenever the group is below its desired capacity."},"validUntil":{"type":"string","description":"The end date of the request, in UTC format (*YYYY-MM-DD*T*HH:MM:SS*Z). Supported only for persistent requests.\n  +  For a persistent request, the request remains active until the ``ValidUntil`` date and time is reached. Otherwise, the request remains active until you cancel it.\n  +  For a one-time request, ``ValidUntil`` is not supported. The request remains active until all instances launch or you cancel the request.\n  \n Default: 7 days from the current date"}},"type":"object"},"aws-native:ec2:LaunchTemplateTag":{"description":"Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:LaunchTemplateTagSpecification":{"description":"Specifies the tags to apply to the launch template during creation.\n To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html).\n ``LaunchTemplateTagSpecification`` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html).","properties":{"resourceType":{"type":"string","description":"The type of resource. To tag a launch template, ``ResourceType`` must be ``launch-template``."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:LaunchTemplateTag"},"description":"The tags for the resource."}},"type":"object"},"aws-native:ec2:LaunchTemplateTotalLocalStorageGb":{"description":"The minimum and maximum amount of total local storage, in GB.","properties":{"max":{"type":"number","description":"The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter."},"min":{"type":"number","description":"The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:LaunchTemplateVCpuCount":{"description":"The minimum and maximum number of vCPUs.","properties":{"max":{"type":"integer","description":"The maximum number of vCPUs. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum number of vCPUs. To specify no minimum limit, specify ``0``."}},"type":"object"},"aws-native:ec2:LocalGatewayRouteTableTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:ec2:LocalGatewayRouteTableVirtualInterfaceGroupAssociationTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:ec2:LocalGatewayRouteTableVpcAssociationTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:ec2:LocalGatewayVirtualInterfaceGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object"},"aws-native:ec2:LocalGatewayVirtualInterfaceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object"},"aws-native:ec2:NatGatewayAvailabilityZoneAddress":{"description":"For regional NAT gateways only: The configuration specifying which Elastic IP address (EIP) to use for handling outbound NAT traffic from a specific Availability Zone. \n A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region.\n For more information, see [Regional NAT gateways for automatic multi-AZ expansion](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateways-regional.html) in the *Amazon VPC User Guide*.","properties":{"allocationIds":{"type":"array","items":{"type":"string"},"description":"The allocation IDs of the Elastic IP addresses (EIPs) to be used for handling outbound NAT traffic in this specific Availability Zone."},"availabilityZone":{"type":"string","description":"For regional NAT gateways only: The Availability Zone where this specific NAT gateway configuration will be active. Each AZ in a regional NAT gateway has its own configuration to handle outbound NAT traffic from that AZ. \n A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region."},"availabilityZoneId":{"type":"string","description":"For regional NAT gateways only: The ID of the Availability Zone where this specific NAT gateway configuration will be active. Each AZ in a regional NAT gateway has its own configuration to handle outbound NAT traffic from that AZ. Use this instead of AvailabilityZone for consistent identification of AZs across AWS Regions. \n A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region."}},"type":"object","required":["allocationIds"]},"aws-native:ec2:NatGatewayTag":{"description":"Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:NetworkAclTag":{"description":"Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:NetworkInsightsAccessScopeAccessScopePathRequest":{"properties":{"destination":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAccessScopePathStatementRequest","description":"The destination."},"source":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAccessScopePathStatementRequest","description":"The source."},"throughResources":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAccessScopeThroughResourcesStatementRequest"},"description":"The through resources."}},"type":"object"},"aws-native:ec2:NetworkInsightsAccessScopeAnalysisFindingsFound":{"description":"Indicates whether there are findings (true | false | unknown).","type":"string","enum":[{"name":"True","value":"true"},{"name":"False","value":"false"},{"name":"Unknown","value":"unknown"}]},"aws-native:ec2:NetworkInsightsAccessScopeAnalysisStatus":{"description":"The status of the analysis (running | succeeded | failed).","type":"string","enum":[{"name":"Running","value":"running"},{"name":"Failed","value":"failed"},{"name":"Succeeded","value":"succeeded"}]},"aws-native:ec2:NetworkInsightsAccessScopeAnalysisTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key"]},"aws-native:ec2:NetworkInsightsAccessScopePacketHeaderStatementRequest":{"properties":{"destinationAddresses":{"type":"array","items":{"type":"string"},"description":"The destination addresses."},"destinationPorts":{"type":"array","items":{"type":"string"},"description":"The destination ports."},"destinationPrefixLists":{"type":"array","items":{"type":"string"},"description":"The destination prefix lists."},"protocols":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAccessScopeProtocol"},"description":"The protocols."},"sourceAddresses":{"type":"array","items":{"type":"string"},"description":"The source addresses."},"sourcePorts":{"type":"array","items":{"type":"string"},"description":"The source ports."},"sourcePrefixLists":{"type":"array","items":{"type":"string"},"description":"The source prefix lists."}},"type":"object"},"aws-native:ec2:NetworkInsightsAccessScopePathStatementRequest":{"properties":{"packetHeaderStatement":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAccessScopePacketHeaderStatementRequest","description":"The packet header statement."},"resourceStatement":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAccessScopeResourceStatementRequest","description":"The resource statement."}},"type":"object"},"aws-native:ec2:NetworkInsightsAccessScopeProtocol":{"type":"string","enum":[{"name":"Tcp","value":"tcp"},{"name":"Udp","value":"udp"}]},"aws-native:ec2:NetworkInsightsAccessScopeResourceStatementRequest":{"properties":{"resourceTypes":{"type":"array","items":{"type":"string"},"description":"The resource types."},"resources":{"type":"array","items":{"type":"string"},"description":"The resources."}},"type":"object"},"aws-native:ec2:NetworkInsightsAccessScopeTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key"]},"aws-native:ec2:NetworkInsightsAccessScopeThroughResourcesStatementRequest":{"properties":{"resourceStatement":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAccessScopeResourceStatementRequest","description":"The resource statement."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisAdditionalDetail":{"properties":{"additionalDetailType":{"type":"string","description":"The additional detail code."},"component":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The path component."},"loadBalancers":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent"},"description":"The load balancers."},"serviceName":{"type":"string","description":"The name of the VPC endpoint service."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisAlternatePathHint":{"properties":{"componentArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the component."},"componentId":{"type":"string","description":"The ID of the component."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisAnalysisAclRule":{"properties":{"cidr":{"type":"string","description":"The IPv4 address range, in CIDR notation."},"egress":{"type":"boolean","description":"Indicates whether the rule is an outbound rule."},"portRange":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisPortRange","description":"The range of ports."},"protocol":{"type":"string","description":"The protocol."},"ruleAction":{"type":"string","description":"Indicates whether to allow or deny traffic that matches the rule."},"ruleNumber":{"type":"integer","description":"The rule number."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent":{"properties":{"arn":{"type":"string","description":"The Amazon Resource Name (ARN) of the component."},"id":{"type":"string","description":"The ID of the component."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisAnalysisLoadBalancerListener":{"properties":{"instancePort":{"type":"integer","description":"[Classic Load Balancers] The back-end port for the listener."},"loadBalancerPort":{"type":"integer","description":"The port on which the load balancer is listening."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisAnalysisLoadBalancerTarget":{"properties":{"address":{"type":"string","description":"The IP address."},"availabilityZone":{"type":"string","description":"The Availability Zone."},"instance":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"Information about the instance."},"port":{"type":"integer","description":"The port on which the target is listening."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisAnalysisPacketHeader":{"properties":{"destinationAddresses":{"type":"array","items":{"type":"string"},"description":"The destination addresses."},"destinationPortRanges":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisPortRange"},"description":"The destination port ranges."},"protocol":{"type":"string","description":"The protocol."},"sourceAddresses":{"type":"array","items":{"type":"string"},"description":"The source addresses."},"sourcePortRanges":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisPortRange"},"description":"The source port ranges."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisAnalysisRouteTableRoute":{"properties":{"destinationCidr":{"type":"string","description":"The destination IPv4 address, in CIDR notation."},"destinationPrefixListId":{"type":"string","description":"The prefix of the AWS service."},"egressOnlyInternetGatewayId":{"type":"string","description":"The ID of an egress-only internet gateway."},"gatewayId":{"type":"string","description":"The ID of the gateway, such as an internet gateway or virtual private gateway."},"instanceId":{"type":"string","description":"The ID of the instance, such as a NAT instance."},"natGatewayId":{"type":"string","description":"The ID of a NAT gateway."},"networkInterfaceId":{"type":"string","description":"The ID of a network interface."},"origin":{"type":"string","description":"Describes how the route was created. The following are the possible values:\n\n- CreateRouteTable - The route was automatically created when the route table was created.\n- CreateRoute - The route was manually added to the route table.\n- EnableVgwRoutePropagation - The route was propagated by route propagation."},"state":{"type":"string","description":"The state. The following are the possible values:\n\n- active\n- blackhole"},"transitGatewayId":{"type":"string","description":"The ID of a transit gateway."},"vpcPeeringConnectionId":{"type":"string","description":"The ID of a VPC peering connection."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisAnalysisSecurityGroupRule":{"properties":{"cidr":{"type":"string","description":"The IPv4 address range, in CIDR notation."},"direction":{"type":"string","description":"The direction. The following are the possible values:\n\n- egress\n- ingress"},"portRange":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisPortRange","description":"The port range."},"prefixListId":{"type":"string","description":"The prefix list ID."},"protocol":{"type":"string","description":"The protocol name."},"securityGroupId":{"type":"string","description":"The security group ID."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisExplanation":{"properties":{"acl":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The network ACL."},"aclRule":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisAclRule","description":"The network ACL rule."},"address":{"type":"string","description":"The IPv4 address, in CIDR notation."},"addresses":{"type":"array","items":{"type":"string"},"description":"The IPv4 addresses, in CIDR notation."},"attachedTo":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The resource to which the component is attached."},"availabilityZones":{"type":"array","items":{"type":"string"},"description":"The Availability Zones."},"cidrs":{"type":"array","items":{"type":"string"},"description":"The CIDR ranges."},"classicLoadBalancerListener":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisLoadBalancerListener","description":"The listener for a Classic Load Balancer."},"component":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The component."},"componentAccount":{"type":"string","description":"The AWS account for the component."},"componentRegion":{"type":"string","description":"The Region for the component."},"customerGateway":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The customer gateway."},"destination":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The destination."},"destinationVpc":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The destination VPC."},"direction":{"type":"string","description":"The direction. The following are the possible values:\n\n- egress\n- ingress"},"elasticLoadBalancerListener":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The load balancer listener."},"explanationCode":{"type":"string","description":"The explanation code."},"ingressRouteTable":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The route table."},"internetGateway":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The internet gateway."},"loadBalancerArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the load balancer."},"loadBalancerListenerPort":{"type":"integer","description":"The listener port of the load balancer."},"loadBalancerTarget":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisLoadBalancerTarget","description":"The target."},"loadBalancerTargetGroup":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The target group."},"loadBalancerTargetGroups":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent"},"description":"The target groups."},"loadBalancerTargetPort":{"type":"integer","description":"The target port."},"missingComponent":{"type":"string","description":"The missing component."},"natGateway":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The NAT gateway."},"networkInterface":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The network interface."},"packetField":{"type":"string","description":"The packet field."},"port":{"type":"integer","description":"The port."},"portRanges":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisPortRange"},"description":"The port ranges."},"prefixList":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The prefix list."},"protocols":{"type":"array","items":{"type":"string"},"description":"The protocols."},"routeTable":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The route table."},"routeTableRoute":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisRouteTableRoute","description":"The route table route."},"securityGroup":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The security group."},"securityGroupRule":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisSecurityGroupRule","description":"The security group rule."},"securityGroups":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent"},"description":"The security groups."},"sourceVpc":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The source VPC."},"state":{"type":"string","description":"The state."},"subnet":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The subnet."},"subnetRouteTable":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The route table for the subnet."},"transitGateway":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The transit gateway."},"transitGatewayAttachment":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The transit gateway attachment."},"transitGatewayRouteTable":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The transit gateway route table."},"transitGatewayRouteTableRoute":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisTransitGatewayRouteTableRoute","description":"The transit gateway route table route."},"vpc":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The component VPC."},"vpcEndpoint":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The VPC endpoint."},"vpcPeeringConnection":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The VPC peering connection."},"vpnConnection":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The VPN connection."},"vpnGateway":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The VPN gateway."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisPathComponent":{"properties":{"aclRule":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisAclRule","description":"The network ACL rule."},"additionalDetails":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAdditionalDetail"},"description":"The additional details."},"component":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The component."},"destinationVpc":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The destination VPC."},"elasticLoadBalancerListener":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The load balancer listener."},"explanations":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisExplanation"},"description":"The explanation codes."},"inboundHeader":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisPacketHeader","description":"The inbound header."},"outboundHeader":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisPacketHeader","description":"The outbound header."},"routeTableRoute":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisRouteTableRoute","description":"The route table route."},"securityGroupRule":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisSecurityGroupRule","description":"The security group rule."},"sequenceNumber":{"type":"integer","description":"The sequence number."},"serviceName":{"type":"string","description":"The name of the VPC endpoint service."},"sourceVpc":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The source VPC."},"subnet":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The subnet."},"transitGateway":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The transit gateway."},"transitGatewayRouteTableRoute":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisTransitGatewayRouteTableRoute","description":"The route in a transit gateway route table."},"vpc":{"$ref":"#/types/aws-native:ec2:NetworkInsightsAnalysisAnalysisComponent","description":"The component VPC."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisPortRange":{"properties":{"from":{"type":"integer","description":"The first port in the range."},"to":{"type":"integer","description":"The last port in the range."}},"type":"object"},"aws-native:ec2:NetworkInsightsAnalysisStatus":{"description":"The status of the network insights analysis.","type":"string","enum":[{"name":"Running","value":"running"},{"name":"Failed","value":"failed"},{"name":"Succeeded","value":"succeeded"}]},"aws-native:ec2:NetworkInsightsAnalysisTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key"]},"aws-native:ec2:NetworkInsightsAnalysisTransitGatewayRouteTableRoute":{"properties":{"attachmentId":{"type":"string","description":"The ID of the route attachment."},"destinationCidr":{"type":"string","description":"The CIDR block used for destination matches."},"prefixListId":{"type":"string","description":"The ID of the prefix list."},"resourceId":{"type":"string","description":"The ID of the resource for the route attachment."},"resourceType":{"type":"string","description":"The resource type for the route attachment."},"routeOrigin":{"type":"string","description":"The route origin. The following are the possible values:\n\n- static\n- propagated"},"state":{"type":"string","description":"The state of the route."}},"type":"object"},"aws-native:ec2:NetworkInsightsPathFilterPortRange":{"properties":{"fromPort":{"type":"integer","description":"The first port in the range."},"toPort":{"type":"integer","description":"The last port in the range."}},"type":"object"},"aws-native:ec2:NetworkInsightsPathPathFilter":{"properties":{"destinationAddress":{"type":"string","description":"The destination IPv4 address."},"destinationPortRange":{"$ref":"#/types/aws-native:ec2:NetworkInsightsPathFilterPortRange","description":"The destination port range."},"sourceAddress":{"type":"string","description":"The source IPv4 address."},"sourcePortRange":{"$ref":"#/types/aws-native:ec2:NetworkInsightsPathFilterPortRange","description":"The source port range."}},"type":"object"},"aws-native:ec2:NetworkInsightsPathProtocol":{"type":"string","enum":[{"name":"Tcp","value":"tcp"},{"name":"Udp","value":"udp"}]},"aws-native:ec2:NetworkInsightsPathTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key"]},"aws-native:ec2:NetworkInterfaceAttachmentEnaSrdSpecification":{"description":"ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.\n To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.","properties":{"enaSrdEnabled":{"type":"boolean","description":"Indicates whether ENA Express is enabled for the network interface."},"enaSrdUdpSpecification":{"$ref":"#/types/aws-native:ec2:NetworkInterfaceAttachmentEnaSrdSpecificationEnaSrdUdpSpecificationProperties","description":"Configures ENA Express for UDP network traffic."}},"type":"object"},"aws-native:ec2:NetworkInterfaceAttachmentEnaSrdSpecificationEnaSrdUdpSpecificationProperties":{"description":"Configures ENA Express for UDP network traffic.","properties":{"enaSrdUdpEnabled":{"type":"boolean"}},"type":"object"},"aws-native:ec2:NetworkInterfaceConnectionTrackingSpecification":{"properties":{"tcpEstablishedTimeout":{"type":"integer","description":"Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds."},"udpStreamTimeout":{"type":"integer","description":"Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds."},"udpTimeout":{"type":"integer","description":"Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds."}},"type":"object"},"aws-native:ec2:NetworkInterfaceInstanceIpv6Address":{"properties":{"ipv6Address":{"type":"string","description":"An IPv6 address to associate with the network interface."}},"type":"object","required":["ipv6Address"]},"aws-native:ec2:NetworkInterfaceIpv4PrefixSpecification":{"properties":{"ipv4Prefix":{"type":"string","description":"The IPv4 prefix. For information, see [Assigning prefixes to network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the *Amazon EC2 User Guide* ."}},"type":"object","required":["ipv4Prefix"]},"aws-native:ec2:NetworkInterfaceIpv6PrefixSpecification":{"properties":{"ipv6Prefix":{"type":"string","description":"The IPv6 prefix. For information, see [Assigning prefixes to Amazon EC2 network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the *Amazon Elastic Compute Cloud User Guide* ."}},"type":"object","required":["ipv6Prefix"]},"aws-native:ec2:NetworkInterfacePrivateIpAddressSpecification":{"properties":{"primary":{"type":"boolean","description":"Sets the private IP address as the primary private address. You can set only one primary private IP address. If you don't specify a primary private IP address, Amazon EC2 automatically assigns a primary private IP address."},"privateIpAddress":{"type":"string","description":"The private IP address of the network interface."}},"type":"object","required":["primary","privateIpAddress"]},"aws-native:ec2:NetworkInterfacePublicIpDnsHostnameTypeSpecification":{"description":"Public IP DNS hostname type","type":"string","enum":[{"name":"PublicDualStackDnsName","value":"public-dual-stack-dns-name"},{"name":"PublicIpv4DnsName","value":"public-ipv4-dns-name"},{"name":"PublicIpv6DnsName","value":"public-ipv6-dns-name"}]},"aws-native:ec2:NetworkInterfacePublicIpDnsNameOptions":{"description":"Describes the public hostname type options, including public hostname type, IPv4-enabled public hostname, IPv6-enabled public hostname, and dual-stack public hostname.","properties":{"dnsHostnameType":{"type":"string","description":"The public hostname type. For more information, see [EC2 instance hostnames, DNS names, and domains](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon EC2 User Guide* ."},"publicDualStackDnsName":{"type":"string","description":"A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface."},"publicIpv4DnsName":{"type":"string","description":"An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface."},"publicIpv6DnsName":{"type":"string","description":"An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface."}},"type":"object"},"aws-native:ec2:NetworkInterfaceTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:OptionsProperties":{"description":"The options for the transit gateway vpc attachment.","properties":{"applianceModeSupport":{"type":"string","description":"Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable"},"dnsSupport":{"type":"string","description":"Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable"},"ipv6Support":{"type":"string","description":"Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable"},"securityGroupReferencingSupport":{"type":"string","description":"Indicates whether to enable Security Group referencing support for Vpc Attachment. Valid values: enable | disable"}},"type":"object"},"aws-native:ec2:PlacementGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:PrefixListAddressFamily":{"description":"Ip Version of Prefix List.","type":"string","enum":[{"name":"IPv4","value":"IPv4"},{"name":"IPv6","value":"IPv6"}]},"aws-native:ec2:PrefixListEntry":{"properties":{"cidr":{"type":"string","description":"The CIDR block."},"description":{"type":"string","description":"A description for the entry.\n\nConstraints: Up to 255 characters in length."}},"type":"object","required":["cidr"]},"aws-native:ec2:PrefixListTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key"]},"aws-native:ec2:PrivateDnsNameOptionsOnLaunchProperties":{"description":"The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*.\n Available options:\n  +  EnableResourceNameDnsAAAARecord (true | false)\n  +  EnableResourceNameDnsARecord (true | false)\n  +  HostnameType (ip-name | resource-name)","properties":{"enableResourceNameDnsARecord":{"type":"boolean","description":"Indicates whether to respond to DNS queries for instance hostnames with DNS A records."},"enableResourceNameDnsAaaaRecord":{"type":"boolean","description":"Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records."},"hostnameType":{"type":"string","description":"The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID."}},"type":"object"},"aws-native:ec2:RouteServerEndpointTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:RouteServerPeerBgpOptions":{"description":"BGP Options","properties":{"peerAsn":{"type":"integer","description":"BGP ASN of the Route Server Peer"},"peerLivenessDetection":{"$ref":"#/types/aws-native:ec2:RouteServerPeerBgpOptionsPeerLivenessDetection","description":"BGP Liveness Detection"}},"type":"object"},"aws-native:ec2:RouteServerPeerBgpOptionsPeerLivenessDetection":{"description":"BGP Liveness Detection","type":"string","enum":[{"name":"Bfd","value":"bfd"},{"name":"BgpKeepalive","value":"bgp-keepalive"}]},"aws-native:ec2:RouteServerPeerTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:RouteServerPersistRoutes":{"description":"Whether to enable persistent routes","type":"string","enum":[{"name":"Enable","value":"enable"},{"name":"Disable","value":"disable"}]},"aws-native:ec2:RouteServerTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:RouteTableTag":{"description":"Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:SecurityGroupEgress":{"properties":{"cidrIp":{"type":"string","description":"The IPv4 address range, in CIDR format.\n\nYou must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `DestinationPrefixListId` , or `DestinationSecurityGroupId` .\n\nFor examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* ."},"cidrIpv6":{"type":"string","description":"The IPv6 address range, in CIDR format.\n\nYou must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `DestinationPrefixListId` , or `DestinationSecurityGroupId` .\n\nFor examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* ."},"description":{"type":"string","description":"A description for the security group rule.\n\nConstraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*"},"destinationPrefixListId":{"type":"string","description":"The prefix list IDs for the destination AWS service. This is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.\n\nYou must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `DestinationPrefixListId` , or `DestinationSecurityGroupId` ."},"destinationSecurityGroupId":{"type":"string","description":"The ID of the destination VPC security group.\n\nYou must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `DestinationPrefixListId` , or `DestinationSecurityGroupId` ."},"fromPort":{"type":"integer","description":"If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types)."},"ipProtocol":{"type":"string","description":"The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).\n\nUse `-1` to specify all protocols. When authorizing security group rules, specifying `-1` or a protocol number other than `tcp` , `udp` , `icmp` , or `icmpv6` allows traffic on all ports, regardless of any port range you specify. For `tcp` , `udp` , and `icmp` , you must specify a port range. For `icmpv6` , the port range is optional; if you omit the port range, traffic for all types and codes is allowed."},"toPort":{"type":"integer","description":"If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes)."}},"type":"object","required":["ipProtocol"]},"aws-native:ec2:SecurityGroupIngress":{"properties":{"cidrIp":{"type":"string","description":"The IPv4 address range, in CIDR format.\n\nYou must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `SourcePrefixListId` , or `SourceSecurityGroupId` .\n\nFor examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* ."},"cidrIpv6":{"type":"string","description":"The IPv6 address range, in CIDR format.\n\nYou must specify exactly one of the following: `CidrIp` , `CidrIpv6` , `SourcePrefixListId` , or `SourceSecurityGroupId` .\n\nFor examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide* ."},"description":{"type":"string","description":"Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously.\n\nConstraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*"},"fromPort":{"type":"integer","description":"If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types)."},"ipProtocol":{"type":"string","description":"The IP protocol name ( `tcp` , `udp` , `icmp` , `icmpv6` ) or number (see [Protocol Numbers](https://docs.aws.amazon.com/http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) ).\n\nUse `-1` to specify all protocols. When authorizing security group rules, specifying `-1` or a protocol number other than `tcp` , `udp` , `icmp` , or `icmpv6` allows traffic on all ports, regardless of any port range you specify. For `tcp` , `udp` , and `icmp` , you must specify a port range. For `icmpv6` , the port range is optional; if you omit the port range, traffic for all types and codes is allowed."},"sourcePrefixListId":{"type":"string","description":"The ID of a prefix list."},"sourceSecurityGroupId":{"type":"string","description":"The ID of the security group."},"sourceSecurityGroupName":{"type":"string","description":"[Default VPC] The name of the source security group. You must specify either the security group ID or the security group name. You can't specify the group name in combination with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.\n\nFor security groups in a nondefault VPC, you must specify the group ID."},"sourceSecurityGroupOwnerId":{"type":"string","description":"[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this property with an IP address range. Creates rules that grant full ICMP, UDP, and TCP access.\n\nIf you specify `SourceSecurityGroupName` or `SourceSecurityGroupId` and that security group is owned by a different account than the account creating the stack, you must specify the `SourceSecurityGroupOwnerId` ; otherwise, this property is optional."},"toPort":{"type":"integer","description":"If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes)."}},"type":"object","required":["ipProtocol"]},"aws-native:ec2:SecurityGroupTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:SecurityGroupVpcAssociationState":{"type":"string","enum":[{"name":"Associating","value":"associating"},{"name":"Associated","value":"associated"},{"name":"AssociationFailed","value":"association-failed"},{"name":"Disassociating","value":"disassociating"},{"name":"Disassociated","value":"disassociated"},{"name":"DisassociationFailed","value":"disassociation-failed"}]},"aws-native:ec2:SnapshotBlockPublicAccessState":{"description":"The state of EBS Snapshot Block Public Access.","type":"string","enum":[{"name":"BlockAllSharing","value":"block-all-sharing"},{"name":"BlockNewSharing","value":"block-new-sharing"}]},"aws-native:ec2:SpotFleetAcceleratorCountRequest":{"properties":{"max":{"type":"integer","description":"The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set `Max` to `0` ."},"min":{"type":"integer","description":"The minimum number of accelerators. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:SpotFleetAcceleratorTotalMemoryMiBRequest":{"properties":{"max":{"type":"integer","description":"The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:SpotFleetBaselineEbsBandwidthMbpsRequest":{"properties":{"max":{"type":"integer","description":"The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:SpotFleetBaselinePerformanceFactorsRequest":{"properties":{"cpu":{"$ref":"#/types/aws-native:ec2:SpotFleetCpuPerformanceFactorRequest","description":"The CPU performance to consider, using an instance family as the baseline reference."}},"type":"object"},"aws-native:ec2:SpotFleetBlockDeviceMapping":{"properties":{"deviceName":{"type":"string","description":"The device name. For available device names, see [Device names for volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html) ."},"ebs":{"$ref":"#/types/aws-native:ec2:SpotFleetEbsBlockDevice","description":"Parameters used to automatically set up EBS volumes when the instance is launched."},"noDevice":{"type":"string","description":"To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value."},"virtualName":{"type":"string","description":"The virtual device name ( `ephemeral` N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for `ephemeral0` and `ephemeral1` . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.\n\nNVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.\n\nConstraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI."}},"type":"object","required":["deviceName"]},"aws-native:ec2:SpotFleetClassicLoadBalancer":{"properties":{"name":{"type":"string","description":"The name of the load balancer."}},"type":"object","required":["name"]},"aws-native:ec2:SpotFleetClassicLoadBalancersConfig":{"properties":{"classicLoadBalancers":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetClassicLoadBalancer"},"description":"One or more Classic Load Balancers."}},"type":"object","required":["classicLoadBalancers"]},"aws-native:ec2:SpotFleetCpuPerformanceFactorRequest":{"properties":{"references":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetPerformanceFactorReferenceRequest"},"description":"Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences.\n\n\u003e Currently, only one instance family can be specified in the list."}},"type":"object"},"aws-native:ec2:SpotFleetEbsBlockDevice":{"properties":{"deleteOnTermination":{"type":"boolean","description":"Indicates whether the EBS volume is deleted on instance termination. For more information, see [Preserving Amazon EBS volumes on instance termination](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) in the *Amazon EC2 User Guide* ."},"encrypted":{"type":"boolean","description":"Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to `true` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Amazon EBS Encryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters) in the *Amazon EC2 User Guide* .\n\nIn no case can you remove encryption from an encrypted volume.\n\nEncrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see [Supported Instance Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances) .\n\nThis parameter is not returned by [DescribeImageAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html) ."},"iops":{"type":"integer","description":"The number of I/O operations per second (IOPS). For `gp3` , `io1` , and `io2` volumes, this represents the number of IOPS that are provisioned for the volume. For `gp2` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n\nThe following are the supported values for each volume type:\n\n- `gp3` : 3,000 - 80,000 IOPS\n- `io1` : 100 - 64,000 IOPS\n- `io2` : 100 - 256,000 IOPS\n\nFor `io2` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) . On other instances, you can achieve performance up to 32,000 IOPS.\n\nThis parameter is required for `io1` and `io2` volumes. The default for `gp3` volumes is 3,000 IOPS."},"snapshotId":{"type":"string","description":"The ID of the snapshot."},"volumeSize":{"type":"integer","description":"The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.\n\nThe following are the supported sizes for each volume type:\n\n- `gp2` : 1 - 16,384 GiB\n- `gp3` : 1 - 65,536 GiB\n- `io1` : 4 - 16,384 GiB\n- `io2` : 4 - 65,536 GiB\n- `st1` and `sc1` : 125 - 16,384 GiB\n- `standard` : 1 - 1024 GiB"},"volumeType":{"$ref":"#/types/aws-native:ec2:SpotFleetEbsBlockDeviceVolumeType","description":"The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide* ."}},"type":"object"},"aws-native:ec2:SpotFleetEbsBlockDeviceVolumeType":{"description":"The volume type. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide* .","type":"string","enum":[{"name":"Gp2","value":"gp2"},{"name":"Gp3","value":"gp3"},{"name":"Io1","value":"io1"},{"name":"Io2","value":"io2"},{"name":"Sc1","value":"sc1"},{"name":"St1","value":"st1"},{"name":"Standard","value":"standard"}]},"aws-native:ec2:SpotFleetFleetLaunchTemplateSpecification":{"properties":{"launchTemplateId":{"type":"string","description":"The ID of the launch template.\n\nYou must specify the `LaunchTemplateId` or the `LaunchTemplateName` , but not both."},"launchTemplateName":{"type":"string","description":"The name of the launch template.\n\nYou must specify the `LaunchTemplateName` or the `LaunchTemplateId` , but not both."},"version":{"type":"string","description":"The version number of the launch template.\n\nSpecifying `$Latest` or `$Default` for the template version number is not supported. However, you can specify `LatestVersionNumber` or `DefaultVersionNumber` using the `Fn::GetAtt` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate-return-values-fn--getatt) ."}},"type":"object","required":["version"]},"aws-native:ec2:SpotFleetGroupIdentifier":{"properties":{"groupId":{"type":"string","description":"The ID of the security group."}},"type":"object","required":["groupId"]},"aws-native:ec2:SpotFleetIamInstanceProfileSpecification":{"properties":{"arn":{"type":"string","description":"The Amazon Resource Name (ARN) of the instance profile."}},"type":"object"},"aws-native:ec2:SpotFleetInstanceIpv6Address":{"properties":{"ipv6Address":{"type":"string","description":"The IPv6 address."}},"type":"object","required":["ipv6Address"]},"aws-native:ec2:SpotFleetInstanceNetworkInterfaceSpecification":{"properties":{"associatePublicIpAddress":{"type":"boolean","description":"Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is `true` .\n\nAWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [Amazon VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/) ."},"deleteOnTermination":{"type":"boolean","description":"Indicates whether the network interface is deleted when the instance is terminated."},"description":{"type":"string","description":"The description of the network interface. Applies only if creating a network interface when launching an instance."},"deviceIndex":{"type":"integer","description":"The position of the network interface in the attachment order. A primary network interface has a device index of 0.\n\nIf you specify a network interface when launching an instance, you must specify the device index."},"groups":{"type":"array","items":{"type":"string"},"description":"The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance."},"ipv6AddressCount":{"type":"integer","description":"A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch."},"ipv6Addresses":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceIpv6Address"},"description":"The IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch."},"networkInterfaceId":{"type":"string","description":"The ID of the network interface.\n\nIf you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification."},"privateIpAddresses":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetPrivateIpAddressSpecification"},"description":"The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request."},"secondaryPrivateIpAddressCount":{"type":"integer","description":"The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter."},"subnetId":{"type":"string","description":"The ID of the subnet associated with the network interface."}},"type":"object"},"aws-native:ec2:SpotFleetInstanceRequirementsRequest":{"properties":{"acceleratorCount":{"$ref":"#/types/aws-native:ec2:SpotFleetAcceleratorCountRequest","description":"The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.\n\nTo exclude accelerator-enabled instance types, set `Max` to `0` .\n\nDefault: No minimum or maximum limits"},"acceleratorManufacturers":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceRequirementsRequestAcceleratorManufacturersItem"},"description":"Indicates whether instance types must have accelerators by specific manufacturers.\n\n- For instance types with AWS devices, specify `amazon-web-services` .\n- For instance types with AMD devices, specify `amd` .\n- For instance types with Habana devices, specify `habana` .\n- For instance types with NVIDIA devices, specify `nvidia` .\n- For instance types with Xilinx devices, specify `xilinx` .\n\nDefault: Any manufacturer"},"acceleratorNames":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceRequirementsRequestAcceleratorNamesItem"},"description":"The accelerators that must be on the instance type.\n\n- For instance types with NVIDIA A10G GPUs, specify `a10g` .\n- For instance types with NVIDIA A100 GPUs, specify `a100` .\n- For instance types with NVIDIA H100 GPUs, specify `h100` .\n- For instance types with AWS Inferentia chips, specify `inferentia` .\n- For instance types with AWS Inferentia2 chips, specify `inferentia2` .\n- For instance types with Habana Gaudi HL-205 GPUs, specify `gaudi-hl-205` .\n- For instance types with NVIDIA GRID K520 GPUs, specify `k520` .\n- For instance types with NVIDIA K80 GPUs, specify `k80` .\n- For instance types with NVIDIA L4 GPUs, specify `l4` .\n- For instance types with NVIDIA L40S GPUs, specify `l40s` .\n- For instance types with NVIDIA M60 GPUs, specify `m60` .\n- For instance types with AMD Radeon Pro V520 GPUs, specify `radeon-pro-v520` .\n- For instance types with AWS Trainium chips, specify `trainium` .\n- For instance types with AWS Trainium2 chips, specify `trainium2` .\n- For instance types with NVIDIA T4 GPUs, specify `t4` .\n- For instance types with NVIDIA T4G GPUs, specify `t4g` .\n- For instance types with Xilinx U30 cards, specify `u30` .\n- For instance types with Xilinx VU9P FPGAs, specify `vu9p` .\n- For instance types with NVIDIA V100 GPUs, specify `v100` .\n\nDefault: Any accelerator"},"acceleratorTotalMemoryMiB":{"$ref":"#/types/aws-native:ec2:SpotFleetAcceleratorTotalMemoryMiBRequest","description":"The minimum and maximum amount of total accelerator memory, in MiB.\n\nDefault: No minimum or maximum limits"},"acceleratorTypes":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceRequirementsRequestAcceleratorTypesItem"},"description":"The accelerator types that must be on the instance type.\n\n- For instance types with FPGA accelerators, specify `fpga` .\n- For instance types with GPU accelerators, specify `gpu` .\n- For instance types with Inference accelerators, specify `inference` .\n- For instance types with Media accelerators, specify `media` .\n\nDefault: Any accelerator type"},"allowedInstanceTypes":{"type":"array","items":{"type":"string"},"description":"The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.\n\nYou can use strings with one or more wild cards, represented by an asterisk ( `*` ), to allow an instance type, size, or generation. The following are examples: `m5.8xlarge` , `c5*.*` , `m5a.*` , `r*` , `*3*` .\n\nFor example, if you specify `c5*` ,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*` , Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.\n\n\u003e If you specify `AllowedInstanceTypes` , you can't specify `ExcludedInstanceTypes` . \n\nDefault: All instance types"},"bareMetal":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceRequirementsRequestBareMetal","description":"Indicates whether bare metal instance types must be included, excluded, or required.\n\n- To include bare metal instance types, specify `included` .\n- To require only bare metal instance types, specify `required` .\n- To exclude bare metal instance types, specify `excluded` .\n\nDefault: `excluded`"},"baselineEbsBandwidthMbps":{"$ref":"#/types/aws-native:ec2:SpotFleetBaselineEbsBandwidthMbpsRequest","description":"The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide* .\n\nDefault: No minimum or maximum limits"},"baselinePerformanceFactors":{"$ref":"#/types/aws-native:ec2:SpotFleetBaselinePerformanceFactorsRequest","description":"The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide* ."},"burstablePerformance":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceRequirementsRequestBurstablePerformance","description":"Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) .\n\n- To include burstable performance instance types, specify `included` .\n- To require only burstable performance instance types, specify `required` .\n- To exclude burstable performance instance types, specify `excluded` .\n\nDefault: `excluded`"},"cpuManufacturers":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceRequirementsRequestCpuManufacturersItem"},"description":"The CPU manufacturers to include.\n\n- For instance types with Intel CPUs, specify `intel` .\n- For instance types with AMD CPUs, specify `amd` .\n- For instance types with AWS CPUs, specify `amazon-web-services` .\n- For instance types with Apple CPUs, specify `apple` .\n\n\u003e Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. \n\nDefault: Any manufacturer"},"excludedInstanceTypes":{"type":"array","items":{"type":"string"},"description":"The instance types to exclude.\n\nYou can use strings with one or more wild cards, represented by an asterisk ( `*` ), to exclude an instance family, type, size, or generation. The following are examples: `m5.8xlarge` , `c5*.*` , `m5a.*` , `r*` , `*3*` .\n\nFor example, if you specify `c5*` ,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*` , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.\n\n\u003e If you specify `ExcludedInstanceTypes` , you can't specify `AllowedInstanceTypes` . \n\nDefault: No excluded instance types"},"instanceGenerations":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceRequirementsRequestInstanceGenerationsItem"},"description":"Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .\n\nFor current generation instance types, specify `current` .\n\nFor previous generation instance types, specify `previous` .\n\nDefault: Current and previous generation instance types"},"localStorage":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceRequirementsRequestLocalStorage","description":"Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide* .\n\n- To include instance types with instance store volumes, specify `included` .\n- To require only instance types with instance store volumes, specify `required` .\n- To exclude instance types with instance store volumes, specify `excluded` .\n\nDefault: `included`"},"localStorageTypes":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceRequirementsRequestLocalStorageTypesItem"},"description":"The type of local storage that is required.\n\n- For instance types with hard disk drive (HDD) storage, specify `hdd` .\n- For instance types with solid state drive (SSD) storage, specify `ssd` .\n\nDefault: `hdd` and `ssd`"},"maxSpotPriceAsPercentageOfOptimalOnDemandPrice":{"type":"integer","description":"[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n\nIf you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.\n\n\u003e Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999` ."},"memoryGiBPerVCpu":{"$ref":"#/types/aws-native:ec2:SpotFleetMemoryGiBPerVCpuRequest","description":"The minimum and maximum amount of memory per vCPU, in GiB.\n\nDefault: No minimum or maximum limits"},"memoryMiB":{"$ref":"#/types/aws-native:ec2:SpotFleetMemoryMiBRequest","description":"The minimum and maximum amount of memory, in MiB."},"networkBandwidthGbps":{"$ref":"#/types/aws-native:ec2:SpotFleetNetworkBandwidthGbpsRequest","description":"The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see [Amazon EC2 instance network bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html) in the *Amazon EC2 User Guide* .\n\nDefault: No minimum or maximum limits"},"networkInterfaceCount":{"$ref":"#/types/aws-native:ec2:SpotFleetNetworkInterfaceCountRequest","description":"The minimum and maximum number of network interfaces.\n\nDefault: No minimum or maximum limits"},"onDemandMaxPricePercentageOverLowestPrice":{"type":"integer","description":"[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.\n\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n\nTo indicate no price protection threshold, specify a high value, such as `999999` .\n\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .\n\n\u003e If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. \n\nDefault: `20`"},"requireEncryptionInTransit":{"type":"boolean","description":"Specifies whether instance types must support encrypting in-transit traffic between instances. For more information, including the supported instance types, see [Encryption in transit](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data-protection.html#encryption-transit) in the *Amazon EC2 User Guide* .\n\nDefault: `false`"},"requireHibernateSupport":{"type":"boolean","description":"Indicates whether instance types must support hibernation for On-Demand Instances.\n\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) .\n\nDefault: `false`"},"spotMaxPricePercentageOverLowestPrice":{"type":"integer","description":"[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.\n\nThe parameter accepts an integer, which Amazon EC2 interprets as a percentage.\n\nIf you set `TargetCapacityUnitType` to `vcpu` or `memory-mib` , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.\n\nThis parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) .\n\n\u003e Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999` . \n\nDefault: `100`"},"totalLocalStorageGb":{"$ref":"#/types/aws-native:ec2:SpotFleetTotalLocalStorageGbRequest","description":"The minimum and maximum amount of total local storage, in GB.\n\nDefault: No minimum or maximum limits"},"vCpuCount":{"$ref":"#/types/aws-native:ec2:SpotFleetVCpuCountRangeRequest","description":"The minimum and maximum number of vCPUs."}},"type":"object"},"aws-native:ec2:SpotFleetInstanceRequirementsRequestAcceleratorManufacturersItem":{"type":"string","enum":[{"name":"AmazonWebServices","value":"amazon-web-services"},{"name":"Amd","value":"amd"},{"name":"Habana","value":"habana"},{"name":"Nvidia","value":"nvidia"},{"name":"Xilinx","value":"xilinx"}]},"aws-native:ec2:SpotFleetInstanceRequirementsRequestAcceleratorNamesItem":{"type":"string","enum":[{"name":"A10g","value":"a10g"},{"name":"A100","value":"a100"},{"name":"H100","value":"h100"},{"name":"Inferentia","value":"inferentia"},{"name":"K520","value":"k520"},{"name":"K80","value":"k80"},{"name":"M60","value":"m60"},{"name":"RadeonProV520","value":"radeon-pro-v520"},{"name":"T4","value":"t4"},{"name":"T4g","value":"t4g"},{"name":"Vu9p","value":"vu9p"},{"name":"V100","value":"v100"},{"name":"L40s","value":"l40s"},{"name":"L4","value":"l4"},{"name":"GaudiHl205","value":"gaudi-hl-205"},{"name":"Inferentia2","value":"inferentia2"},{"name":"Trainium","value":"trainium"},{"name":"Trainium2","value":"trainium2"},{"name":"U30","value":"u30"}]},"aws-native:ec2:SpotFleetInstanceRequirementsRequestAcceleratorTypesItem":{"type":"string","enum":[{"name":"Gpu","value":"gpu"},{"name":"Fpga","value":"fpga"},{"name":"Inference","value":"inference"},{"name":"Media","value":"media"}]},"aws-native:ec2:SpotFleetInstanceRequirementsRequestBareMetal":{"description":"Indicates whether bare metal instance types must be included, excluded, or required.\n\n- To include bare metal instance types, specify `included` .\n- To require only bare metal instance types, specify `required` .\n- To exclude bare metal instance types, specify `excluded` .\n\nDefault: `excluded`","type":"string","enum":[{"name":"Included","value":"included"},{"name":"Required","value":"required"},{"name":"Excluded","value":"excluded"}]},"aws-native:ec2:SpotFleetInstanceRequirementsRequestBurstablePerformance":{"description":"Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) .\n\n- To include burstable performance instance types, specify `included` .\n- To require only burstable performance instance types, specify `required` .\n- To exclude burstable performance instance types, specify `excluded` .\n\nDefault: `excluded`","type":"string","enum":[{"name":"Included","value":"included"},{"name":"Required","value":"required"},{"name":"Excluded","value":"excluded"}]},"aws-native:ec2:SpotFleetInstanceRequirementsRequestCpuManufacturersItem":{"type":"string","enum":[{"name":"Intel","value":"intel"},{"name":"Amd","value":"amd"},{"name":"AmazonWebServices","value":"amazon-web-services"},{"name":"Apple","value":"apple"}]},"aws-native:ec2:SpotFleetInstanceRequirementsRequestInstanceGenerationsItem":{"type":"string","enum":[{"name":"Current","value":"current"},{"name":"Previous","value":"previous"}]},"aws-native:ec2:SpotFleetInstanceRequirementsRequestLocalStorage":{"description":"Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide* .\n\n- To include instance types with instance store volumes, specify `included` .\n- To require only instance types with instance store volumes, specify `required` .\n- To exclude instance types with instance store volumes, specify `excluded` .\n\nDefault: `included`","type":"string","enum":[{"name":"Included","value":"included"},{"name":"Required","value":"required"},{"name":"Excluded","value":"excluded"}]},"aws-native:ec2:SpotFleetInstanceRequirementsRequestLocalStorageTypesItem":{"type":"string","enum":[{"name":"Hdd","value":"hdd"},{"name":"Ssd","value":"ssd"}]},"aws-native:ec2:SpotFleetLaunchSpecification":{"properties":{"blockDeviceMappings":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetBlockDeviceMapping"},"description":"One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status."},"ebsOptimized":{"type":"boolean","description":"Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.\n\nDefault: `false`"},"iamInstanceProfile":{"$ref":"#/types/aws-native:ec2:SpotFleetIamInstanceProfileSpecification","description":"The IAM instance profile."},"imageId":{"type":"string","description":"The ID of the AMI."},"instanceRequirements":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceRequirementsRequest","description":"The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.\n\n\u003e If you specify `InstanceRequirements` , you can't specify `InstanceType` ."},"instanceType":{"type":"string","description":"The instance type."},"kernelId":{"type":"string","description":"The ID of the kernel."},"keyName":{"type":"string","description":"The name of the key pair."},"monitoring":{"$ref":"#/types/aws-native:ec2:SpotFleetMonitoring","description":"Enable or disable monitoring for the instances."},"networkInterfaces":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceNetworkInterfaceSpecification"},"description":"The network interfaces."},"placement":{"$ref":"#/types/aws-native:ec2:SpotFleetSpotPlacement","description":"The placement information."},"ramdiskId":{"type":"string","description":"The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the AWS Resource Center and search for the kernel ID."},"securityGroups":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetGroupIdentifier"},"description":"The security groups.\n\nIf you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter."},"spotPrice":{"type":"string","description":"The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n\n\u003e If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter."},"subnetId":{"type":"string","description":"The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".\n\nIf you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter."},"tagSpecifications":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetTagSpecification"},"description":"The tags to apply during creation."},"userData":{"type":"string","description":"The base64-encoded user data that instances use when starting up. User data is limited to 16 KB."},"weightedCapacity":{"type":"number","description":"The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.\n\nIf the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.\n\n\u003e When specifying weights, the price used in the `lowestPrice` and `priceCapacityOptimized` allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested `TargetCapacity` , resulting in only 1 instance being launched, the price used is per *instance* hour."}},"type":"object","required":["imageId"]},"aws-native:ec2:SpotFleetLaunchTemplateConfig":{"properties":{"launchTemplateSpecification":{"$ref":"#/types/aws-native:ec2:SpotFleetFleetLaunchTemplateSpecification","description":"The launch template to use. Make sure that the launch template does not contain the `NetworkInterfaceId` parameter because you can't specify a network interface ID in a Spot Fleet."},"overrides":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetLaunchTemplateOverrides"},"description":"Any parameters that you specify override the same parameters in the launch template."}},"type":"object"},"aws-native:ec2:SpotFleetLaunchTemplateOverrides":{"properties":{"availabilityZone":{"type":"string","description":"The Availability Zone in which to launch the instances. For example, `us-east-2a` .\n\nEither `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both."},"availabilityZoneId":{"type":"string","description":"The ID of the Availability Zone in which to launch the instances. For example, `use2-az1` .\n\nEither `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both."},"instanceRequirements":{"$ref":"#/types/aws-native:ec2:SpotFleetInstanceRequirementsRequest","description":"The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types.\n\n\u003e If you specify `InstanceRequirements` , you can't specify `InstanceType` ."},"instanceType":{"type":"string","description":"The instance type."},"priority":{"type":"number","description":"The priority for the launch template override. The highest priority is launched first.\n\nIf `OnDemandAllocationStrategy` is set to `prioritized` , Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.\n\nIf the Spot `AllocationStrategy` is set to `capacityOptimizedPrioritized` , Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.\n\nValid values are whole numbers starting at `0` . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides."},"spotPrice":{"type":"string","description":"The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n\n\u003e If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter."},"subnetId":{"type":"string","description":"The ID of the subnet in which to launch the instances."},"weightedCapacity":{"type":"number","description":"The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.\n\nIf the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.\n\n\u003e When specifying weights, the price used in the `lowestPrice` and `priceCapacityOptimized` allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested `TargetCapacity` , resulting in only 1 instance being launched, the price used is per *instance* hour."}},"type":"object"},"aws-native:ec2:SpotFleetLoadBalancersConfig":{"properties":{"classicLoadBalancersConfig":{"$ref":"#/types/aws-native:ec2:SpotFleetClassicLoadBalancersConfig","description":"The Classic Load Balancers."},"targetGroupsConfig":{"$ref":"#/types/aws-native:ec2:SpotFleetTargetGroupsConfig","description":"The target groups."}},"type":"object"},"aws-native:ec2:SpotFleetMemoryGiBPerVCpuRequest":{"properties":{"max":{"type":"number","description":"The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter."},"min":{"type":"number","description":"The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:SpotFleetMemoryMiBRequest":{"properties":{"max":{"type":"integer","description":"The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum amount of memory, in MiB. To specify no minimum limit, specify `0` ."}},"type":"object"},"aws-native:ec2:SpotFleetMonitoring":{"properties":{"enabled":{"type":"boolean","description":"Enables monitoring for the instance.\n\nDefault: `false`"}},"type":"object"},"aws-native:ec2:SpotFleetNetworkBandwidthGbpsRequest":{"properties":{"max":{"type":"number","description":"The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter."},"min":{"type":"number","description":"The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:SpotFleetNetworkInterfaceCountRequest":{"properties":{"max":{"type":"integer","description":"The maximum number of network interfaces. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum number of network interfaces. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:SpotFleetPerformanceFactorReferenceRequest":{"properties":{"instanceFamily":{"type":"string","description":"The instance family to use as a baseline reference.\n\n\u003e Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( `.` ) in the instance type name. For example, in the instance type `c6i.large` , the instance family is `c6i` , not `c6` . For more information, see [Amazon EC2 instance type naming conventions](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html) in *Amazon EC2 Instance Types* . \n\nThe following instance families are *not supported* for performance protection:\n\n- `c1`\n- `g3` | `g3s`\n- `hpc7g`\n- `m1` | `m2`\n- `mac1` | `mac2` | `mac2-m1ultra` | `mac2-m2` | `mac2-m2pro`\n- `p3dn` | `p4d` | `p5`\n- `t1`\n- `u-12tb1` | `u-18tb1` | `u-24tb1` | `u-3tb1` | `u-6tb1` | `u-9tb1` | `u7i-12tb` | `u7in-16tb` | `u7in-24tb` | `u7in-32tb`\n\nIf you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.\n\nIf you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html) and an exception for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet.html) , [RequestSpotFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html) , [ModifyFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyFleet.html) , and [ModifySpotFleetRequest](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifySpotFleetRequest.html) ."}},"type":"object"},"aws-native:ec2:SpotFleetPrivateIpAddressSpecification":{"properties":{"primary":{"type":"boolean","description":"Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary."},"privateIpAddress":{"type":"string","description":"The private IPv4 address."}},"type":"object","required":["privateIpAddress"]},"aws-native:ec2:SpotFleetRequestConfigData":{"properties":{"allocationStrategy":{"$ref":"#/types/aws-native:ec2:SpotFleetRequestConfigDataAllocationStrategy","description":"The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see [Allocation strategies for Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html) in the *Amazon EC2 User Guide* .\n\n- **priceCapacityOptimized (recommended)** - Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.\n- **capacityOptimized** - Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use `capacityOptimizedPrioritized` . Set a priority for each instance type by using the `Priority` parameter for `LaunchTemplateOverrides` . You can assign the same priority to different `LaunchTemplateOverrides` . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. `capacityOptimizedPrioritized` is supported only if your Spot Fleet uses a launch template. Note that if the `OnDemandAllocationStrategy` is set to `prioritized` , the same priority is applied when fulfilling On-Demand capacity.\n- **diversified** - Spot Fleet requests instances from all of the Spot Instance pools that you specify.\n- **lowestPrice (not recommended)** - \u003e We don't recommend the `lowestPrice` allocation strategy because it has the highest risk of interruption for your Spot Instances. \n\nSpot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.\n\nDefault: `lowestPrice`","replaceOnChanges":true},"context":{"type":"string","description":"Reserved."},"excessCapacityTerminationPolicy":{"$ref":"#/types/aws-native:ec2:SpotFleetRequestConfigDataExcessCapacityTerminationPolicy","description":"Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.\n\nSupported only for fleets of type `maintain` ."},"iamFleetRole":{"type":"string","description":"The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see [Spot Fleet Prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites) in the *Amazon EC2 User Guide* . Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request or when the Spot Fleet request expires, if you set `TerminateInstancesWithExpiration` .","replaceOnChanges":true},"instanceInterruptionBehavior":{"$ref":"#/types/aws-native:ec2:SpotFleetRequestConfigDataInstanceInterruptionBehavior","description":"The behavior when a Spot Instance is interrupted. The default is `terminate` .","replaceOnChanges":true},"instancePoolsToUseCount":{"type":"integer","description":"The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot *AllocationStrategy* is set to `lowest-price` . Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.\n\nNote that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.","replaceOnChanges":true},"launchSpecifications":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetLaunchSpecification"},"description":"The launch specifications for the Spot Fleet request. If you specify `LaunchSpecifications` , you can't specify `LaunchTemplateConfigs` .","replaceOnChanges":true},"launchTemplateConfigs":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetLaunchTemplateConfig"},"description":"The launch template and overrides. If you specify `LaunchTemplateConfigs` , you can't specify `LaunchSpecifications` .","replaceOnChanges":true},"loadBalancersConfig":{"$ref":"#/types/aws-native:ec2:SpotFleetLoadBalancersConfig","description":"One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.\n\nWith Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.","replaceOnChanges":true},"onDemandAllocationStrategy":{"type":"string","description":"The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify `lowestPrice` , Spot Fleet uses price to determine the order, launching the lowest price first. If you specify `prioritized` , Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to `lowestPrice` .","replaceOnChanges":true},"onDemandMaxTotalPrice":{"type":"string","description":"The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the `onDemandMaxTotalPrice` parameter, the `spotMaxTotalPrice` parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.\n\n\u003e If your fleet includes T instances that are configured as `unlimited` , and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `onDemandMaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `onDemandMaxTotalPrice` . For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide* .","replaceOnChanges":true},"onDemandTargetCapacity":{"type":"integer","description":"The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is `maintain` , you can specify a target capacity of 0 and add capacity later.","replaceOnChanges":true},"replaceUnhealthyInstances":{"type":"boolean","description":"Indicates whether Spot Fleet should replace unhealthy instances.","replaceOnChanges":true},"spotMaintenanceStrategies":{"$ref":"#/types/aws-native:ec2:SpotFleetSpotMaintenanceStrategies","description":"The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.","replaceOnChanges":true},"spotMaxTotalPrice":{"type":"string","description":"The maximum amount per hour for Spot Instances that you're willing to pay. You can use the `spotMaxTotalPrice` parameter, the `onDemandMaxTotalPrice` parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.\n\n\u003e If your fleet includes T instances that are configured as `unlimited` , and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `spotMaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `spotMaxTotalPrice` . For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide* .","replaceOnChanges":true},"spotPrice":{"type":"string","description":"The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.\n\n\u003e If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.","replaceOnChanges":true},"tagSpecifications":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetTagSpecification"},"description":"The key-value pair for tagging the Spot Fleet request on creation. The value for `ResourceType` must be `spot-fleet-request` , otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the [launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) (valid only if you use `LaunchTemplateConfigs` ) or in the `[SpotFleetTagSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html)` (valid only if you use `LaunchSpecifications` ). For information about tagging after launch, see [Tag your resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources) .","replaceOnChanges":true},"targetCapacity":{"type":"integer","description":"The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is `maintain` , you can specify a target capacity of 0 and add capacity later."},"targetCapacityUnitType":{"$ref":"#/types/aws-native:ec2:SpotFleetRequestConfigDataTargetCapacityUnitType","description":"The unit for the target capacity. You can specify this parameter only when using attribute-based instance type selection.\n\nDefault: `units` (the number of instances)"},"terminateInstancesWithExpiration":{"type":"boolean","description":"Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.","replaceOnChanges":true},"type":{"$ref":"#/types/aws-native:ec2:SpotFleetRequestConfigDataType","description":"The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is `request` , the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is `maintain` , the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: `maintain` . `instant` is listed but is not used by Spot Fleet.","replaceOnChanges":true},"validFrom":{"type":"string","description":"The start date and time of the request, in UTC format ( *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z). By default, Amazon EC2 starts fulfilling the request immediately.","replaceOnChanges":true},"validUntil":{"type":"string","description":"The end date and time of the request, in UTC format ( *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.","replaceOnChanges":true}},"type":"object","required":["iamFleetRole","targetCapacity"]},"aws-native:ec2:SpotFleetRequestConfigDataAllocationStrategy":{"description":"The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see [Allocation strategies for Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html) in the *Amazon EC2 User Guide* .\n\n- **priceCapacityOptimized (recommended)** - Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.\n- **capacityOptimized** - Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use `capacityOptimizedPrioritized` . Set a priority for each instance type by using the `Priority` parameter for `LaunchTemplateOverrides` . You can assign the same priority to different `LaunchTemplateOverrides` . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. `capacityOptimizedPrioritized` is supported only if your Spot Fleet uses a launch template. Note that if the `OnDemandAllocationStrategy` is set to `prioritized` , the same priority is applied when fulfilling On-Demand capacity.\n- **diversified** - Spot Fleet requests instances from all of the Spot Instance pools that you specify.\n- **lowestPrice (not recommended)** - \u003e We don't recommend the `lowestPrice` allocation strategy because it has the highest risk of interruption for your Spot Instances. \n\nSpot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.\n\nDefault: `lowestPrice`","type":"string","enum":[{"name":"CapacityOptimized","value":"capacityOptimized"},{"name":"CapacityOptimizedPrioritized","value":"capacityOptimizedPrioritized"},{"name":"Diversified","value":"diversified"},{"name":"LowestPrice","value":"lowestPrice"},{"name":"PriceCapacityOptimized","value":"priceCapacityOptimized"}]},"aws-native:ec2:SpotFleetRequestConfigDataExcessCapacityTerminationPolicy":{"description":"Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.\n\nSupported only for fleets of type `maintain` .","type":"string","enum":[{"name":"Default","value":"Default"},{"name":"NoTermination","value":"NoTermination"}]},"aws-native:ec2:SpotFleetRequestConfigDataInstanceInterruptionBehavior":{"description":"The behavior when a Spot Instance is interrupted. The default is `terminate` .","type":"string","enum":[{"name":"Hibernate","value":"hibernate"},{"name":"Stop","value":"stop"},{"name":"Terminate","value":"terminate"}]},"aws-native:ec2:SpotFleetRequestConfigDataTargetCapacityUnitType":{"description":"The unit for the target capacity. You can specify this parameter only when using attribute-based instance type selection.\n\nDefault: `units` (the number of instances)","type":"string","enum":[{"name":"Vcpu","value":"vcpu"},{"name":"MemoryMib","value":"memory-mib"},{"name":"Units","value":"units"}]},"aws-native:ec2:SpotFleetRequestConfigDataType":{"description":"The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is `request` , the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is `maintain` , the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: `maintain` . `instant` is listed but is not used by Spot Fleet.","type":"string","enum":[{"name":"Maintain","value":"maintain"},{"name":"Request","value":"request"}]},"aws-native:ec2:SpotFleetSpotCapacityRebalance":{"properties":{"replacementStrategy":{"$ref":"#/types/aws-native:ec2:SpotFleetSpotCapacityRebalanceReplacementStrategy","description":"The replacement strategy to use. Only available for fleets of type `maintain` .\n\n`launch` - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.\n\n`launch-before-terminate` - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in `TerminationDelay` ), terminates the instances that received a rebalance notification."},"terminationDelay":{"type":"integer","description":"The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.\n\nRequired when `ReplacementStrategy` is set to `launch-before-terminate` .\n\nNot valid when `ReplacementStrategy` is set to `launch` .\n\nValid values: Minimum value of `120` seconds. Maximum value of `7200` seconds."}},"type":"object"},"aws-native:ec2:SpotFleetSpotCapacityRebalanceReplacementStrategy":{"description":"The replacement strategy to use. Only available for fleets of type `maintain` .\n\n`launch` - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.\n\n`launch-before-terminate` - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in `TerminationDelay` ), terminates the instances that received a rebalance notification.","type":"string","enum":[{"name":"Launch","value":"launch"},{"name":"LaunchBeforeTerminate","value":"launch-before-terminate"}]},"aws-native:ec2:SpotFleetSpotMaintenanceStrategies":{"properties":{"capacityRebalance":{"$ref":"#/types/aws-native:ec2:SpotFleetSpotCapacityRebalance","description":"The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see [Capacity rebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) in the *Amazon EC2 User Guide* ."}},"type":"object"},"aws-native:ec2:SpotFleetSpotPlacement":{"properties":{"availabilityZone":{"type":"string","description":"The Availability Zone.\n\nTo specify multiple Availability Zones, separate them using commas; for example, \"us-west-2a, us-west-2b\"."},"availabilityZoneId":{"type":"string","description":"The ID of the Availability Zone. For example, `use2-az1` .\n\n[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, \" `use2-az1` , `use2-bz1` \".\n\nEither `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both."},"groupName":{"type":"string","description":"The name of the placement group."},"tenancy":{"$ref":"#/types/aws-native:ec2:SpotFleetSpotPlacementTenancy","description":"The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of `dedicated` runs on single-tenant hardware. The `host` tenancy is not supported for Spot Instances."}},"type":"object"},"aws-native:ec2:SpotFleetSpotPlacementTenancy":{"description":"The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of `dedicated` runs on single-tenant hardware. The `host` tenancy is not supported for Spot Instances.","type":"string","enum":[{"name":"Dedicated","value":"dedicated"},{"name":"Default","value":"default"},{"name":"Host","value":"host"}]},"aws-native:ec2:SpotFleetTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:SpotFleetTagSpecification":{"properties":{"resourceType":{"$ref":"#/types/aws-native:ec2:SpotFleetTagSpecificationResourceType","description":"The type of resource. Currently, the only resource type that is supported is `instance` . To tag the Spot Fleet request on creation, use the `TagSpecifications` parameter in `[SpotFleetRequestConfigData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html)` ."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetTag"},"description":"The tags."}},"type":"object"},"aws-native:ec2:SpotFleetTagSpecificationResourceType":{"description":"The type of resource. Currently, the only resource type that is supported is `instance` . To tag the Spot Fleet request on creation, use the `TagSpecifications` parameter in `[SpotFleetRequestConfigData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html)` .","type":"string","enum":[{"name":"ClientVpnEndpoint","value":"client-vpn-endpoint"},{"name":"CustomerGateway","value":"customer-gateway"},{"name":"DedicatedHost","value":"dedicated-host"},{"name":"DhcpOptions","value":"dhcp-options"},{"name":"EgressOnlyInternetGateway","value":"egress-only-internet-gateway"},{"name":"ElasticGpu","value":"elastic-gpu"},{"name":"ElasticIp","value":"elastic-ip"},{"name":"ExportImageTask","value":"export-image-task"},{"name":"ExportInstanceTask","value":"export-instance-task"},{"name":"Fleet","value":"fleet"},{"name":"FpgaImage","value":"fpga-image"},{"name":"HostReservation","value":"host-reservation"},{"name":"Image","value":"image"},{"name":"ImportImageTask","value":"import-image-task"},{"name":"ImportSnapshotTask","value":"import-snapshot-task"},{"name":"Instance","value":"instance"},{"name":"InternetGateway","value":"internet-gateway"},{"name":"KeyPair","value":"key-pair"},{"name":"LaunchTemplate","value":"launch-template"},{"name":"LocalGatewayRouteTableVpcAssociation","value":"local-gateway-route-table-vpc-association"},{"name":"Natgateway","value":"natgateway"},{"name":"NetworkAcl","value":"network-acl"},{"name":"NetworkInsightsAnalysis","value":"network-insights-analysis"},{"name":"NetworkInsightsPath","value":"network-insights-path"},{"name":"NetworkInterface","value":"network-interface"},{"name":"PlacementGroup","value":"placement-group"},{"name":"ReservedInstances","value":"reserved-instances"},{"name":"RouteTable","value":"route-table"},{"name":"SecurityGroup","value":"security-group"},{"name":"Snapshot","value":"snapshot"},{"name":"SpotFleetRequest","value":"spot-fleet-request"},{"name":"SpotInstancesRequest","value":"spot-instances-request"},{"name":"Subnet","value":"subnet"},{"name":"TrafficMirrorFilter","value":"traffic-mirror-filter"},{"name":"TrafficMirrorSession","value":"traffic-mirror-session"},{"name":"TrafficMirrorTarget","value":"traffic-mirror-target"},{"name":"TransitGateway","value":"transit-gateway"},{"name":"TransitGatewayAttachment","value":"transit-gateway-attachment"},{"name":"TransitGatewayConnectPeer","value":"transit-gateway-connect-peer"},{"name":"TransitGatewayMulticastDomain","value":"transit-gateway-multicast-domain"},{"name":"TransitGatewayRouteTable","value":"transit-gateway-route-table"},{"name":"Volume","value":"volume"},{"name":"Vpc","value":"vpc"},{"name":"VpcFlowLog","value":"vpc-flow-log"},{"name":"VpcPeeringConnection","value":"vpc-peering-connection"},{"name":"VpnConnection","value":"vpn-connection"},{"name":"VpnGateway","value":"vpn-gateway"}]},"aws-native:ec2:SpotFleetTargetGroup":{"properties":{"arn":{"type":"string","description":"The Amazon Resource Name (ARN) of the target group."}},"type":"object","required":["arn"]},"aws-native:ec2:SpotFleetTargetGroupsConfig":{"properties":{"targetGroups":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:SpotFleetTargetGroup"},"description":"One or more target groups."}},"type":"object","required":["targetGroups"]},"aws-native:ec2:SpotFleetTotalLocalStorageGbRequest":{"properties":{"max":{"type":"number","description":"The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter."},"min":{"type":"number","description":"The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter."}},"type":"object"},"aws-native:ec2:SpotFleetVCpuCountRangeRequest":{"properties":{"max":{"type":"integer","description":"The maximum number of vCPUs. To specify no maximum limit, omit this parameter."},"min":{"type":"integer","description":"The minimum number of vCPUs. To specify no minimum limit, specify `0` ."}},"type":"object"},"aws-native:ec2:SseSpecificationProperties":{"description":"The configuration options for customer provided KMS encryption.","properties":{"customerManagedKeyEnabled":{"type":"boolean","description":"Whether to encrypt the policy with the provided key or disable encryption"},"kmsKeyArn":{"type":"string","description":"KMS Key Arn used to encrypt the group policy"}},"type":"object"},"aws-native:ec2:SubnetTag":{"description":"Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:TagSpecification":{"description":"Specifies the tags to apply to resources that are created during instance launch.\n ``TagSpecification`` is a property type of [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications). [TagSpecifications](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html).","properties":{"resourceType":{"type":"string","description":"The type of resource to tag. You can specify tags for the following resource types only: ``instance`` | ``volume`` | ``network-interface`` | ``spot-instances-request``. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume.\n To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html)."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:LaunchTemplateTag"},"description":"The tags to apply to the resource."}},"type":"object"},"aws-native:ec2:TrafficMirrorFilterRuleTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:TrafficMirrorFilterRuleTrafficMirrorPortRange":{"properties":{"fromPort":{"type":"integer","description":"The first port in the Traffic Mirror port range."},"toPort":{"type":"integer","description":"The last port in the Traffic Mirror port range."}},"type":"object","required":["fromPort","toPort"]},"aws-native:ec2:TrafficMirrorFilterTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:TrafficMirrorFilterTrafficMirrorNetworkService":{"description":"The network service traffic that is associated with the traffic mirror filter.","type":"string","enum":[{"name":"AmazonDns","value":"amazon-dns"}]},"aws-native:ec2:TrafficMirrorSessionTag":{"description":"A key-value pair to associate with a traffic mirror session resource.","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:TrafficMirrorTargetTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:TransitGatewayAttachmentTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:TransitGatewayConnectOptions":{"properties":{"protocol":{"type":"string","description":"The tunnel protocol."}},"type":"object"},"aws-native:ec2:TransitGatewayConnectPeerConfiguration":{"properties":{"bgpConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:TransitGatewayConnectPeerTransitGatewayAttachmentBgpConfiguration"},"description":"The BGP configuration details."},"insideCidrBlocks":{"type":"array","items":{"type":"string"},"description":"The range of interior BGP peer IP addresses.","replaceOnChanges":true},"peerAddress":{"type":"string","description":"The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.","replaceOnChanges":true},"protocol":{"type":"string","description":"The tunnel protocol."},"transitGatewayAddress":{"type":"string","description":"The Connect peer IP address on the transit gateway side of the tunnel.","replaceOnChanges":true}},"type":"object","required":["insideCidrBlocks","peerAddress"]},"aws-native:ec2:TransitGatewayConnectPeerTag":{"properties":{"key":{"type":"string","description":"The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: ."},"value":{"type":"string","description":"The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters."}},"type":"object"},"aws-native:ec2:TransitGatewayConnectPeerTransitGatewayAttachmentBgpConfiguration":{"properties":{"bgpStatus":{"type":"string","description":"The BGP status."},"peerAddress":{"type":"string","description":"The interior BGP peer IP address for the appliance."},"peerAsn":{"type":"number","description":"The peer Autonomous System Number (ASN).","replaceOnChanges":true},"transitGatewayAddress":{"type":"string","description":"The interior BGP peer IP address for the transit gateway."},"transitGatewayAsn":{"type":"number","description":"The transit gateway Autonomous System Number (ASN)."}},"type":"object"},"aws-native:ec2:TransitGatewayConnectTag":{"properties":{"key":{"type":"string","description":"The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:."},"value":{"type":"string","description":"The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters."}},"type":"object"},"aws-native:ec2:TransitGatewayEncryptionSupport":{"description":"Enable or disable encryption support. Disabled by default.","type":"string","enum":[{"name":"Disable","value":"disable"},{"name":"Enable","value":"enable"}]},"aws-native:ec2:TransitGatewayMeteringPolicyEntryTransitGatewayAttachmentResourceType":{"type":"string","enum":[{"name":"Vpc","value":"vpc"},{"name":"Vpn","value":"vpn"},{"name":"DirectConnectGateway","value":"direct-connect-gateway"},{"name":"Peering","value":"peering"},{"name":"NetworkFunction","value":"network-function"},{"name":"VpnConcentrator","value":"vpn-concentrator"}]},"aws-native:ec2:TransitGatewayMeteringPolicyEntryTransitGatewayMeteringPayerType":{"type":"string","enum":[{"name":"SourceAttachmentOwner","value":"source-attachment-owner"},{"name":"DestinationAttachmentOwner","value":"destination-attachment-owner"},{"name":"TransitGatewayOwner","value":"transit-gateway-owner"}]},"aws-native:ec2:TransitGatewayMeteringPolicyTag":{"properties":{"key":{"type":"string","description":"The key of the tag.\n\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with `aws:` ."},"value":{"type":"string","description":"The value of the tag.\n\nConstraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters."}},"type":"object","required":["key","value"]},"aws-native:ec2:TransitGatewayMulticastDomainTag":{"properties":{"key":{"type":"string","description":"The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:."},"value":{"type":"string","description":"The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters."}},"type":"object"},"aws-native:ec2:TransitGatewayPeeringAttachmentPeeringAttachmentStatus":{"properties":{"code":{"type":"string","description":"The status code."},"message":{"type":"string","description":"The status message, if applicable."}},"type":"object"},"aws-native:ec2:TransitGatewayPeeringAttachmentTag":{"properties":{"key":{"type":"string","description":"The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:."},"value":{"type":"string","description":"The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters."}},"type":"object"},"aws-native:ec2:TransitGatewayRouteTableTag":{"properties":{"key":{"type":"string","description":"The key of the associated tag key-value pair"},"value":{"type":"string","description":"The value of the associated tag key-value pair"}},"type":"object","required":["key","value"]},"aws-native:ec2:TransitGatewayTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:TransitGatewayVpcAttachmentTag":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:VerifiedAccessEndpointCidrOptions":{"description":"The options for cidr type endpoint.","properties":{"cidr":{"type":"string","description":"The IP address range, in CIDR notation.","replaceOnChanges":true},"portRanges":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:VerifiedAccessEndpointPortRange"},"description":"The list of port range."},"protocol":{"type":"string","description":"The IP protocol.","replaceOnChanges":true},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The IDs of the subnets.","replaceOnChanges":true}},"type":"object"},"aws-native:ec2:VerifiedAccessEndpointLoadBalancerOptions":{"description":"The load balancer details if creating the AWS Verified Access endpoint as load-balancertype.","properties":{"loadBalancerArn":{"type":"string","description":"The ARN of the load balancer.","replaceOnChanges":true},"port":{"type":"integer","description":"The IP port number."},"portRanges":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:VerifiedAccessEndpointPortRange"},"description":"The list of port range."},"protocol":{"type":"string","description":"The IP protocol."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The IDs of the subnets."}},"type":"object"},"aws-native:ec2:VerifiedAccessEndpointNetworkInterfaceOptions":{"description":"The options for network-interface type endpoint.","properties":{"networkInterfaceId":{"type":"string","description":"The ID of the network interface.","replaceOnChanges":true},"port":{"type":"integer","description":"The IP port number."},"portRanges":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:VerifiedAccessEndpointPortRange"},"description":"The list of port ranges."},"protocol":{"type":"string","description":"The IP protocol."}},"type":"object"},"aws-native:ec2:VerifiedAccessEndpointPortRange":{"description":"The IP port range.","properties":{"fromPort":{"type":"integer","description":"The first port in the range."},"toPort":{"type":"integer","description":"The last port in the range."}},"type":"object"},"aws-native:ec2:VerifiedAccessEndpointRdsOptions":{"description":"The options for rds type endpoint.","properties":{"port":{"type":"integer","description":"The IP port number."},"protocol":{"type":"string","description":"The IP protocol.","replaceOnChanges":true},"rdsDbClusterArn":{"type":"string","description":"The ARN of the RDS DB cluster.","replaceOnChanges":true},"rdsDbInstanceArn":{"type":"string","description":"The ARN of the RDS DB instance.","replaceOnChanges":true},"rdsDbProxyArn":{"type":"string","description":"The ARN of the RDS DB proxy.","replaceOnChanges":true},"rdsEndpoint":{"type":"string","description":"The RDS endpoint."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The IDs of the subnets."}},"type":"object"},"aws-native:ec2:VerifiedAccessEndpointSseSpecification":{"description":"The configuration options for customer provided KMS encryption.","properties":{"customerManagedKeyEnabled":{"type":"boolean","description":"Whether to encrypt the policy with the provided key or disable encryption"},"kmsKeyArn":{"type":"string","description":"KMS Key Arn used to encrypt the group policy"}},"type":"object"},"aws-native:ec2:VerifiedAccessEndpointTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:VerifiedAccessGroupSseSpecification":{"description":"The configuration options for customer provided KMS encryption.","properties":{"customerManagedKeyEnabled":{"type":"boolean","description":"Whether to encrypt the policy with the provided key or disable encryption"},"kmsKeyArn":{"type":"string","description":"KMS Key Arn used to encrypt the group policy"}},"type":"object"},"aws-native:ec2:VerifiedAccessGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:VerifiedAccessInstanceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:VerifiedAccessInstanceVerifiedAccessLogs":{"description":"The configuration options for AWS Verified Access instances.","properties":{"cloudWatchLogs":{"$ref":"#/types/aws-native:ec2:VerifiedAccessInstanceVerifiedAccessLogsCloudWatchLogsProperties","description":"Sends Verified Access logs to CloudWatch Logs."},"includeTrustContext":{"type":"boolean","description":"Include claims from trust providers in Verified Access logs."},"kinesisDataFirehose":{"$ref":"#/types/aws-native:ec2:VerifiedAccessInstanceVerifiedAccessLogsKinesisDataFirehoseProperties","description":"Sends Verified Access logs to Kinesis."},"logVersion":{"type":"string","description":"Select log version for Verified Access logs."},"s3":{"$ref":"#/types/aws-native:ec2:VerifiedAccessInstanceVerifiedAccessLogsS3Properties","description":"Sends Verified Access logs to Amazon S3."}},"type":"object"},"aws-native:ec2:VerifiedAccessInstanceVerifiedAccessLogsCloudWatchLogsProperties":{"description":"Sends Verified Access logs to CloudWatch Logs.","properties":{"enabled":{"type":"boolean","description":"Indicates whether logging is enabled."},"logGroup":{"type":"string","description":"The ID of the CloudWatch Logs log group."}},"type":"object"},"aws-native:ec2:VerifiedAccessInstanceVerifiedAccessLogsKinesisDataFirehoseProperties":{"description":"Sends Verified Access logs to Kinesis.","properties":{"deliveryStream":{"type":"string","description":"The ID of the delivery stream."},"enabled":{"type":"boolean","description":"Indicates whether logging is enabled."}},"type":"object"},"aws-native:ec2:VerifiedAccessInstanceVerifiedAccessLogsS3Properties":{"description":"Sends Verified Access logs to Amazon S3.","properties":{"bucketName":{"type":"string","description":"The bucket name."},"bucketOwner":{"type":"string","description":"The ID of the AWS account that owns the Amazon S3 bucket."},"enabled":{"type":"boolean","description":"Indicates whether logging is enabled."},"prefix":{"type":"string","description":"The bucket prefix."}},"type":"object"},"aws-native:ec2:VerifiedAccessInstanceVerifiedAccessTrustProvider":{"description":"A Verified Access Trust Provider.","properties":{"description":{"type":"string","description":"The description of trust provider."},"deviceTrustProviderType":{"type":"string","description":"The type of device-based trust provider."},"trustProviderType":{"type":"string","description":"The type of trust provider (user- or device-based)."},"userTrustProviderType":{"type":"string","description":"The type of user-based trust provider."},"verifiedAccessTrustProviderId":{"type":"string","description":"The ID of the trust provider."}},"type":"object"},"aws-native:ec2:VerifiedAccessTrustProviderDeviceOptions":{"description":"The options for device identity based trust providers.","properties":{"publicSigningKeyUrl":{"type":"string","description":"URL Verified Access will use to verify authenticity of the device tokens."},"tenantId":{"type":"string","description":"The ID of the tenant application with the device-identity provider."}},"type":"object"},"aws-native:ec2:VerifiedAccessTrustProviderNativeApplicationOidcOptions":{"description":"The OpenID Connect details for an oidc -type, user-identity based trust provider for L4.","properties":{"authorizationEndpoint":{"type":"string","description":"The OIDC authorization endpoint."},"clientId":{"type":"string","description":"The client identifier."},"clientSecret":{"type":"string","description":"The client secret."},"issuer":{"type":"string","description":"The OIDC issuer."},"publicSigningKeyEndpoint":{"type":"string","description":"The public signing key for endpoint"},"scope":{"type":"string","description":"OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to details of a user. Each scope returns a specific set of user attributes."},"tokenEndpoint":{"type":"string","description":"The OIDC token endpoint."},"userInfoEndpoint":{"type":"string","description":"The OIDC user info endpoint."}},"type":"object"},"aws-native:ec2:VerifiedAccessTrustProviderOidcOptions":{"description":"The OpenID Connect details for an oidc -type, user-identity based trust provider.","properties":{"authorizationEndpoint":{"type":"string","description":"The OIDC authorization endpoint."},"clientId":{"type":"string","description":"The client identifier."},"clientSecret":{"type":"string","description":"The client secret."},"issuer":{"type":"string","description":"The OIDC issuer."},"scope":{"type":"string","description":"OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to details of a user. Each scope returns a specific set of user attributes."},"tokenEndpoint":{"type":"string","description":"The OIDC token endpoint."},"userInfoEndpoint":{"type":"string","description":"The OIDC user info endpoint."}},"type":"object"},"aws-native:ec2:VerifiedAccessTrustProviderTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:VolumeTag":{"description":"Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:VpcBlockPublicAccessExclusionInternetGatewayExclusionMode":{"description":"The desired Block Public Access Exclusion Mode for a specific VPC/Subnet.","type":"string","enum":[{"name":"AllowBidirectional","value":"allow-bidirectional"},{"name":"AllowEgress","value":"allow-egress"}]},"aws-native:ec2:VpcBlockPublicAccessExclusionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:VpcBlockPublicAccessOptionsInternetGatewayBlockMode":{"description":"The desired Block Public Access mode for Internet Gateways in your account. We do not allow to create in a off mode as this is the default value","type":"string","enum":[{"name":"BlockBidirectional","value":"block-bidirectional"},{"name":"BlockIngress","value":"block-ingress"}]},"aws-native:ec2:VpcEncryptionControlEgressOnlyInternetGatewayExclusionInput":{"description":"Used to enable or disable EIGW exclusion","type":"string","enum":[{"name":"Enable","value":"enable"},{"name":"Disable","value":"disable"}]},"aws-native:ec2:VpcEncryptionControlElasticFileSystemExclusionInput":{"description":"Used to enable or disable EFS exclusion","type":"string","enum":[{"name":"Enable","value":"enable"},{"name":"Disable","value":"disable"}]},"aws-native:ec2:VpcEncryptionControlExclusion":{"properties":{"state":{"type":"string","description":"The current state of the exclusion configuration."},"stateMessage":{"type":"string","description":"A message providing additional information about the exclusion state."}},"type":"object"},"aws-native:ec2:VpcEncryptionControlInternetGatewayExclusionInput":{"description":"Used to enable or disable IGW exclusion","type":"string","enum":[{"name":"Enable","value":"enable"},{"name":"Disable","value":"disable"}]},"aws-native:ec2:VpcEncryptionControlLambdaExclusionInput":{"description":"Used to enable or disable Lambda exclusion","type":"string","enum":[{"name":"Enable","value":"enable"},{"name":"Disable","value":"disable"}]},"aws-native:ec2:VpcEncryptionControlMode":{"description":"The VPC encryption control mode, either monitor or enforce.","type":"string","enum":[{"name":"Monitor","value":"monitor"},{"name":"Enforce","value":"enforce"}]},"aws-native:ec2:VpcEncryptionControlNatGatewayExclusionInput":{"description":"Used to enable or disable Nat gateway exclusion","type":"string","enum":[{"name":"Enable","value":"enable"},{"name":"Disable","value":"disable"}]},"aws-native:ec2:VpcEncryptionControlResourceExclusions":{"properties":{"egressOnlyInternetGateway":{"$ref":"#/types/aws-native:ec2:VpcEncryptionControlExclusion","description":"Specifies whether to exclude egress-only internet gateway traffic from encryption enforcement."},"elasticFileSystem":{"$ref":"#/types/aws-native:ec2:VpcEncryptionControlExclusion","description":"Specifies whether to exclude Elastic File System traffic from encryption enforcement."},"internetGateway":{"$ref":"#/types/aws-native:ec2:VpcEncryptionControlExclusion","description":"Specifies whether to exclude internet gateway traffic from encryption enforcement."},"lambda":{"$ref":"#/types/aws-native:ec2:VpcEncryptionControlExclusion","description":"Specifies whether to exclude Lambda function traffic from encryption enforcement."},"natGateway":{"$ref":"#/types/aws-native:ec2:VpcEncryptionControlExclusion","description":"Specifies whether to exclude NAT gateway traffic from encryption enforcement."},"virtualPrivateGateway":{"$ref":"#/types/aws-native:ec2:VpcEncryptionControlExclusion","description":"Specifies whether to exclude virtual private gateway traffic from encryption enforcement."},"vpcLattice":{"$ref":"#/types/aws-native:ec2:VpcEncryptionControlExclusion","description":"Specifies whether to exclude VPC Lattice traffic from encryption enforcement."},"vpcPeering":{"$ref":"#/types/aws-native:ec2:VpcEncryptionControlExclusion","description":"Specifies whether to exclude VPC peering connection traffic from encryption enforcement."}},"type":"object"},"aws-native:ec2:VpcEncryptionControlState":{"description":"The current state of the VPC encryption control.","type":"string","enum":[{"name":"Creating","value":"creating"},{"name":"Available","value":"available"},{"name":"MonitorInProgress","value":"monitor-in-progress"},{"name":"EnforceInProgress","value":"enforce-in-progress"},{"name":"MonitorFailed","value":"monitor-failed"},{"name":"EnforceFailed","value":"enforce-failed"},{"name":"Deleting","value":"deleting"},{"name":"Deleted","value":"deleted"},{"name":"DeleteFailed","value":"delete-failed"}]},"aws-native:ec2:VpcEncryptionControlTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:VpcEncryptionControlVirtualPrivateGatewayExclusionInput":{"description":"Used to enable or disable VGW exclusion","type":"string","enum":[{"name":"Enable","value":"enable"},{"name":"Disable","value":"disable"}]},"aws-native:ec2:VpcEncryptionControlVpcLatticeExclusionInput":{"description":"Used to enable or disable Vpc Lattice exclusion","type":"string","enum":[{"name":"Enable","value":"enable"},{"name":"Disable","value":"disable"}]},"aws-native:ec2:VpcEncryptionControlVpcPeeringExclusionInput":{"description":"Used to enable or disable VPC peering exclusion","type":"string","enum":[{"name":"Enable","value":"enable"},{"name":"Disable","value":"disable"}]},"aws-native:ec2:VpcEndpointDnsOptionsSpecification":{"description":"Describes the DNS options for an endpoint.","properties":{"dnsRecordIpType":{"$ref":"#/types/aws-native:ec2:VpcEndpointDnsOptionsSpecificationDnsRecordIpType","description":"The DNS records created for the endpoint."},"privateDnsOnlyForInboundResolverEndpoint":{"$ref":"#/types/aws-native:ec2:VpcEndpointDnsOptionsSpecificationPrivateDnsOnlyForInboundResolverEndpoint","description":"Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint."},"privateDnsPreference":{"$ref":"#/types/aws-native:ec2:VpcEndpointDnsOptionsSpecificationPrivateDnsPreference","description":"The preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.","replaceOnChanges":true},"privateDnsSpecifiedDomains":{"type":"array","items":{"type":"string"},"description":"Indicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is ``VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS`` or ``SPECIFIED_DOMAINS_ONLY``.","replaceOnChanges":true}},"type":"object"},"aws-native:ec2:VpcEndpointDnsOptionsSpecificationDnsRecordIpType":{"description":"The DNS records created for the endpoint.","type":"string","enum":[{"name":"Ipv4","value":"ipv4"},{"name":"Ipv6","value":"ipv6"},{"name":"Dualstack","value":"dualstack"},{"name":"ServiceDefined","value":"service-defined"},{"name":"NotSpecified","value":"not-specified"}]},"aws-native:ec2:VpcEndpointDnsOptionsSpecificationPrivateDnsOnlyForInboundResolverEndpoint":{"description":"Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.","type":"string","enum":[{"name":"OnlyInboundResolver","value":"OnlyInboundResolver"},{"name":"AllResolvers","value":"AllResolvers"},{"name":"NotSpecified","value":"NotSpecified"}]},"aws-native:ec2:VpcEndpointDnsOptionsSpecificationPrivateDnsPreference":{"description":"The preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.","type":"string","enum":[{"name":"VerifiedDomainsOnly","value":"VERIFIED_DOMAINS_ONLY"},{"name":"AllDomains","value":"ALL_DOMAINS"},{"name":"VerifiedDomainsAndSpecifiedDomains","value":"VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS"},{"name":"SpecifiedDomainsOnly","value":"SPECIFIED_DOMAINS_ONLY"}]},"aws-native:ec2:VpcEndpointIpAddressType":{"description":"The supported IP address types.","type":"string","enum":[{"name":"Ipv4","value":"ipv4"},{"name":"Ipv6","value":"ipv6"},{"name":"Dualstack","value":"dualstack"},{"name":"NotSpecified","value":"not-specified"}]},"aws-native:ec2:VpcEndpointServiceIpAddressType":{"type":"string","enum":[{"name":"Ipv4","value":"ipv4"},{"name":"Ipv6","value":"ipv6"}]},"aws-native:ec2:VpcEndpointServiceTag":{"properties":{"key":{"type":"string","description":"The key of the tag.\n\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with `aws:` ."},"value":{"type":"string","description":"The value of the tag.\n\nConstraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters."}},"type":"object","required":["key","value"]},"aws-native:ec2:VpcEndpointTag":{"description":"Describes a tag.","properties":{"key":{"type":"string","description":"The key of the tag.\n Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with ``aws:``."},"value":{"type":"string","description":"The value of the tag.\n Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters."}},"type":"object","required":["key","value"]},"aws-native:ec2:VpcEndpointType":{"description":"The type of endpoint.\n Default: Gateway","type":"string","enum":[{"name":"Interface","value":"Interface"},{"name":"Gateway","value":"Gateway"},{"name":"GatewayLoadBalancer","value":"GatewayLoadBalancer"},{"name":"ServiceNetwork","value":"ServiceNetwork"},{"name":"Resource","value":"Resource"}]},"aws-native:ec2:VpcPeeringConnectionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ec2:VpcTag":{"description":"Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:VpnConcentratorTag":{"description":"Describes a tag.","properties":{"key":{"type":"string","description":"The key of the tag.\n Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with ``aws:``."},"value":{"type":"string","description":"The value of the tag.\n Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters."}},"type":"object","required":["key","value"]},"aws-native:ec2:VpnConnectionCloudwatchLogOptionsSpecification":{"description":"Options for sending VPN tunnel logs to CloudWatch.","properties":{"bgpLogEnabled":{"type":"boolean","description":"Specifies whether to enable BGP logging for the VPN connection. Default value is ``False``.\n Valid values: ``True`` | ``False``"},"bgpLogGroupArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the CloudWatch log group where BGP logs will be sent."},"bgpLogOutputFormat":{"$ref":"#/types/aws-native:ec2:VpnConnectionCloudwatchLogOptionsSpecificationBgpLogOutputFormat","description":"The desired output format for BGP logs to be sent to CloudWatch. Default format is ``json``.\n Valid values: ``json`` | ``text``"},"logEnabled":{"type":"boolean","description":"Enable or disable VPN tunnel logging feature. Default value is ``False``.\n Valid values: ``True`` | ``False``"},"logGroupArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to."},"logOutputFormat":{"$ref":"#/types/aws-native:ec2:VpnConnectionCloudwatchLogOptionsSpecificationLogOutputFormat","description":"Set log format. Default format is ``json``.\n Valid values: ``json`` | ``text``"}},"type":"object"},"aws-native:ec2:VpnConnectionCloudwatchLogOptionsSpecificationBgpLogOutputFormat":{"description":"The desired output format for BGP logs to be sent to CloudWatch. Default format is ``json``.\n Valid values: ``json`` | ``text``","type":"string","enum":[{"name":"Json","value":"json"},{"name":"Text","value":"text"}]},"aws-native:ec2:VpnConnectionCloudwatchLogOptionsSpecificationLogOutputFormat":{"description":"Set log format. Default format is ``json``.\n Valid values: ``json`` | ``text``","type":"string","enum":[{"name":"Json","value":"json"},{"name":"Text","value":"text"}]},"aws-native:ec2:VpnConnectionIkeVersionsRequestListValue":{"description":"The IKE version that is permitted for the VPN tunnel.","properties":{"value":{"$ref":"#/types/aws-native:ec2:VpnConnectionIkeVersionsRequestListValueValue","description":"The IKE version."}},"type":"object"},"aws-native:ec2:VpnConnectionIkeVersionsRequestListValueValue":{"description":"The IKE version.","type":"string","enum":[{"name":"Ikev1","value":"ikev1"},{"name":"Ikev2","value":"ikev2"}]},"aws-native:ec2:VpnConnectionPhase1EncryptionAlgorithmsRequestListValue":{"description":"Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.","properties":{"value":{"$ref":"#/types/aws-native:ec2:VpnConnectionPhase1EncryptionAlgorithmsRequestListValueValue","description":"The value for the encryption algorithm."}},"type":"object"},"aws-native:ec2:VpnConnectionPhase1EncryptionAlgorithmsRequestListValueValue":{"description":"The value for the encryption algorithm.","type":"string","enum":[{"name":"Aes128","value":"AES128"},{"name":"Aes256","value":"AES256"},{"name":"Aes128Gcm16","value":"AES128-GCM-16"},{"name":"Aes256Gcm16","value":"AES256-GCM-16"}]},"aws-native:ec2:VpnConnectionPhase1IntegrityAlgorithmsRequestListValue":{"description":"Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.","properties":{"value":{"$ref":"#/types/aws-native:ec2:VpnConnectionPhase1IntegrityAlgorithmsRequestListValueValue","description":"The value for the integrity algorithm."}},"type":"object"},"aws-native:ec2:VpnConnectionPhase1IntegrityAlgorithmsRequestListValueValue":{"description":"The value for the integrity algorithm.","type":"string","enum":[{"name":"Sha1","value":"SHA1"},{"name":"Sha2256","value":"SHA2-256"},{"name":"Sha2384","value":"SHA2-384"},{"name":"Sha2512","value":"SHA2-512"}]},"aws-native:ec2:VpnConnectionPhase1dhGroupNumbersRequestListValue":{"description":"Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.","properties":{"value":{"type":"integer","description":"The Diffie-Hellmann group number."}},"type":"object"},"aws-native:ec2:VpnConnectionPhase2EncryptionAlgorithmsRequestListValue":{"description":"Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.","properties":{"value":{"$ref":"#/types/aws-native:ec2:VpnConnectionPhase2EncryptionAlgorithmsRequestListValueValue","description":"The encryption algorithm."}},"type":"object"},"aws-native:ec2:VpnConnectionPhase2EncryptionAlgorithmsRequestListValueValue":{"description":"The encryption algorithm.","type":"string","enum":[{"name":"Aes128","value":"AES128"},{"name":"Aes256","value":"AES256"},{"name":"Aes128Gcm16","value":"AES128-GCM-16"},{"name":"Aes256Gcm16","value":"AES256-GCM-16"}]},"aws-native:ec2:VpnConnectionPhase2IntegrityAlgorithmsRequestListValue":{"description":"Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.","properties":{"value":{"$ref":"#/types/aws-native:ec2:VpnConnectionPhase2IntegrityAlgorithmsRequestListValueValue","description":"The integrity algorithm."}},"type":"object"},"aws-native:ec2:VpnConnectionPhase2IntegrityAlgorithmsRequestListValueValue":{"description":"The integrity algorithm.","type":"string","enum":[{"name":"Sha1","value":"SHA1"},{"name":"Sha2256","value":"SHA2-256"},{"name":"Sha2384","value":"SHA2-384"},{"name":"Sha2512","value":"SHA2-512"}]},"aws-native:ec2:VpnConnectionPhase2dhGroupNumbersRequestListValue":{"description":"Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.","properties":{"value":{"type":"integer","description":"The Diffie-Hellmann group number."}},"type":"object"},"aws-native:ec2:VpnConnectionPreSharedKeyStorage":{"description":"Describes the storage location for an instance store-backed AMI.","type":"string","enum":[{"name":"Standard","value":"Standard"},{"name":"SecretsManager","value":"SecretsManager"}]},"aws-native:ec2:VpnConnectionTag":{"description":"Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ec2:VpnConnectionTunnelBandwidth":{"description":"The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity. ``standard`` supports up to 1.25 Gbps per tunnel, while ``large`` supports up to 5 Gbps per tunnel. The default value is ``standard``. Existing VPN connections without a bandwidth setting will automatically default to ``standard``.","type":"string","enum":[{"name":"Standard","value":"standard"},{"name":"Large","value":"large"}]},"aws-native:ec2:VpnConnectionVpnTunnelLogOptionsSpecification":{"description":"Options for logging VPN tunnel activity.","properties":{"cloudwatchLogOptions":{"$ref":"#/types/aws-native:ec2:VpnConnectionCloudwatchLogOptionsSpecification","description":"Options for sending VPN tunnel logs to CloudWatch."}},"type":"object"},"aws-native:ec2:VpnConnectionVpnTunnelOptionsSpecification":{"description":"The tunnel options for a single VPN tunnel.","properties":{"dpdTimeoutAction":{"$ref":"#/types/aws-native:ec2:VpnConnectionVpnTunnelOptionsSpecificationDpdTimeoutAction","description":"The action to take after DPD timeout occurs. Specify ``restart`` to restart the IKE initiation. Specify ``clear`` to end the IKE session.\n Valid Values: ``clear`` | ``none`` | ``restart``\n Default: ``clear``"},"dpdTimeoutSeconds":{"type":"integer","description":"The number of seconds after which a DPD timeout occurs.\n Constraints: A value greater than or equal to 30.\n Default: ``30``"},"enableTunnelLifecycleControl":{"type":"boolean","description":"Turn on or off tunnel endpoint lifecycle control feature."},"ikeVersions":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:VpnConnectionIkeVersionsRequestListValue"},"description":"The IKE versions that are permitted for the VPN tunnel.\n Valid values: ``ikev1`` | ``ikev2``"},"logOptions":{"$ref":"#/types/aws-native:ec2:VpnConnectionVpnTunnelLogOptionsSpecification","description":"Options for logging VPN tunnel activity."},"phase1EncryptionAlgorithms":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:VpnConnectionPhase1EncryptionAlgorithmsRequestListValue"},"description":"One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.\n Valid values: ``AES128`` | ``AES256`` | ``AES128-GCM-16`` | ``AES256-GCM-16``"},"phase1IntegrityAlgorithms":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:VpnConnectionPhase1IntegrityAlgorithmsRequestListValue"},"description":"One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.\n Valid values: ``SHA1`` | ``SHA2-256`` | ``SHA2-384`` | ``SHA2-512``"},"phase1LifetimeSeconds":{"type":"integer","description":"The lifetime for phase 1 of the IKE negotiation, in seconds.\n Constraints: A value between 900 and 28,800.\n Default: ``28800``"},"phase1dhGroupNumbers":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:VpnConnectionPhase1dhGroupNumbersRequestListValue"},"description":"One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.\n Valid values: ``2`` | ``14`` | ``15`` | ``16`` | ``17`` | ``18`` | ``19`` | ``20`` | ``21`` | ``22`` | ``23`` | ``24``"},"phase2EncryptionAlgorithms":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:VpnConnectionPhase2EncryptionAlgorithmsRequestListValue"},"description":"One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.\n Valid values: ``AES128`` | ``AES256`` | ``AES128-GCM-16`` | ``AES256-GCM-16``"},"phase2IntegrityAlgorithms":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:VpnConnectionPhase2IntegrityAlgorithmsRequestListValue"},"description":"One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.\n Valid values: ``SHA1`` | ``SHA2-256`` | ``SHA2-384`` | ``SHA2-512``"},"phase2LifetimeSeconds":{"type":"integer","description":"The lifetime for phase 2 of the IKE negotiation, in seconds.\n Constraints: A value between 900 and 3,600. The value must be less than the value for ``Phase1LifetimeSeconds``.\n Default: ``3600``"},"phase2dhGroupNumbers":{"type":"array","items":{"$ref":"#/types/aws-native:ec2:VpnConnectionPhase2dhGroupNumbersRequestListValue"},"description":"One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.\n Valid values: ``2`` | ``5`` | ``14`` | ``15`` | ``16`` | ``17`` | ``18`` | ``19`` | ``20`` | ``21`` | ``22`` | ``23`` | ``24``"},"preSharedKey":{"type":"string","description":"The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.\n Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0)."},"rekeyFuzzPercentage":{"type":"integer","description":"The percentage of the rekey window (determined by ``RekeyMarginTimeSeconds``) during which the rekey time is randomly selected.\n Constraints: A value between 0 and 100.\n Default: ``100``"},"rekeyMarginTimeSeconds":{"type":"integer","description":"The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for ``RekeyFuzzPercentage``.\n Constraints: A value between 60 and half of ``Phase2LifetimeSeconds``.\n Default: ``270``"},"replayWindowSize":{"type":"integer","description":"The number of packets in an IKE replay window.\n Constraints: A value between 64 and 2048.\n Default: ``1024``"},"startupAction":{"$ref":"#/types/aws-native:ec2:VpnConnectionVpnTunnelOptionsSpecificationStartupAction","description":"The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify ``start`` for AWS to initiate the IKE negotiation.\n Valid Values: ``add`` | ``start``\n Default: ``add``"},"tunnelInsideCidr":{"type":"string","description":"The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway. \n Constraints: A size /30 CIDR block from the ``169.254.0.0/16`` range. The following CIDR blocks are reserved and cannot be used:\n  +   ``169.254.0.0/30`` \n  +   ``169.254.1.0/30`` \n  +   ``169.254.2.0/30`` \n  +   ``169.254.3.0/30`` \n  +   ``169.254.4.0/30`` \n  +   ``169.254.5.0/30`` \n  +   ``169.254.169.252/30``"},"tunnelInsideIpv6Cidr":{"type":"string","description":"The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.\n Constraints: A size /126 CIDR block from the local ``fd00::/8`` range."}},"type":"object"},"aws-native:ec2:VpnConnectionVpnTunnelOptionsSpecificationDpdTimeoutAction":{"description":"The action to take after DPD timeout occurs. Specify ``restart`` to restart the IKE initiation. Specify ``clear`` to end the IKE session.\n Valid Values: ``clear`` | ``none`` | ``restart``\n Default: ``clear``","type":"string","enum":[{"name":"Clear","value":"clear"},{"name":"None","value":"none"},{"name":"Restart","value":"restart"}]},"aws-native:ec2:VpnConnectionVpnTunnelOptionsSpecificationStartupAction":{"description":"The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify ``start`` for AWS to initiate the IKE negotiation.\n Valid Values: ``add`` | ``start``\n Default: ``add``","type":"string","enum":[{"name":"Add","value":"add"},{"name":"Start","value":"start"}]},"aws-native:ec2:VpnGatewayTag":{"description":"Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).","properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:ecr:RegistryScanningConfigurationFilterType":{"description":"The type associated with the filter.","type":"string","enum":[{"name":"Wildcard","value":"WILDCARD"}]},"aws-native:ecr:RegistryScanningConfigurationRepositoryFilter":{"description":"The filter settings used with image replication. Specifying a repository filter to a replication rule provides a method for controlling which repositories in a private registry are replicated. If no filters are added, the contents of all repositories are replicated.","properties":{"filter":{"type":"string","description":"The filter to use when scanning."},"filterType":{"$ref":"#/types/aws-native:ecr:RegistryScanningConfigurationFilterType","description":"The type associated with the filter."}},"type":"object","required":["filter","filterType"]},"aws-native:ecr:RegistryScanningConfigurationScanFrequency":{"description":"The frequency that scans are performed.","type":"string","enum":[{"name":"ScanOnPush","value":"SCAN_ON_PUSH"},{"name":"ContinuousScan","value":"CONTINUOUS_SCAN"}]},"aws-native:ecr:RegistryScanningConfigurationScanType":{"description":"The type of scanning configured for the registry.","type":"string","enum":[{"name":"Basic","value":"BASIC"},{"name":"Enhanced","value":"ENHANCED"}]},"aws-native:ecr:RegistryScanningConfigurationScanningRule":{"description":"The scanning rules associated with the registry.","properties":{"repositoryFilters":{"type":"array","items":{"$ref":"#/types/aws-native:ecr:RegistryScanningConfigurationRepositoryFilter"},"description":"The details of a scanning repository filter. For more information on how to use filters, see [Using filters](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html#image-scanning-filters) in the *Amazon Elastic Container Registry User Guide*."},"scanFrequency":{"$ref":"#/types/aws-native:ecr:RegistryScanningConfigurationScanFrequency","description":"The frequency that scans are performed at for a private registry. When the ``ENHANCED`` scan type is specified, the supported scan frequencies are ``CONTINUOUS_SCAN`` and ``SCAN_ON_PUSH``. When the ``BASIC`` scan type is specified, the ``SCAN_ON_PUSH`` scan frequency is supported. If scan on push is not specified, then the ``MANUAL`` scan frequency is set by default."}},"type":"object","required":["repositoryFilters","scanFrequency"]},"aws-native:ecr:ReplicationConfiguration":{"description":"The replication configuration for a registry.","properties":{"rules":{"type":"array","items":{"$ref":"#/types/aws-native:ecr:ReplicationConfigurationReplicationRule"},"description":"An array of objects representing the replication destinations and repository filters for a replication configuration."}},"type":"object","required":["rules"]},"aws-native:ecr:ReplicationConfigurationFilterType":{"description":"Type of repository filter","type":"string","enum":[{"name":"PrefixMatch","value":"PREFIX_MATCH"}]},"aws-native:ecr:ReplicationConfigurationReplicationDestination":{"description":"An array of objects representing the destination for a replication rule.","properties":{"region":{"type":"string","description":"The Region to replicate to."},"registryId":{"type":"string","description":"The AWS account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID."}},"type":"object","required":["region","registryId"]},"aws-native:ecr:ReplicationConfigurationReplicationRule":{"description":"An array of objects representing the replication destinations and repository filters for a replication configuration.","properties":{"destinations":{"type":"array","items":{"$ref":"#/types/aws-native:ecr:ReplicationConfigurationReplicationDestination"},"description":"An array of objects representing the destination for a replication rule."},"repositoryFilters":{"type":"array","items":{"$ref":"#/types/aws-native:ecr:ReplicationConfigurationRepositoryFilter"},"description":"An array of objects representing the filters for a replication rule. Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated."}},"type":"object","required":["destinations"]},"aws-native:ecr:ReplicationConfigurationRepositoryFilter":{"description":"The filter settings used with image replication. Specifying a repository filter to a replication rule provides a method for controlling which repositories in a private registry are replicated. If no filters are added, the contents of all repositories are replicated.","properties":{"filter":{"type":"string","description":"The repository filter details. When the ``PREFIX_MATCH`` filter type is specified, this value is required and should be the repository name prefix to configure replication for."},"filterType":{"$ref":"#/types/aws-native:ecr:ReplicationConfigurationFilterType","description":"The repository filter type. The only supported value is ``PREFIX_MATCH``, which is a repository name prefix specified with the ``filter`` parameter."}},"type":"object","required":["filter","filterType"]},"aws-native:ecr:RepositoryCreationTemplateAppliedForItem":{"description":"Enumerable Strings representing the repository creation scenarios that the template will apply towards.","type":"string","enum":[{"name":"Replication","value":"REPLICATION"},{"name":"PullThroughCache","value":"PULL_THROUGH_CACHE"},{"name":"CreateOnPush","value":"CREATE_ON_PUSH"}]},"aws-native:ecr:RepositoryCreationTemplateEncryptionConfiguration":{"description":"The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.\n By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES256 encryption algorithm. This does not require any action on your part.\n For more control over the encryption of the contents of your repository, you can use server-side encryption with KMSlong key stored in KMSlong (KMS) to encrypt your images. For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.","properties":{"encryptionType":{"$ref":"#/types/aws-native:ecr:RepositoryCreationTemplateEncryptionType","description":"The encryption type to use.\n If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created.\n If you use the ``KMS_DSSE`` encryption type, the contents of the repository will be encrypted with two layers of encryption using server-side encryption with the KMS Management Service key stored in KMS. Similar to the ``KMS`` encryption type, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you've already created. \n If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm.\n For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*."},"kmsKey":{"type":"string","description":"If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used."}},"type":"object","required":["encryptionType"]},"aws-native:ecr:RepositoryCreationTemplateEncryptionType":{"description":"The encryption type to use.","type":"string","enum":[{"name":"Aes256","value":"AES256"},{"name":"Kms","value":"KMS"},{"name":"KmsDsse","value":"KMS_DSSE"}]},"aws-native:ecr:RepositoryCreationTemplateImageTagMutability":{"description":"The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.","type":"string","enum":[{"name":"Mutable","value":"MUTABLE"},{"name":"Immutable","value":"IMMUTABLE"},{"name":"ImmutableWithExclusion","value":"IMMUTABLE_WITH_EXCLUSION"},{"name":"MutableWithExclusion","value":"MUTABLE_WITH_EXCLUSION"}]},"aws-native:ecr:RepositoryCreationTemplateImageTagMutabilityExclusionFilter":{"description":"A filter that specifies which image tags should be excluded from the repository's image tag mutability setting.","properties":{"imageTagMutabilityExclusionFilterType":{"$ref":"#/types/aws-native:ecr:RepositoryCreationTemplateImageTagMutabilityExclusionFilterImageTagMutabilityExclusionFilterType"},"imageTagMutabilityExclusionFilterValue":{"type":"string"}},"type":"object","required":["imageTagMutabilityExclusionFilterType","imageTagMutabilityExclusionFilterValue"]},"aws-native:ecr:RepositoryCreationTemplateImageTagMutabilityExclusionFilterImageTagMutabilityExclusionFilterType":{"type":"string","enum":[{"name":"Wildcard","value":"WILDCARD"}]},"aws-native:ecr:RepositoryCreationTemplateTag":{"description":"The metadata to apply to a resource to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.","properties":{"key":{"type":"string","description":"One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"A ``value`` acts as a descriptor within a tag category (key)."}},"type":"object","required":["key","value"]},"aws-native:ecr:RepositoryEncryptionConfiguration":{"description":"The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.\n By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES256 encryption algorithm. This does not require any action on your part.\n For more control over the encryption of the contents of your repository, you can use server-side encryption with KMSlong key stored in KMSlong (KMS) to encrypt your images. For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.","properties":{"encryptionType":{"$ref":"#/types/aws-native:ecr:RepositoryEncryptionType","description":"The encryption type to use.\n\nIf you use the `KMS` encryption type, the contents of the repository will be encrypted using server-side encryption with AWS Key Management Service key stored in AWS  . When you use AWS  to encrypt your data, you can either use the default AWS managed AWS  key for Amazon ECR, or specify your own AWS  key, which you already created.\n\nIf you use the `KMS_DSSE` encryption type, the contents of the repository will be encrypted with two layers of encryption using server-side encryption with the AWS  Management Service key stored in AWS  . Similar to the `KMS` encryption type, you can either use the default AWS managed AWS  key for Amazon ECR, or specify your own AWS  key, which you've already created.\n\nIf you use the `AES256` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm.\n\nFor more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide* .","replaceOnChanges":true},"kmsKey":{"type":"string","description":"If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used.","replaceOnChanges":true}},"type":"object","required":["encryptionType"]},"aws-native:ecr:RepositoryEncryptionType":{"description":"The encryption type to use.","type":"string","enum":[{"name":"Aes256","value":"AES256"},{"name":"Kms","value":"KMS"},{"name":"KmsDsse","value":"KMS_DSSE"}]},"aws-native:ecr:RepositoryImageScanningConfiguration":{"description":"The image scanning configuration for a repository.","properties":{"scanOnPush":{"type":"boolean","description":"The setting that determines whether images are scanned after being pushed to a repository. If set to ``true``, images will be scanned after being pushed. If this parameter is not specified, it will default to ``false`` and images will not be scanned unless a scan is manually started."}},"type":"object"},"aws-native:ecr:RepositoryImageTagMutability":{"description":"The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.","type":"string","enum":[{"name":"Mutable","value":"MUTABLE"},{"name":"Immutable","value":"IMMUTABLE"},{"name":"MutableWithExclusion","value":"MUTABLE_WITH_EXCLUSION"},{"name":"ImmutableWithExclusion","value":"IMMUTABLE_WITH_EXCLUSION"}]},"aws-native:ecr:RepositoryImageTagMutabilityExclusionFilter":{"description":"A filter that specifies which image tags should be excluded from the repository's image tag mutability setting.","properties":{"imageTagMutabilityExclusionFilterType":{"$ref":"#/types/aws-native:ecr:RepositoryImageTagMutabilityExclusionFilterType"},"imageTagMutabilityExclusionFilterValue":{"type":"string"}},"type":"object","required":["imageTagMutabilityExclusionFilterType","imageTagMutabilityExclusionFilterValue"]},"aws-native:ecr:RepositoryImageTagMutabilityExclusionFilterType":{"description":"Specifies the type of filter to use for excluding image tags from the repository's mutability setting.","type":"string","enum":[{"name":"Wildcard","value":"WILDCARD"}]},"aws-native:ecr:RepositoryLifecyclePolicy":{"description":"The ``LifecyclePolicy`` property type specifies a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) in the *Amazon ECR User Guide*.","properties":{"lifecyclePolicyText":{"type":"string","description":"The JSON repository policy text to apply to the repository."},"registryId":{"type":"string","description":"The AWS account ID associated with the registry that contains the repository. If you do\n not specify a registry, the default registry is assumed."}},"type":"object"},"aws-native:ecr:RepositoryTag":{"description":"The metadata to apply to a resource to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.","properties":{"key":{"type":"string","description":"One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"A ``value`` acts as a descriptor within a tag category (key)."}},"type":"object","required":["key","value"]},"aws-native:ecr:SigningConfigurationFilterType":{"description":"Type of repository filter","type":"string","enum":[{"name":"WildcardMatch","value":"WILDCARD_MATCH"}]},"aws-native:ecr:SigningConfigurationRepositoryFilter":{"description":"An array of objects representing the details of a repository filter.","properties":{"filter":{"type":"string","description":"The filter value used to match repository names. When using `WILDCARD_MATCH` , the `*` character matches any sequence of characters.\n\nExamples:\n\n- `myapp/*` - Matches all repositories starting with `myapp/`\n- `*/production` - Matches all repositories ending with `/production`\n- `*prod*` - Matches all repositories containing `prod`"},"filterType":{"$ref":"#/types/aws-native:ecr:SigningConfigurationFilterType","description":"The type of filter to apply. Currently, only `WILDCARD_MATCH` is supported, which uses wildcard patterns to match repository names."}},"type":"object","required":["filter","filterType"]},"aws-native:ecr:SigningConfigurationRule":{"properties":{"repositoryFilters":{"type":"array","items":{"$ref":"#/types/aws-native:ecr:SigningConfigurationRepositoryFilter"},"description":"Optional array of repository filters. If omitted, the rule matches all repositories. If provided, must contain at least one filter. Empty arrays are not allowed."},"signingProfileArn":{"type":"string","description":"AWS Signer signing profile ARN to use for matched repositories."}},"type":"object","required":["signingProfileArn"]},"aws-native:ecs:CapacityProviderAcceleratorCountRequest":{"properties":{"max":{"type":"integer","description":"The maximum number of accelerators. Instance types with more accelerators are excluded from selection."},"min":{"type":"integer","description":"The minimum number of accelerators. Instance types with fewer accelerators are excluded from selection."}},"type":"object"},"aws-native:ecs:CapacityProviderAcceleratorTotalMemoryMiBRequest":{"properties":{"max":{"type":"integer","description":"The maximum total accelerator memory in MiB. Instance types with more accelerator memory are excluded from selection."},"min":{"type":"integer","description":"The minimum total accelerator memory in MiB. Instance types with less accelerator memory are excluded from selection."}},"type":"object"},"aws-native:ecs:CapacityProviderAutoScalingGroupProvider":{"properties":{"autoScalingGroupArn":{"type":"string","description":"The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.","replaceOnChanges":true},"managedDraining":{"$ref":"#/types/aws-native:ecs:CapacityProviderAutoScalingGroupProviderManagedDraining","description":"The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider."},"managedScaling":{"$ref":"#/types/aws-native:ecs:CapacityProviderManagedScaling","description":"The managed scaling settings for the Auto Scaling group capacity provider."},"managedTerminationProtection":{"$ref":"#/types/aws-native:ecs:CapacityProviderAutoScalingGroupProviderManagedTerminationProtection","description":"The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.\n\n\u003e When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work. \n\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see [Instance Protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) in the *AWS Auto Scaling User Guide* .\n\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in."}},"type":"object","required":["autoScalingGroupArn"]},"aws-native:ecs:CapacityProviderAutoScalingGroupProviderManagedDraining":{"description":"The managed draining option for the Auto Scaling group capacity provider. When you enable this, Amazon ECS manages and gracefully drains the EC2 container instances that are in the Auto Scaling group capacity provider.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:ecs:CapacityProviderAutoScalingGroupProviderManagedTerminationProtection":{"description":"The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection. The default is off.\n\n\u003e When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work. \n\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions on as well. For more information, see [Instance Protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) in the *AWS Auto Scaling User Guide* .\n\nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:ecs:CapacityProviderBaselineEbsBandwidthMbpsRequest":{"properties":{"max":{"type":"integer","description":"The maximum baseline Amazon EBS bandwidth in Mbps. Instance types with higher Amazon EBS bandwidth are excluded from selection."},"min":{"type":"integer","description":"The minimum baseline Amazon EBS bandwidth in Mbps. Instance types with lower Amazon EBS bandwidth are excluded from selection."}},"type":"object"},"aws-native:ecs:CapacityProviderCapacityReservationRequest":{"properties":{"reservationGroupArn":{"type":"string"},"reservationPreference":{"$ref":"#/types/aws-native:ecs:CapacityProviderCapacityReservationRequestReservationPreference"}},"type":"object"},"aws-native:ecs:CapacityProviderCapacityReservationRequestReservationPreference":{"type":"string","enum":[{"name":"ReservationsOnly","value":"RESERVATIONS_ONLY"},{"name":"ReservationsFirst","value":"RESERVATIONS_FIRST"},{"name":"ReservationsExcluded","value":"RESERVATIONS_EXCLUDED"}]},"aws-native:ecs:CapacityProviderInstanceLaunchTemplate":{"properties":{"capacityOptionType":{"$ref":"#/types/aws-native:ecs:CapacityProviderInstanceLaunchTemplateCapacityOptionType","description":"The capacity option type. This determines whether Amazon ECS launches On-Demand or Spot Instances for your managed instance capacity provider.\n\nValid values are:\n\n- `ON_DEMAND` - Launches standard On-Demand Instances. On-Demand Instances provide predictable pricing and availability.\n- `SPOT` - Launches Spot Instances that use spare Amazon EC2 capacity at reduced cost. Spot Instances can be interrupted by Amazon EC2 with a two-minute notification when the capacity is needed back.\n\nThe default is On-Demand\n\nFor more information about Amazon EC2 capacity options, see [Instance purchasing options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html) in the *Amazon EC2 User Guide* ."},"capacityReservations":{"$ref":"#/types/aws-native:ecs:CapacityProviderCapacityReservationRequest"},"ec2InstanceProfileArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the instance profile that Amazon ECS applies to Amazon ECS Managed Instances. This instance profile must include the necessary permissions for your tasks to access AWS services and resources.\n\nFor more information, see [Amazon ECS instance profile for Managed Instances](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/managed-instances-instance-profile.html) in the *Amazon ECS Developer Guide* ."},"fipsEnabled":{"type":"boolean","replaceOnChanges":true},"instanceRequirements":{"$ref":"#/types/aws-native:ecs:CapacityProviderInstanceRequirementsRequest","description":"The instance requirements. You can specify:\n\n- The instance types\n- Instance requirements such as vCPU count, memory, network performance, and accelerator specifications\n\nAmazon ECS automatically selects the instances that match the specified criteria."},"monitoring":{"$ref":"#/types/aws-native:ecs:CapacityProviderManagedInstancesMonitoringOptions","description":"CloudWatch provides two categories of monitoring: basic monitoring and detailed monitoring. By default, your managed instance is configured for basic monitoring. You can optionally enable detailed monitoring to help you more quickly identify and act on operational issues. You can enable or turn off detailed monitoring at launch or when the managed instance is running or stopped. For more information, see [Detailed monitoring for Amazon ECS Managed Instances](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/detailed-monitoring-managed-instances.html) in the Amazon ECS Developer Guide."},"networkConfiguration":{"$ref":"#/types/aws-native:ecs:CapacityProviderManagedInstancesNetworkConfiguration","description":"The network configuration for Amazon ECS Managed Instances. This specifies the subnets and security groups that instances use for network connectivity."},"storageConfiguration":{"$ref":"#/types/aws-native:ecs:CapacityProviderManagedInstancesStorageConfiguration","description":"The storage configuration for Amazon ECS Managed Instances. This defines the root volume size and type for the instances."}},"type":"object","required":["ec2InstanceProfileArn","networkConfiguration"]},"aws-native:ecs:CapacityProviderInstanceLaunchTemplateCapacityOptionType":{"description":"The capacity option type. This determines whether Amazon ECS launches On-Demand or Spot Instances for your managed instance capacity provider.\n\nValid values are:\n\n- `ON_DEMAND` - Launches standard On-Demand Instances. On-Demand Instances provide predictable pricing and availability.\n- `SPOT` - Launches Spot Instances that use spare Amazon EC2 capacity at reduced cost. Spot Instances can be interrupted by Amazon EC2 with a two-minute notification when the capacity is needed back.\n\nThe default is On-Demand\n\nFor more information about Amazon EC2 capacity options, see [Instance purchasing options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html) in the *Amazon EC2 User Guide* .","type":"string","enum":[{"name":"OnDemand","value":"ON_DEMAND"},{"name":"Spot","value":"SPOT"},{"name":"Reserved","value":"RESERVED"}]},"aws-native:ecs:CapacityProviderInstanceRequirementsRequest":{"properties":{"acceleratorCount":{"$ref":"#/types/aws-native:ecs:CapacityProviderAcceleratorCountRequest","description":"The minimum and maximum number of accelerators for the instance types. This is used when you need instances with specific numbers of GPUs or other accelerators."},"acceleratorManufacturers":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:CapacityProviderInstanceRequirementsRequestAcceleratorManufacturersItem"},"description":"The accelerator manufacturers to include. You can specify `nvidia` , `amd` , `amazon-web-services` , or `xilinx` depending on your accelerator requirements."},"acceleratorNames":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:CapacityProviderInstanceRequirementsRequestAcceleratorNamesItem"},"description":"The specific accelerator names to include. For example, you can specify `a100` , `v100` , `k80` , or other specific accelerator models."},"acceleratorTotalMemoryMiB":{"$ref":"#/types/aws-native:ecs:CapacityProviderAcceleratorTotalMemoryMiBRequest","description":"The minimum and maximum total accelerator memory in mebibytes (MiB). This is important for GPU workloads that require specific amounts of video memory."},"acceleratorTypes":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:CapacityProviderInstanceRequirementsRequestAcceleratorTypesItem"},"description":"The accelerator types to include. You can specify `gpu` for graphics processing units, `fpga` for field programmable gate arrays, or `inference` for machine learning inference accelerators."},"allowedInstanceTypes":{"type":"array","items":{"type":"string"},"description":"The instance types to include in the selection. When specified, Amazon ECS only considers these instance types, subject to the other requirements specified."},"bareMetal":{"$ref":"#/types/aws-native:ecs:CapacityProviderInstanceRequirementsRequestBareMetal","description":"Indicates whether to include bare metal instance types. Set to `included` to allow bare metal instances, `excluded` to exclude them, or `required` to use only bare metal instances."},"baselineEbsBandwidthMbps":{"$ref":"#/types/aws-native:ecs:CapacityProviderBaselineEbsBandwidthMbpsRequest","description":"The minimum and maximum baseline Amazon EBS bandwidth in megabits per second (Mbps). This is important for workloads with high storage I/O requirements."},"burstablePerformance":{"$ref":"#/types/aws-native:ecs:CapacityProviderInstanceRequirementsRequestBurstablePerformance","description":"Indicates whether to include burstable performance instance types (T2, T3, T3a, T4g). Set to `included` to allow burstable instances, `excluded` to exclude them, or `required` to use only burstable instances."},"cpuManufacturers":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:CapacityProviderInstanceRequirementsRequestCpuManufacturersItem"},"description":"The CPU manufacturers to include or exclude. You can specify `intel` , `amd` , or `amazon-web-services` to control which CPU types are used for your workloads."},"excludedInstanceTypes":{"type":"array","items":{"type":"string"},"description":"The instance types to exclude from selection. Use this to prevent Amazon ECS from selecting specific instance types that may not be suitable for your workloads."},"instanceGenerations":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:CapacityProviderInstanceRequirementsRequestInstanceGenerationsItem"},"description":"The instance generations to include. You can specify `current` to use the latest generation instances, or `previous` to include previous generation instances for cost optimization."},"localStorage":{"$ref":"#/types/aws-native:ecs:CapacityProviderInstanceRequirementsRequestLocalStorage","description":"Indicates whether to include instance types with local storage. Set to `included` to allow local storage, `excluded` to exclude it, or `required` to use only instances with local storage."},"localStorageTypes":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:CapacityProviderInstanceRequirementsRequestLocalStorageTypesItem"},"description":"The local storage types to include. You can specify `hdd` for hard disk drives, `ssd` for solid state drives, or both."},"maxSpotPriceAsPercentageOfOptimalOnDemandPrice":{"type":"integer","description":"The maximum price for Spot instances as a percentage of the optimal On-Demand price. This provides more precise cost control for Spot instance selection."},"memoryGiBPerVCpu":{"$ref":"#/types/aws-native:ecs:CapacityProviderMemoryGiBPerVCpuRequest","description":"The minimum and maximum amount of memory per vCPU in gibibytes (GiB). This helps ensure that instance types have the appropriate memory-to-CPU ratio for your workloads."},"memoryMiB":{"$ref":"#/types/aws-native:ecs:CapacityProviderMemoryMiBRequest","description":"The minimum and maximum amount of memory in mebibytes (MiB) for the instance types. Amazon ECS selects instance types that have memory within this range."},"networkBandwidthGbps":{"$ref":"#/types/aws-native:ecs:CapacityProviderNetworkBandwidthGbpsRequest","description":"The minimum and maximum network bandwidth in gigabits per second (Gbps). This is crucial for network-intensive workloads that require high throughput."},"networkInterfaceCount":{"$ref":"#/types/aws-native:ecs:CapacityProviderNetworkInterfaceCountRequest","description":"The minimum and maximum number of network interfaces for the instance types. This is useful for workloads that require multiple network interfaces."},"onDemandMaxPricePercentageOverLowestPrice":{"type":"integer","description":"The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon ECS selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold."},"requireHibernateSupport":{"type":"boolean","description":"Indicates whether the instance types must support hibernation. When set to `true` , only instance types that support hibernation are selected."},"spotMaxPricePercentageOverLowestPrice":{"type":"integer","description":"The maximum price for Spot instances as a percentage over the lowest priced On-Demand instance. This helps control Spot instance costs while maintaining access to capacity."},"totalLocalStorageGb":{"$ref":"#/types/aws-native:ecs:CapacityProviderTotalLocalStorageGbRequest","description":"The minimum and maximum total local storage in gigabytes (GB) for instance types with local storage."},"vCpuCount":{"$ref":"#/types/aws-native:ecs:CapacityProviderVCpuCountRangeRequest","description":"The minimum and maximum number of vCPUs for the instance types. Amazon ECS selects instance types that have vCPU counts within this range."}},"type":"object","required":["memoryMiB","vCpuCount"]},"aws-native:ecs:CapacityProviderInstanceRequirementsRequestAcceleratorManufacturersItem":{"type":"string","enum":[{"name":"AmazonWebServices","value":"amazon-web-services"},{"name":"Amd","value":"amd"},{"name":"Habana","value":"habana"},{"name":"Nvidia","value":"nvidia"},{"name":"Xilinx","value":"xilinx"}]},"aws-native:ecs:CapacityProviderInstanceRequirementsRequestAcceleratorNamesItem":{"type":"string","enum":[{"name":"A10g","value":"a10g"},{"name":"A100","value":"a100"},{"name":"H100","value":"h100"},{"name":"Inferentia","value":"inferentia"},{"name":"K520","value":"k520"},{"name":"K80","value":"k80"},{"name":"M60","value":"m60"},{"name":"RadeonProV520","value":"radeon-pro-v520"},{"name":"T4","value":"t4"},{"name":"T4g","value":"t4g"},{"name":"Vu9p","value":"vu9p"},{"name":"V100","value":"v100"},{"name":"L40s","value":"l40s"}]},"aws-native:ecs:CapacityProviderInstanceRequirementsRequestAcceleratorTypesItem":{"type":"string","enum":[{"name":"Gpu","value":"gpu"},{"name":"Fpga","value":"fpga"},{"name":"Inference","value":"inference"}]},"aws-native:ecs:CapacityProviderInstanceRequirementsRequestBareMetal":{"description":"Indicates whether to include bare metal instance types. Set to `included` to allow bare metal instances, `excluded` to exclude them, or `required` to use only bare metal instances.","type":"string","enum":[{"name":"Included","value":"included"},{"name":"Required","value":"required"},{"name":"Excluded","value":"excluded"}]},"aws-native:ecs:CapacityProviderInstanceRequirementsRequestBurstablePerformance":{"description":"Indicates whether to include burstable performance instance types (T2, T3, T3a, T4g). Set to `included` to allow burstable instances, `excluded` to exclude them, or `required` to use only burstable instances.","type":"string","enum":[{"name":"Included","value":"included"},{"name":"Required","value":"required"},{"name":"Excluded","value":"excluded"}]},"aws-native:ecs:CapacityProviderInstanceRequirementsRequestCpuManufacturersItem":{"type":"string","enum":[{"name":"Intel","value":"intel"},{"name":"Amd","value":"amd"},{"name":"AmazonWebServices","value":"amazon-web-services"}]},"aws-native:ecs:CapacityProviderInstanceRequirementsRequestInstanceGenerationsItem":{"type":"string","enum":[{"name":"Current","value":"current"},{"name":"Previous","value":"previous"}]},"aws-native:ecs:CapacityProviderInstanceRequirementsRequestLocalStorage":{"description":"Indicates whether to include instance types with local storage. Set to `included` to allow local storage, `excluded` to exclude it, or `required` to use only instances with local storage.","type":"string","enum":[{"name":"Included","value":"included"},{"name":"Required","value":"required"},{"name":"Excluded","value":"excluded"}]},"aws-native:ecs:CapacityProviderInstanceRequirementsRequestLocalStorageTypesItem":{"type":"string","enum":[{"name":"Hdd","value":"hdd"},{"name":"Ssd","value":"ssd"}]},"aws-native:ecs:CapacityProviderManagedInstancesMonitoringOptions":{"type":"string","enum":[{"name":"Basic","value":"BASIC"},{"name":"Detailed","value":"DETAILED"}]},"aws-native:ecs:CapacityProviderManagedInstancesNetworkConfiguration":{"properties":{"securityGroups":{"type":"array","items":{"type":"string"},"description":"The list of security group IDs to apply to Amazon ECS Managed Instances. These security groups control the network traffic allowed to and from the instances."},"subnets":{"type":"array","items":{"type":"string"},"description":"The list of subnet IDs where Amazon ECS can launch Amazon ECS Managed Instances. Instances are distributed across the specified subnets for high availability. All subnets must be in the same VPC."}},"type":"object","required":["securityGroups","subnets"]},"aws-native:ecs:CapacityProviderManagedInstancesProvider":{"properties":{"infrastructureOptimization":{"$ref":"#/types/aws-native:ecs:CapacityProviderManagedInstancesProviderInfrastructureOptimizationProperties","description":"Defines how Amazon ECS Managed Instances optimizes the infrastructure in your capacity provider. Configure it to turn on or off the infrastructure optimization in your capacity provider, and to control the idle EC2 instances optimization delay."},"infrastructureRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the infrastructure role that Amazon ECS assumes to manage instances. This role must include permissions for Amazon EC2 instance lifecycle management, networking, and any additional AWS services required for your workloads.\n\nFor more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide* ."},"instanceLaunchTemplate":{"$ref":"#/types/aws-native:ecs:CapacityProviderInstanceLaunchTemplate","description":"The launch template that defines how Amazon ECS launches Amazon ECS Managed Instances. This includes the instance profile for your tasks, network and storage configuration, and instance requirements that determine which Amazon EC2 instance types can be used.\n\nFor more information, see [Store instance launch parameters in Amazon EC2 launch templates](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide* ."},"propagateTags":{"$ref":"#/types/aws-native:ecs:CapacityProviderManagedInstancesProviderPropagateTags","description":"Determines whether tags from the capacity provider are automatically applied to Amazon ECS Managed Instances. This helps with cost allocation and resource management by ensuring consistent tagging across your infrastructure."}},"type":"object","required":["infrastructureRoleArn","instanceLaunchTemplate"]},"aws-native:ecs:CapacityProviderManagedInstancesProviderInfrastructureOptimizationProperties":{"description":"Defines how Amazon ECS Managed Instances optimizes the infrastructure in your capacity provider. Configure it to turn on or off the infrastructure optimization in your capacity provider, and to control the idle EC2 instances optimization delay.","properties":{"scaleInAfter":{"type":"integer","description":"This parameter defines the number of seconds Amazon ECS Managed Instances waits before optimizing EC2 instances that have become idle or underutilized. A longer delay increases the likelihood of placing new tasks on idle instances, reducing startup time. A shorter delay helps reduce infrastructure costs by optimizing idle instances more quickly. Valid values are: Not set (null) - Uses the default optimization behavior, `-1` - Disables automatic infrastructure optimization, `0` to `3600` (inclusive) - Specifies the number of seconds to wait before optimizing instances."}},"type":"object"},"aws-native:ecs:CapacityProviderManagedInstancesProviderPropagateTags":{"description":"Determines whether tags from the capacity provider are automatically applied to Amazon ECS Managed Instances. This helps with cost allocation and resource management by ensuring consistent tagging across your infrastructure.","type":"string","enum":[{"name":"CapacityProvider","value":"CAPACITY_PROVIDER"},{"name":"None","value":"NONE"}]},"aws-native:ecs:CapacityProviderManagedInstancesStorageConfiguration":{"properties":{"storageSizeGiB":{"type":"integer","description":"The size of the tasks volume."}},"type":"object","required":["storageSizeGiB"]},"aws-native:ecs:CapacityProviderManagedScaling":{"description":"The managed scaling settings for the Auto Scaling group capacity provider.","properties":{"instanceWarmupPeriod":{"type":"integer","description":"The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of `300` seconds is used."},"maximumScalingStepSize":{"type":"integer","description":"The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default value of `10000` is used."},"minimumScalingStepSize":{"type":"integer","description":"The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of `1` is used.\n\nWhen additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size."},"status":{"$ref":"#/types/aws-native:ecs:CapacityProviderManagedScalingStatus","description":"Determines whether to use managed scaling for the capacity provider."},"targetCapacity":{"type":"integer","description":"The target capacity utilization as a percentage for the capacity provider. The specified value must be greater than `0` and less than or equal to `100` . For example, if you want the capacity provider to maintain 10% spare capacity, then that means the utilization is 90%, so use a `targetCapacity` of `90` . The default value of `100` percent results in the Amazon EC2 instances in your Auto Scaling group being completely used."}},"type":"object"},"aws-native:ecs:CapacityProviderManagedScalingStatus":{"description":"Determines whether to use managed scaling for the capacity provider.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:ecs:CapacityProviderMemoryGiBPerVCpuRequest":{"properties":{"max":{"type":"number","description":"The maximum amount of memory per vCPU in GiB. Instance types with a higher memory-to-vCPU ratio are excluded from selection."},"min":{"type":"number","description":"The minimum amount of memory per vCPU in GiB. Instance types with a lower memory-to-vCPU ratio are excluded from selection."}},"type":"object"},"aws-native:ecs:CapacityProviderMemoryMiBRequest":{"properties":{"max":{"type":"integer","description":"The maximum amount of memory in MiB. Instance types with more memory than this value are excluded from selection."},"min":{"type":"integer","description":"The minimum amount of memory in MiB. Instance types with less memory than this value are excluded from selection."}},"type":"object","required":["min"]},"aws-native:ecs:CapacityProviderNetworkBandwidthGbpsRequest":{"properties":{"max":{"type":"number","description":"The maximum network bandwidth in Gbps. Instance types with higher network bandwidth are excluded from selection."},"min":{"type":"number","description":"The minimum network bandwidth in Gbps. Instance types with lower network bandwidth are excluded from selection."}},"type":"object"},"aws-native:ecs:CapacityProviderNetworkInterfaceCountRequest":{"properties":{"max":{"type":"integer","description":"The maximum number of network interfaces. Instance types that support more network interfaces are excluded from selection."},"min":{"type":"integer","description":"The minimum number of network interfaces. Instance types that support fewer network interfaces are excluded from selection."}},"type":"object"},"aws-native:ecs:CapacityProviderTag":{"properties":{"key":{"type":"string","description":"One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key)."}},"type":"object"},"aws-native:ecs:CapacityProviderTotalLocalStorageGbRequest":{"properties":{"max":{"type":"number","description":"The maximum total local storage in GB. Instance types with more local storage are excluded from selection."},"min":{"type":"number","description":"The minimum total local storage in GB. Instance types with less local storage are excluded from selection."}},"type":"object"},"aws-native:ecs:CapacityProviderVCpuCountRangeRequest":{"properties":{"max":{"type":"integer","description":"The maximum number of vCPUs. Instance types with more vCPUs than this value are excluded from selection."},"min":{"type":"integer","description":"The minimum number of vCPUs. Instance types with fewer vCPUs than this value are excluded from selection."}},"type":"object","required":["min"]},"aws-native:ecs:ClusterCapacityProviderAssociationsCapacityProvider":{"description":"If using ec2 auto-scaling, the name of the associated capacity provider. Otherwise FARGATE, FARGATE_SPOT.","type":"string","enum":[{"name":"Fargate","value":"FARGATE"},{"name":"FargateSpot","value":"FARGATE_SPOT"}]},"aws-native:ecs:ClusterCapacityProviderAssociationsCapacityProvider0":{"description":"If using ec2 auto-scaling, the name of the associated capacity provider. Otherwise FARGATE, FARGATE_SPOT.","type":"string","enum":[{"name":"Fargate","value":"FARGATE"},{"name":"FargateSpot","value":"FARGATE_SPOT"}]},"aws-native:ecs:ClusterCapacityProviderAssociationsCapacityProviderStrategy":{"properties":{"base":{"type":"integer"},"capacityProvider":{"oneOf":[{"$ref":"#/types/aws-native:ecs:ClusterCapacityProviderAssociationsCapacityProvider"},{"type":"string"}]},"weight":{"type":"integer"}},"type":"object","required":["capacityProvider"]},"aws-native:ecs:ClusterCapacityProviderStrategyItem":{"description":"The ``CapacityProviderStrategyItem`` property specifies the details of the default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.","properties":{"base":{"type":"integer","description":"The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider for each service. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used.\n Base value characteristics:\n  +  Only one capacity provider in a strategy can have a base defined\n  +  The default value is ``0`` if not specified\n  +  The valid range is 0 to 100,000\n  +  Base requirements are satisfied first before weight distribution"},"capacityProvider":{"type":"string","description":"The short name of the capacity provider. This can be either an AWS managed capacity provider (``FARGATE`` or ``FARGATE_SPOT``) or the name of a custom capacity provider that you created."},"weight":{"type":"integer","description":"The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied.\n If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail.\n Weight value characteristics:\n  +  Weight is considered after the base value is satisfied\n  +  The default value is ``0`` if not specified\n  +  The valid range is 0 to 1,000\n  +  At least one capacity provider must have a weight greater than zero\n  +  Capacity providers with weight of ``0`` cannot place tasks\n  \n Task distribution logic:\n  1.  Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider\n  1.  Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios\n  \n Examples:\n Equal Distribution: Two capacity providers both with weight ``1`` will split tasks evenly after base requirements are met.\n Weighted Distribution: If capacityProviderA has weight ``1`` and capacityProviderB has weight ``4``, then for every 1 task on A, 4 tasks will run on B."}},"type":"object"},"aws-native:ecs:ClusterConfiguration":{"description":"The execute command and managed storage configuration for the cluster.","properties":{"executeCommandConfiguration":{"$ref":"#/types/aws-native:ecs:ClusterExecuteCommandConfiguration","description":"The details of the execute command configuration."},"managedStorageConfiguration":{"$ref":"#/types/aws-native:ecs:ClusterManagedStorageConfiguration","description":"The details of the managed storage configuration."}},"type":"object"},"aws-native:ecs:ClusterExecuteCommandConfiguration":{"description":"The details of the execute command configuration.","properties":{"kmsKeyId":{"type":"string","description":"Specify an KMSlong key ID to encrypt the data between the local client and the container."},"logConfiguration":{"$ref":"#/types/aws-native:ecs:ClusterExecuteCommandLogConfiguration","description":"The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When ``logging=OVERRIDE`` is specified, a ``logConfiguration`` must be provided."},"logging":{"type":"string","description":"The log setting to use for redirecting logs for your execute command results. The following log settings are available.\n  +  ``NONE``: The execute command session is not logged.\n  +  ``DEFAULT``: The ``awslogs`` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no ``awslogs`` log driver is configured in the task definition, the output won't be logged.\n  +  ``OVERRIDE``: Specify the logging details as a part of ``logConfiguration``. If the ``OVERRIDE`` logging option is specified, the ``logConfiguration`` is required."}},"type":"object"},"aws-native:ecs:ClusterExecuteCommandLogConfiguration":{"description":"The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.","properties":{"cloudWatchEncryptionEnabled":{"type":"boolean","description":"Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off."},"cloudWatchLogGroupName":{"type":"string","description":"The name of the CloudWatch log group to send logs to.\n  The CloudWatch log group must already be created."},"s3BucketName":{"type":"string","description":"The name of the S3 bucket to send logs to.\n  The S3 bucket must already be created."},"s3EncryptionEnabled":{"type":"boolean","description":"Determines whether to use encryption on the S3 logs. If not specified, encryption is not used."},"s3KeyPrefix":{"type":"string","description":"An optional folder in the S3 bucket to place logs in."}},"type":"object"},"aws-native:ecs:ClusterManagedStorageConfiguration":{"description":"The managed storage configuration for the cluster.","properties":{"fargateEphemeralStorageKmsKeyId":{"type":"string","description":"Specify the KMSlong key ID for Fargate ephemeral storage.\n When you specify a ``fargateEphemeralStorageKmsKeyId``, AWS Fargate uses the key to encrypt data at rest in ephemeral storage. For more information about Fargate ephemeral storage encryption, see [Customer managed keys for Fargate ephemeral storage for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-storage-encryption.html) in the *Amazon Elastic Container Service Developer Guide*.\n The key must be a single Region key."},"kmsKeyId":{"type":"string","description":"Specify a KMSlong key ID to encrypt Amazon ECS managed storage.\n  When you specify a ``kmsKeyId``, Amazon ECS uses the key to encrypt data volumes managed by Amazon ECS that are attached to tasks in the cluster. The following data volumes are managed by Amazon ECS: Amazon EBS. For more information about encryption of Amazon EBS volumes attached to Amazon ECS tasks, see [Encrypt data stored in Amazon EBS volumes for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html) in the *Amazon Elastic Container Service Developer Guide*.\n The key must be a single Region key."}},"type":"object"},"aws-native:ecs:ClusterServiceConnectDefaults":{"description":"Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"namespace":{"type":"string","description":"The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include greater than (\u003e), less than (\u003c), double quotation marks (\"), or slash (/).\n If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region.\n If you enter a new name, a CMAPlong namespace will be created. Amazon ECS creates a CMAP namespace with the \"API calls\" method of instance discovery only. This instance discovery method is the \"HTTP\" namespace type in the CLIlong. Other types of instance discovery aren't used by Service Connect.\n If you update the cluster with an empty string ``\"\"`` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in CMAP and must be deleted separately.\n For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*."}},"type":"object"},"aws-native:ecs:ClusterSettings":{"description":"The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights with enhanced observability or CloudWatch Container Insights for a cluster.\n Container Insights with enhanced observability provides all the Container Insights metrics, plus additional task and container metrics. This version supports enhanced observability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you configure Container Insights with enhanced observability on Amazon ECS, Container Insights auto-collects detailed infrastructure telemetry from the cluster level down to the container level in your environment and displays these critical performance data in curated dashboards removing the heavy lifting in observability set-up. \n For more information, see [Monitor Amazon ECS containers using Container Insights with enhanced observability](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"name":{"type":"string","description":"The name of the cluster setting. The value is ``containerInsights``."},"value":{"type":"string","description":"The value to set for the cluster setting. The supported values are ``enhanced``, ``enabled``, and ``disabled``. \n To use Container Insights with enhanced observability, set the ``containerInsights`` account setting to ``enhanced``.\n To use Container Insights, set the ``containerInsights`` account setting to ``enabled``.\n If a cluster value is specified, it will override the ``containerInsights`` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)."}},"type":"object"},"aws-native:ecs:ClusterTag":{"description":"The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.\n The following basic restrictions apply to tags:\n  +  Maximum number of tags per resource - 50\n  +  For each resource, each tag key must be unique, and each tag key can have only one value.\n  +  Maximum key length - 128 Unicode characters in UTF-8\n  +  Maximum value length - 256 Unicode characters in UTF-8\n  +  If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n  +  Tag keys and values are case-sensitive.\n  +  Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.","properties":{"key":{"type":"string","description":"One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key)."}},"type":"object"},"aws-native:ecs:ExpressGatewayServiceAccessType":{"type":"string","enum":[{"name":"Public","value":"PUBLIC"},{"name":"Private","value":"PRIVATE"}]},"aws-native:ecs:ExpressGatewayServiceAutoScalingArns":{"properties":{"applicationAutoScalingPolicies":{"type":"array","items":{"type":"string"}},"scalableTarget":{"type":"string"}},"type":"object"},"aws-native:ecs:ExpressGatewayServiceAwsLogsConfiguration":{"properties":{"logGroup":{"type":"string","description":"The name of the CloudWatch Logs log group to send container logs to."},"logStreamPrefix":{"type":"string","description":"The prefix for the CloudWatch Logs log stream names. The default for an Express service is `ecs` ."}},"type":"object","required":["logGroup","logStreamPrefix"]},"aws-native:ecs:ExpressGatewayServiceConfiguration":{"properties":{"cpu":{"type":"string","description":"The CPU allocation for tasks in this service revision."},"createdAt":{"type":"string","description":"The Unix timestamp for when this service revision was created."},"executionRoleArn":{"type":"string","description":"The ARN of the task execution role for the service revision."},"healthCheckPath":{"type":"string","description":"The health check path for this service revision."},"ingressPaths":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceIngressPathSummary"},"description":"The entry point into this service revision."},"memory":{"type":"string","description":"The memory allocation for tasks in this service revision."},"networkConfiguration":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceNetworkConfiguration","description":"The network configuration for tasks in this service revision."},"primaryContainer":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceExpressGatewayContainer","description":"The primary container configuration for this service revision."},"scalingTarget":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceExpressGatewayScalingTarget","description":"The auto-scaling configuration for this service revision."},"serviceRevisionArn":{"type":"string","description":"The ARN of the service revision."},"taskRoleArn":{"type":"string","description":"The ARN of the task role for the service revision."}},"type":"object"},"aws-native:ecs:ExpressGatewayServiceEcsManagedResourceArns":{"properties":{"autoScaling":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceAutoScalingArns"},"ingressPath":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceIngressPathArns"},"logGroups":{"type":"array","items":{"type":"string"}},"metricAlarms":{"type":"array","items":{"type":"string"}},"serviceSecurityGroups":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:ecs:ExpressGatewayServiceExpressGatewayContainer":{"properties":{"awsLogsConfiguration":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceAwsLogsConfiguration","description":"The log configuration for the container."},"command":{"type":"array","items":{"type":"string"},"description":"The command that is passed to the container."},"containerPort":{"type":"integer","description":"The port number on the container that receives traffic from the load balancer. Default is 80."},"environment":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceKeyValuePair"},"description":"The environment variables to pass to the container."},"image":{"type":"string","description":"The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either `repository-url/image:tag` or `repository-url/image@digest` .\n\nFor Express services, the image typically contains a web application that listens on the specified container port. The image can be stored in Amazon ECR, Docker Hub, or any other container registry accessible to your execution role."},"repositoryCredentials":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceExpressGatewayRepositoryCredentials","description":"The configuration for repository credentials for private registry authentication."},"secrets":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceSecret"},"description":"The secrets to pass to the container."}},"type":"object","required":["image"]},"aws-native:ecs:ExpressGatewayServiceExpressGatewayRepositoryCredentials":{"properties":{"credentialsParameter":{"type":"string","description":"The Amazon Resource Name (ARN) of the secret containing the private repository credentials."}},"type":"object","required":["credentialsParameter"]},"aws-native:ecs:ExpressGatewayServiceExpressGatewayScalingTarget":{"properties":{"autoScalingMetric":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceScalingMetric","description":"The metric used for auto-scaling decisions. The default metric used for an Express service is `CPUUtilization` ."},"autoScalingTargetValue":{"type":"integer","description":"The target value for the auto-scaling metric. The default value for an Express service is 60."},"maxTaskCount":{"type":"integer","description":"The maximum number of tasks to run in the Express service."},"minTaskCount":{"type":"integer","description":"The minimum number of tasks to run in the Express service."}},"type":"object"},"aws-native:ecs:ExpressGatewayServiceIngressPathArns":{"properties":{"certificateArn":{"type":"string"},"listenerArn":{"type":"string"},"listenerRuleArn":{"type":"string"},"loadBalancerArn":{"type":"string"},"loadBalancerSecurityGroups":{"type":"array","items":{"type":"string"}},"targetGroupArns":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:ecs:ExpressGatewayServiceIngressPathSummary":{"properties":{"accessType":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceAccessType","description":"The type of access to the endpoint for the Express service."},"endpoint":{"type":"string","description":"The endpoint for access to the service."}},"type":"object"},"aws-native:ecs:ExpressGatewayServiceKeyValuePair":{"properties":{"name":{"type":"string","description":"The name of the key-value pair. For environment variables, this is the name of the environment variable."},"value":{"type":"string","description":"The value of the key-value pair. For environment variables, this is the value of the environment variable."}},"type":"object","required":["name","value"]},"aws-native:ecs:ExpressGatewayServiceNetworkConfiguration":{"properties":{"securityGroups":{"type":"array","items":{"type":"string"},"description":"The IDs of the security groups associated with the Express service."},"subnets":{"type":"array","items":{"type":"string"},"description":"The IDs of the subnets associated with the Express service."}},"type":"object"},"aws-native:ecs:ExpressGatewayServiceScalingMetric":{"type":"string","enum":[{"name":"AverageCpu","value":"AVERAGE_CPU"},{"name":"AverageMemory","value":"AVERAGE_MEMORY"},{"name":"RequestCountPerTarget","value":"REQUEST_COUNT_PER_TARGET"}]},"aws-native:ecs:ExpressGatewayServiceSecret":{"properties":{"name":{"type":"string","description":"The name of the secret."},"valueFrom":{"type":"string","description":"The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.\n\nFor information about the require AWS Identity and Access Management permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide* .\n\n\u003e If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified."}},"type":"object","required":["name","valueFrom"]},"aws-native:ecs:ExpressGatewayServiceStatus":{"properties":{"statusCode":{"$ref":"#/types/aws-native:ecs:ExpressGatewayServiceStatusCode","description":"The status of the Express service."}},"type":"object"},"aws-native:ecs:ExpressGatewayServiceStatusCode":{"type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Draining","value":"DRAINING"},{"name":"Inactive","value":"INACTIVE"}]},"aws-native:ecs:ExpressGatewayServiceTag":{"properties":{"key":{"type":"string","description":"One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key)."}},"type":"object","required":["key","value"]},"aws-native:ecs:ServiceAdvancedConfiguration":{"description":"The advanced settings for a load balancer used in blue/green deployments. Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments. For more information, see [Required resources for Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-deployment-implementation.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"alternateTargetGroupArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the alternate target group for Amazon ECS blue/green deployments."},"productionListenerRule":{"type":"string","description":"The Amazon Resource Name (ARN) that that identifies the production listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing production traffic."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call the Elastic Load Balancing APIs for you."},"testListenerRule":{"type":"string","description":"The Amazon Resource Name (ARN) that identifies ) that identifies the test listener rule (in the case of an Application Load Balancer) or listener (in the case for an Network Load Balancer) for routing test traffic."}},"type":"object","required":["alternateTargetGroupArn"]},"aws-native:ecs:ServiceAvailabilityZoneRebalancing":{"description":"Indicates whether to use Availability Zone rebalancing for the service.\n For more information, see [Balancing an Amazon ECS service across Availability Zones](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html) in the *Amazon Elastic Container Service Developer Guide*.\n The default behavior of ``AvailabilityZoneRebalancing`` differs between create and update requests:\n  +  For create service requests, when no value is specified for ``AvailabilityZoneRebalancing``, Amazon ECS defaults the value to ``ENABLED``.\n  +  For update service requests, when no value is specified for ``AvailabilityZoneRebalancing``, Amazon ECS defaults to the existing service’s ``AvailabilityZoneRebalancing`` value. If the service never had an ``AvailabilityZoneRebalancing`` value set, Amazon ECS treats this as ``DISABLED``.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:ecs:ServiceAwsVpcConfiguration":{"description":"An object representing the networking details for a task or service. For example ``awsVpcConfiguration={subnets=[\"subnet-12344321\"],securityGroups=[\"sg-12344321\"]}``.","properties":{"assignPublicIp":{"$ref":"#/types/aws-native:ecs:ServiceAwsVpcConfigurationAssignPublicIp","description":"Whether the task's elastic network interface receives a public IP address. \n Consider the following when you set this value:\n  +  When you use ``create-service`` or ``update-service``, the default is ``DISABLED``. \n  +  When the service ``deploymentController`` is ``ECS``, the value must be ``DISABLED``."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified.\n  All specified security groups must be from the same VPC."},"subnets":{"type":"array","items":{"type":"string"},"description":"The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified.\n  All specified subnets must be from the same VPC."}},"type":"object"},"aws-native:ecs:ServiceAwsVpcConfigurationAssignPublicIp":{"description":"Whether the task's elastic network interface receives a public IP address. \n Consider the following when you set this value:\n  +  When you use ``create-service`` or ``update-service``, the default is ``DISABLED``. \n  +  When the service ``deploymentController`` is ``ECS``, the value must be ``DISABLED``.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:ecs:ServiceCanaryConfiguration":{"description":"Configuration for a canary deployment strategy that shifts a fixed percentage of traffic to the new service revision, waits for a specified bake time, then shifts the remaining traffic. \n The following validation applies only to Canary deployments created through CFN. CFN operations time out after 36 hours. Canary deployments can approach this limit because of their extended duration. This can cause CFN to roll back the deployment. To prevent timeout-related rollbacks, CFN rejects deployments when the calculated deployment time exceeds 33 hours based on your template configuration: \n  ``BakeTimeInMinutes + CanaryBakeTimeInMinutes`` \n Additional backend processes (such as task scaling and running lifecycle hooks) can extend deployment time beyond these calculations. Even deployments under the 33-hour threshold might still time out if these processes cause the total duration to exceed 36 hours.","properties":{"canaryBakeTimeInMinutes":{"type":"integer","description":"The amount of time in minutes to wait during the canary phase before shifting the remaining production traffic to the new service revision. Valid values are 0 to 1440 minutes (24 hours). The default value is 10."},"canaryPercent":{"type":"number","description":"The percentage of production traffic to shift to the new service revision during the canary phase. Valid values are multiples of 0.1 from 0.1 to 100.0. The default value is 5.0."}},"type":"object"},"aws-native:ecs:ServiceCapacityProviderStrategyItem":{"description":"The details of a capacity provider strategy. A capacity provider strategy can be set when using the ``RunTask`` or ``CreateService`` APIs or as the default capacity provider strategy for a cluster with the ``CreateCluster`` API.\n Only capacity providers that are already associated with a cluster and have an ``ACTIVE`` or ``UPDATING`` status can be used in a capacity provider strategy. The ``PutClusterCapacityProviders`` API is used to associate a capacity provider with a cluster.\n If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the ``CreateCapacityProvider`` API operation.\n To use an FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.","properties":{"base":{"type":"integer","description":"The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider for each service. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used.\n Base value characteristics:\n  +  Only one capacity provider in a strategy can have a base defined\n  +  The default value is ``0`` if not specified\n  +  The valid range is 0 to 100,000\n  +  Base requirements are satisfied first before weight distribution"},"capacityProvider":{"type":"string","description":"The short name of the capacity provider. This can be either an AWS managed capacity provider (``FARGATE`` or ``FARGATE_SPOT``) or the name of a custom capacity provider that you created."},"weight":{"type":"integer","description":"The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied.\n If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail.\n Weight value characteristics:\n  +  Weight is considered after the base value is satisfied\n  +  The default value is ``0`` if not specified\n  +  The valid range is 0 to 1,000\n  +  At least one capacity provider must have a weight greater than zero\n  +  Capacity providers with weight of ``0`` cannot place tasks\n  \n Task distribution logic:\n  1.  Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider\n  1.  Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios\n  \n Examples:\n Equal Distribution: Two capacity providers both with weight ``1`` will split tasks evenly after base requirements are met.\n Weighted Distribution: If capacityProviderA has weight ``1`` and capacityProviderB has weight ``4``, then for every 1 task on A, 4 tasks will run on B."}},"type":"object"},"aws-native:ecs:ServiceConnectAccessLogConfiguration":{"description":"Configuration for Service Connect access logging. Access logs provide detailed information about requests made to your service, including request patterns, response codes, and timing data for debugging and monitoring purposes.\n  To enable access logs, you must also specify a ``logConfiguration`` in the ``serviceConnectConfiguration``.","properties":{"format":{"$ref":"#/types/aws-native:ecs:ServiceConnectAccessLogConfigurationFormat","description":"The format for Service Connect access log output. Choose TEXT for human-readable logs or JSON for structured data that integrates well with log analysis tools."},"includeQueryParameters":{"$ref":"#/types/aws-native:ecs:ServiceConnectAccessLogConfigurationIncludeQueryParameters","description":"Specifies whether to include query parameters in Service Connect access logs.\n When enabled, query parameters from HTTP requests are included in the access logs. Consider security and privacy implications when enabling this feature, as query parameters may contain sensitive information such as request IDs and tokens. By default, this parameter is ``DISABLED``."}},"type":"object","required":["format"]},"aws-native:ecs:ServiceConnectAccessLogConfigurationFormat":{"description":"The format for Service Connect access log output. Choose TEXT for human-readable logs or JSON for structured data that integrates well with log analysis tools.","type":"string","enum":[{"name":"Text","value":"TEXT"},{"name":"Json","value":"JSON"}]},"aws-native:ecs:ServiceConnectAccessLogConfigurationIncludeQueryParameters":{"description":"Specifies whether to include query parameters in Service Connect access logs.\n When enabled, query parameters from HTTP requests are included in the access logs. Consider security and privacy implications when enabling this feature, as query parameters may contain sensitive information such as request IDs and tokens. By default, this parameter is ``DISABLED``.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:ecs:ServiceConnectClientAlias":{"description":"Each alias (\"endpoint\") is a fully-qualified name and port number that other tasks (\"clients\") can use to connect to this service.\n Each name and port mapping must be unique within the namespace.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"dnsName":{"type":"string","description":"The ``dnsName`` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen.\n If this parameter isn't specified, the default value of ``discoveryName.namespace`` is used. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``.\n To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are ``database``, ``db``, or the lowercase name of a database, such as ``mysql`` or ``redis``. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*."},"port":{"type":"integer","description":"The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace.\n To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*."},"testTrafficRules":{"$ref":"#/types/aws-native:ecs:ServiceConnectTestTrafficRules","description":"The configuration for test traffic routing rules used during blue/green deployments with Amazon ECS Service Connect. This allows you to route a portion of traffic to the new service revision of your service for testing before shifting all production traffic."}},"type":"object","required":["port"]},"aws-native:ecs:ServiceConnectConfiguration":{"description":"The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"accessLogConfiguration":{"$ref":"#/types/aws-native:ecs:ServiceConnectAccessLogConfiguration","description":"The configuration for Service Connect access logging. Access logs capture detailed information about requests made to your service, including request patterns, response codes, and timing data. They can be useful for debugging connectivity issues, monitoring service performance, and auditing service-to-service communication for security and compliance purposes.\n  To enable access logs, you must also specify a ``logConfiguration`` in the ``serviceConnectConfiguration``."},"enabled":{"type":"boolean","description":"Specifies whether to use Service Connect with this service."},"logConfiguration":{"$ref":"#/types/aws-native:ecs:ServiceLogConfiguration","description":"The log configuration for the container. This parameter maps to ``LogConfig`` in the docker container create command and the ``--log-driver`` option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition.\n Understand the following when specifying a log configuration for your containers.\n  +  Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``,``syslog``, ``splunk``, and ``awsfirelens``.\n  +  This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.\n  +  For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n  +  For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to."},"namespace":{"type":"string","description":"The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*."},"services":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:ServiceConnectService"},"description":"The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. \n This field is not required for a \"client\" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.\n An object selects a port from the task definition, assigns a name for the CMAPlong service, and a list of aliases (endpoints) and ports for client applications to refer to this service."}},"type":"object","required":["enabled"]},"aws-native:ecs:ServiceConnectService":{"description":"The Service Connect service object configuration. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"clientAliases":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:ServiceConnectClientAlias"},"description":"The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1.\n Each alias (\"endpoint\") is a fully-qualified name and port number that other Amazon ECS tasks (\"clients\") can use to connect to this service.\n Each name and port mapping must be unique within the namespace.\n For each ``ServiceConnectService``, you must provide at least one ``clientAlias`` with one ``port``."},"discoveryName":{"type":"string","description":"The ``discoveryName`` is the name of the new CMAP service that Amazon ECS creates for this Amazon ECS service. This must be unique within the CMAP namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.\n If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``."},"ingressPortOverride":{"type":"integer","description":"The port number for the Service Connect proxy to listen on.\n Use the value of this field to bypass the proxy for traffic on the port number specified in the named ``portMapping`` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service.\n In ``awsvpc`` mode and Fargate, the default value is the container port number. The container port number is in the ``portMapping`` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy."},"portName":{"type":"string","description":"The ``portName`` must match the name of one of the ``portMappings`` from all the containers in the task definition of this Amazon ECS service."},"timeout":{"$ref":"#/types/aws-native:ecs:ServiceTimeoutConfiguration","description":"A reference to an object that represents the configured timeouts for Service Connect."},"tls":{"$ref":"#/types/aws-native:ecs:ServiceConnectTlsConfiguration","description":"A reference to an object that represents a Transport Layer Security (TLS) configuration."}},"type":"object","required":["portName"]},"aws-native:ecs:ServiceConnectTestTrafficRules":{"description":"The test traffic routing configuration for Amazon ECS blue/green deployments. This configuration allows you to define rules for routing specific traffic to the new service revision during the deployment process, allowing for safe testing before full production traffic shift.\n For more information, see [Service Connect for Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect-blue-green.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"header":{"$ref":"#/types/aws-native:ecs:ServiceConnectTestTrafficRulesHeader","description":"The HTTP header-based routing rules that determine which requests should be routed to the new service version during blue/green deployment testing. These rules provide fine-grained control over test traffic routing based on request headers."}},"type":"object","required":["header"]},"aws-native:ecs:ServiceConnectTestTrafficRulesHeader":{"properties":{"name":{"type":"string"},"value":{"$ref":"#/types/aws-native:ecs:ServiceConnectTestTrafficRulesHeaderValue"}},"type":"object","required":["name"]},"aws-native:ecs:ServiceConnectTestTrafficRulesHeaderValue":{"properties":{"exact":{"type":"string"}},"type":"object","required":["exact"]},"aws-native:ecs:ServiceConnectTlsCertificateAuthority":{"description":"The certificate root authority that secures your service.","properties":{"awsPcaAuthorityArn":{"type":"string","description":"The ARN of the AWS Private Certificate Authority certificate."}},"type":"object"},"aws-native:ecs:ServiceConnectTlsConfiguration":{"description":"The key that encrypts and decrypts your resources for Service Connect TLS.","properties":{"issuerCertificateAuthority":{"$ref":"#/types/aws-native:ecs:ServiceConnectTlsCertificateAuthority","description":"The signer certificate authority."},"kmsKey":{"type":"string","description":"The AWS Key Management Service key."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS."}},"type":"object","required":["issuerCertificateAuthority"]},"aws-native:ecs:ServiceDeploymentAlarms":{"description":"One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.\n When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.\n You can only use the ``DeploymentAlarms`` method to detect failures when the ``DeploymentController`` is set to ``ECS``.\n For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"alarmNames":{"type":"array","items":{"type":"string"},"description":"One or more CloudWatch alarm names. Use a \",\" to separate the alarms."},"enable":{"type":"boolean","description":"Determines whether to use the CloudWatch alarm option in the service deployment process."},"rollback":{"type":"boolean","description":"Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully."}},"type":"object","required":["alarmNames","enable","rollback"]},"aws-native:ecs:ServiceDeploymentCircuitBreaker":{"description":"The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type.\n  The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about API failure reasons, see [API failure reasons](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"enable":{"type":"boolean","description":"Determines whether to use the deployment circuit breaker logic for the service."},"rollback":{"type":"boolean","description":"Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully."}},"type":"object","required":["enable","rollback"]},"aws-native:ecs:ServiceDeploymentConfiguration":{"description":"Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.","properties":{"alarms":{"$ref":"#/types/aws-native:ecs:ServiceDeploymentAlarms","description":"Information about the CloudWatch alarms."},"bakeTimeInMinutes":{"type":"integer","description":"The duration when both blue and green service revisions are running simultaneously after the production traffic has shifted.\n The following rules apply when you don't specify a value:\n  +  For rolling deployments, the value is set to 3 hours (180 minutes).\n  +  When you use an external deployment controller (``EXTERNAL``), or the ACD blue/green deployment controller (``CODE_DEPLOY``), the value is set to 3 hours (180 minutes).\n  +  For all other cases, the value is set to 36 hours (2160 minutes)."},"canaryConfiguration":{"$ref":"#/types/aws-native:ecs:ServiceCanaryConfiguration","description":"Configuration for canary deployment strategy. Only valid when the deployment strategy is ``CANARY``. This configuration enables shifting a fixed percentage of traffic for testing, followed by shifting the remaining traffic after a bake period."},"deploymentCircuitBreaker":{"$ref":"#/types/aws-native:ecs:ServiceDeploymentCircuitBreaker","description":"The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type.\n  The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*"},"lifecycleHooks":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:ServiceDeploymentLifecycleHook"},"description":"An array of deployment lifecycle hook objects to run custom logic at specific stages of the deployment lifecycle."},"linearConfiguration":{"$ref":"#/types/aws-native:ecs:ServiceLinearConfiguration","description":"Configuration for linear deployment strategy. Only valid when the deployment strategy is ``LINEAR``. This configuration enables progressive traffic shifting in equal percentage increments with configurable bake times between each step."},"maximumPercent":{"type":"integer","description":"If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%.\n The Amazon ECS scheduler uses this parameter to replace unhealthy tasks by starting replacement tasks first and then stopping the unhealthy tasks, as long as cluster resources for starting replacement tasks are available. For more information about how the scheduler replaces unhealthy tasks, see [Amazon ECS services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).\n If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types, and tasks in the service use the EC2 launch type, the *maximum percent* value is set to the default value. The *maximum percent* value is used to define the upper limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state.\n  You can't specify a custom ``maximumPercent`` value for a service that uses either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and has tasks that use the EC2 launch type.\n  If the service uses either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types, and the tasks in the service use the Fargate launch type, the maximum percent value is not used. The value is still returned when describing your service."},"minimumHealthyPercent":{"type":"integer","description":"If a service is using the rolling update (``ECS``) deployment type, the ``minimumHealthyPercent`` represents a lower limit on the number of your service's tasks that must remain in the ``RUNNING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a ``desiredCount`` of four tasks and a ``minimumHealthyPercent`` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. \n  If any tasks are unhealthy and if ``maximumPercent`` doesn't allow the Amazon ECS scheduler to start replacement tasks, the scheduler stops the unhealthy tasks one-by-one — using the ``minimumHealthyPercent`` as a constraint — to clear up capacity to launch replacement tasks. For more information about how the scheduler replaces unhealthy tasks, see [Amazon ECS services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). \n For services that *do not* use a load balancer, the following should be noted:\n  +  A service is considered healthy if all essential containers within the tasks in the service pass their health checks.\n  +  If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a ``RUNNING`` state before the task is counted towards the minimum healthy percent total.\n  +  If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. \n  \n For services that *do* use a load balancer, the following should be noted:\n  +  If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.\n  +  If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total.\n  \n The default value for a replica service for ``minimumHealthyPercent`` is 100%. The default ``minimumHealthyPercent`` value for a service using the ``DAEMON`` service schedule is 0% for the CLI, the AWS SDKs, and the APIs and 50% for the AWS Management Console.\n The minimum number of healthy tasks during a deployment is the ``desiredCount`` multiplied by the ``minimumHealthyPercent``/100, rounded up to the nearest integer value.\n If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value. The *minimum healthy percent* value is used to define the lower limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state.\n  You can't specify a custom ``minimumHealthyPercent`` value for a service that uses either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and has tasks that use the EC2 launch type.\n  If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service."},"strategy":{"$ref":"#/types/aws-native:ecs:ServiceDeploymentConfigurationStrategy","description":"The deployment strategy for the service. Choose from these valid values:\n  +  ``ROLLING`` - When you create a service which uses the rolling update (``ROLLING``) deployment strategy, the Amazon ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that Amazon ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration.\n  +  ``BLUE_GREEN`` - A blue/green deployment strategy (``BLUE_GREEN``) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With Amazon ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed.\n  +  ``LINEAR`` - A *linear* deployment strategy (``LINEAR``) gradually shifts traffic from the current production environment to a new environment in equal percentages over time. With Amazon ECS linear deployments, you can control the pace of traffic shifting and validate new service revisions with increasing amounts of production traffic.\n  +  ``CANARY`` - A *canary* deployment strategy (``CANARY``) shifts a small percentage of traffic to the new service revision first, then shifts the remaining traffic all at once after a specified time period. This allows you to test the new version with a subset of users before full deployment."}},"type":"object"},"aws-native:ecs:ServiceDeploymentConfigurationStrategy":{"description":"The deployment strategy for the service. Choose from these valid values:\n  +  ``ROLLING`` - When you create a service which uses the rolling update (``ROLLING``) deployment strategy, the Amazon ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that Amazon ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration.\n  +  ``BLUE_GREEN`` - A blue/green deployment strategy (``BLUE_GREEN``) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With Amazon ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed.\n  +  ``LINEAR`` - A *linear* deployment strategy (``LINEAR``) gradually shifts traffic from the current production environment to a new environment in equal percentages over time. With Amazon ECS linear deployments, you can control the pace of traffic shifting and validate new service revisions with increasing amounts of production traffic.\n  +  ``CANARY`` - A *canary* deployment strategy (``CANARY``) shifts a small percentage of traffic to the new service revision first, then shifts the remaining traffic all at once after a specified time period. This allows you to test the new version with a subset of users before full deployment.","type":"string","enum":[{"name":"Rolling","value":"ROLLING"},{"name":"BlueGreen","value":"BLUE_GREEN"},{"name":"Linear","value":"LINEAR"},{"name":"Canary","value":"CANARY"}]},"aws-native:ecs:ServiceDeploymentController":{"description":"The deployment controller to use for the service.","properties":{"type":{"$ref":"#/types/aws-native:ecs:ServiceDeploymentControllerType","description":"The deployment controller type to use.\n The deployment controller is the mechanism that determines how tasks are deployed for your service. The valid options are:\n  +  ECS\n When you create a service which uses the ``ECS`` deployment controller, you can choose between the following deployment strategies:\n  +  ``ROLLING``: When you create a service which uses the *rolling update* (``ROLLING``) deployment strategy, the ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration. \n Rolling update deployments are best suited for the following scenarios:\n  +  Gradual service updates: You need to update your service incrementally without taking the entire service offline at once.\n  +  Limited resource requirements: You want to avoid the additional resource costs of running two complete environments simultaneously (as required by blue/green deployments).\n  +  Acceptable deployment time: Your application can tolerate a longer deployment process, as rolling updates replace tasks one by one.\n  +  No need for instant roll back: Your service can tolerate a rollback process that takes minutes rather than seconds.\n  +  Simple deployment process: You prefer a straightforward deployment approach without the complexity of managing multiple environments, target groups, and listeners.\n  +  No load balancer requirement: Your service doesn't use or require a load balancer, ALB, NLB, or Service Connect (which are required for blue/green deployments).\n  +  Stateful applications: Your application maintains state that makes it difficult to run two parallel environments.\n  +  Cost sensitivity: You want to minimize deployment costs by not running duplicate environments during deployment.\n  \n Rolling updates are the default deployment strategy for services and provide a balance between deployment safety and resource efficiency for many common application scenarios.\n  +  ``BLUE_GREEN``: A *blue/green* deployment strategy (``BLUE_GREEN``) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed.\n ECS blue/green deployments are best suited for the following scenarios:\n  +  Service validation: When you need to validate new service revisions before directing production traffic to them\n  +  Zero downtime: When your service requires zero-downtime deployments\n  +  Instant roll back: When you need the ability to quickly roll back if issues are detected\n  +  Load balancer requirement: When your service uses ALB, NLB, or Service Connect\n  \n  \n  +  External\n Use a third-party deployment controller.\n  +  Blue/green deployment (powered by ACD)\n ACD installs an updated version of the application as a new replacement task set and reroutes production traffic from the original application task set to the replacement task set. The original task set is terminated after a successful deployment. Use this deployment controller to verify a new deployment of a service before sending production traffic to it.\n  \n When updating the deployment controller for a service, consider the following depending on the type of migration you're performing.\n  +  If you have a template that contains the ``EXTERNAL`` deployment controller information as well as ``TaskSet`` and ``PrimaryTaskSet`` resources, and you remove the task set resources from the template when updating from ``EXTERNAL`` to ``ECS``, the ``DescribeTaskSet`` and ``DeleteTaskSet`` API calls will return a 400 error after the deployment controller is updated to ``ECS``. This results in a delete failure on the task set resources, even though the stack transitions to ``UPDATE_COMPLETE`` status. For more information, see [Resource removed from stack but not deleted](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-resource-removed-not-deleted) in the CFNlong User Guide. To fix this issue, delete the task sets directly using the ECS``DeleteTaskSet`` API. For more information about how to delete a task set, see [DeleteTaskSet](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskSet.html) in the ECSlong API Reference.\n  +  If you're migrating from ``CODE_DEPLOY`` to ``ECS`` with a new task definition and CFN performs a rollback operation, the ECS``UpdateService`` request fails with the following error:\n Resource handler returned message: \"Invalid request provided: Unable to update task definition on services with a CODE_DEPLOY deployment controller. \n  +  After a successful migration from ``ECS`` to ``EXTERNAL`` deployment controller, you need to manually remove the ``ACTIVE`` task set, because ECS no longer manages the deployment. For information about how to delete a task set, see [DeleteTaskSet](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskSet.html) in the ECSlong API Reference."}},"type":"object"},"aws-native:ecs:ServiceDeploymentControllerType":{"description":"The deployment controller type to use.\n The deployment controller is the mechanism that determines how tasks are deployed for your service. The valid options are:\n  +  ECS\n When you create a service which uses the ``ECS`` deployment controller, you can choose between the following deployment strategies:\n  +  ``ROLLING``: When you create a service which uses the *rolling update* (``ROLLING``) deployment strategy, the ECS service scheduler replaces the currently running tasks with new tasks. The number of tasks that ECS adds or removes from the service during a rolling update is controlled by the service deployment configuration. \n Rolling update deployments are best suited for the following scenarios:\n  +  Gradual service updates: You need to update your service incrementally without taking the entire service offline at once.\n  +  Limited resource requirements: You want to avoid the additional resource costs of running two complete environments simultaneously (as required by blue/green deployments).\n  +  Acceptable deployment time: Your application can tolerate a longer deployment process, as rolling updates replace tasks one by one.\n  +  No need for instant roll back: Your service can tolerate a rollback process that takes minutes rather than seconds.\n  +  Simple deployment process: You prefer a straightforward deployment approach without the complexity of managing multiple environments, target groups, and listeners.\n  +  No load balancer requirement: Your service doesn't use or require a load balancer, ALB, NLB, or Service Connect (which are required for blue/green deployments).\n  +  Stateful applications: Your application maintains state that makes it difficult to run two parallel environments.\n  +  Cost sensitivity: You want to minimize deployment costs by not running duplicate environments during deployment.\n  \n Rolling updates are the default deployment strategy for services and provide a balance between deployment safety and resource efficiency for many common application scenarios.\n  +  ``BLUE_GREEN``: A *blue/green* deployment strategy (``BLUE_GREEN``) is a release methodology that reduces downtime and risk by running two identical production environments called blue and green. With ECS blue/green deployments, you can validate new service revisions before directing production traffic to them. This approach provides a safer way to deploy changes with the ability to quickly roll back if needed.\n ECS blue/green deployments are best suited for the following scenarios:\n  +  Service validation: When you need to validate new service revisions before directing production traffic to them\n  +  Zero downtime: When your service requires zero-downtime deployments\n  +  Instant roll back: When you need the ability to quickly roll back if issues are detected\n  +  Load balancer requirement: When your service uses ALB, NLB, or Service Connect\n  \n  \n  +  External\n Use a third-party deployment controller.\n  +  Blue/green deployment (powered by ACD)\n ACD installs an updated version of the application as a new replacement task set and reroutes production traffic from the original application task set to the replacement task set. The original task set is terminated after a successful deployment. Use this deployment controller to verify a new deployment of a service before sending production traffic to it.\n  \n When updating the deployment controller for a service, consider the following depending on the type of migration you're performing.\n  +  If you have a template that contains the ``EXTERNAL`` deployment controller information as well as ``TaskSet`` and ``PrimaryTaskSet`` resources, and you remove the task set resources from the template when updating from ``EXTERNAL`` to ``ECS``, the ``DescribeTaskSet`` and ``DeleteTaskSet`` API calls will return a 400 error after the deployment controller is updated to ``ECS``. This results in a delete failure on the task set resources, even though the stack transitions to ``UPDATE_COMPLETE`` status. For more information, see [Resource removed from stack but not deleted](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-resource-removed-not-deleted) in the CFNlong User Guide. To fix this issue, delete the task sets directly using the ECS``DeleteTaskSet`` API. For more information about how to delete a task set, see [DeleteTaskSet](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskSet.html) in the ECSlong API Reference.\n  +  If you're migrating from ``CODE_DEPLOY`` to ``ECS`` with a new task definition and CFN performs a rollback operation, the ECS``UpdateService`` request fails with the following error:\n Resource handler returned message: \"Invalid request provided: Unable to update task definition on services with a CODE_DEPLOY deployment controller. \n  +  After a successful migration from ``ECS`` to ``EXTERNAL`` deployment controller, you need to manually remove the ``ACTIVE`` task set, because ECS no longer manages the deployment. For information about how to delete a task set, see [DeleteTaskSet](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteTaskSet.html) in the ECSlong API Reference.","type":"string","enum":[{"name":"CodeDeploy","value":"CODE_DEPLOY"},{"name":"Ecs","value":"ECS"},{"name":"External","value":"EXTERNAL"}]},"aws-native:ecs:ServiceDeploymentLifecycleHook":{"description":"A deployment lifecycle hook runs custom logic at specific stages of the deployment process. Currently, you can use Lambda functions as hook targets.\n For more information, see [Lifecycle hooks for Amazon ECS service deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-lifecycle-hooks.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"hookDetails":{"$ref":"pulumi.json#/Any","description":"Use this field to specify custom parameters that ECS passes to your hook target invocations (such as a Lambda function).\n This field must be a JSON object as a string."},"hookTargetArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the hook target. Currently, only Lambda function ARNs are supported.\n You must provide this parameter when configuring a deployment lifecycle hook."},"lifecycleStages":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:ServiceDeploymentLifecycleHookLifecycleStagesItem"},"description":"The lifecycle stages at which to run the hook. Choose from these valid values:\n  +  RECONCILE_SERVICE\n The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.\n You can use a lifecycle hook for this stage.\n  +  PRE_SCALE_UP\n The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.\n You can use a lifecycle hook for this stage.\n  +  POST_SCALE_UP\n The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.\n You can use a lifecycle hook for this stage.\n  +  TEST_TRAFFIC_SHIFT\n The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.\n You can use a lifecycle hook for this stage.\n  +  POST_TEST_TRAFFIC_SHIFT\n The test traffic shift is complete. The green service revision handles 100% of the test traffic.\n You can use a lifecycle hook for this stage.\n  +  PRODUCTION_TRAFFIC_SHIFT\n Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.\n You can use a lifecycle hook for this stage.\n  +  POST_PRODUCTION_TRAFFIC_SHIFT\n The production traffic shift is complete.\n You can use a lifecycle hook for this stage.\n  \n You must provide this parameter when configuring a deployment lifecycle hook."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf.\n For more information, see [Permissions required for Lambda functions in Amazon ECS blue/green deployments](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/blue-green-permissions.html) in the *Amazon Elastic Container Service Developer Guide*."}},"type":"object","required":["hookTargetArn","lifecycleStages","roleArn"]},"aws-native:ecs:ServiceDeploymentLifecycleHookLifecycleStagesItem":{"type":"string","enum":[{"name":"ReconcileService","value":"RECONCILE_SERVICE"},{"name":"PreScaleUp","value":"PRE_SCALE_UP"},{"name":"PostScaleUp","value":"POST_SCALE_UP"},{"name":"TestTrafficShift","value":"TEST_TRAFFIC_SHIFT"},{"name":"PostTestTrafficShift","value":"POST_TEST_TRAFFIC_SHIFT"},{"name":"ProductionTrafficShift","value":"PRODUCTION_TRAFFIC_SHIFT"},{"name":"PostProductionTrafficShift","value":"POST_PRODUCTION_TRAFFIC_SHIFT"}]},"aws-native:ecs:ServiceEbsTagSpecification":{"description":"The tag specifications of an Amazon EBS volume.","properties":{"propagateTags":{"$ref":"#/types/aws-native:ecs:ServiceEbsTagSpecificationPropagateTags","description":"Determines whether to propagate the tags from the task definition to \nthe Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in \n``ServiceVolumeConfiguration``. If no value is specified, the tags aren't \npropagated."},"resourceType":{"type":"string","description":"The type of volume resource."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:ServiceTag"},"description":"The tags applied to this Amazon EBS volume. ``AmazonECSCreated`` and ``AmazonECSManaged`` are reserved tags that can't be used."}},"type":"object","required":["resourceType"]},"aws-native:ecs:ServiceEbsTagSpecificationPropagateTags":{"description":"Determines whether to propagate the tags from the task definition to \nthe Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in \n``ServiceVolumeConfiguration``. If no value is specified, the tags aren't \npropagated.","type":"string","enum":[{"name":"Service","value":"SERVICE"},{"name":"TaskDefinition","value":"TASK_DEFINITION"}]},"aws-native:ecs:ServiceForceNewDeployment":{"description":"Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (``my_image:latest``) or to roll Fargate tasks onto a newer platform version.","properties":{"enableForceNewDeployment":{"type":"boolean","description":"Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (``my_image:latest``) or to roll Fargate tasks onto a newer platform version."},"forceNewDeploymentNonce":{"type":"string","description":"When you change the``ForceNewDeploymentNonce`` value in your template, it signals ECS to start a new deployment even though no other service parameters have changed. The value must be a unique, time- varying value like a timestamp, random string, or sequence number. Use this property when you want to ensure your tasks pick up the latest version of a Docker image that uses the same tag but has been updated in the registry."}},"type":"object","required":["enableForceNewDeployment"]},"aws-native:ecs:ServiceLaunchType":{"description":"The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.\n  If you want to use Managed Instances, you must use the ``capacityProviderStrategy`` request parameter","type":"string","enum":[{"name":"Ec2","value":"EC2"},{"name":"Fargate","value":"FARGATE"},{"name":"External","value":"EXTERNAL"}]},"aws-native:ecs:ServiceLinearConfiguration":{"description":"Configuration for a linear deployment strategy that shifts production traffic in equal percentage increments with configurable wait times between each step until 100 percent of traffic is shifted to the new service revision. \n The following validation applies only to Linear deployments created through CFN. CFN operations time out after 36 hours. Linear deployments can approach this limit because of their extended duration. This can cause CFN to roll back the deployment. To prevent timeout-related rollbacks, CFN rejects deployments when the calculated deployment time exceeds 33 hours based on your template configuration: \n  ``BakeTimeInMinutes + (StepBakeTimeInMinutes × Number of deployment steps)`` \n Where the number of deployment steps is calculated as follows:\n  +  *If StepPercent evenly divides by 100*: The number of deployment steps equals ``(100 ÷ StepPercent) - 1``\n  +  *Otherwise*: The number of deployment steps equals the floor of ``100 ÷ StepPercent``. For example, if ``StepPercent`` is 11, the number of deployment steps is 9 (not 9.1).\n  \n This calculation reflects that CFN doesn't apply the step bake time after the final traffic shift reaches 100%. For example, with a ``StepPercent`` of 50%, there are actually two traffic shifts, but only one deployment step is counted for validation purposes because the bake time is applied only after the first 50% shift, not after reaching 100%.\n Additional backend processes (such as task scaling and running lifecycle hooks) can extend deployment time beyond these calculations. Even deployments under the 33-hour threshold might still time out if these processes cause the total duration to exceed 36 hours.","properties":{"stepBakeTimeInMinutes":{"type":"integer","description":"The amount of time in minutes to wait between each traffic shifting step during a linear deployment. Valid values are 0 to 1440 minutes (24 hours). The default value is 6. This bake time is not applied after reaching 100 percent traffic."},"stepPercent":{"type":"number","description":"The percentage of production traffic to shift in each step during a linear deployment. Valid values are multiples of 0.1 from 3.0 to 100.0. The default value is 10.0."}},"type":"object"},"aws-native:ecs:ServiceLoadBalancer":{"description":"The ``LoadBalancer`` property specifies details on a load balancer that is used with a service.\n If the service is using the ``CODE_DEPLOY`` deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an ACDlong deployment group, you specify two target groups (referred to as a ``targetGroupPair``). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.\n Services with tasks that use the ``awsvpc`` network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ``ip`` as the target type, not ``instance``. Tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance.","properties":{"advancedConfiguration":{"$ref":"#/types/aws-native:ecs:ServiceAdvancedConfiguration","description":"The advanced settings for the load balancer used in blue/green deployments. Specify the alternate target group, listener rules, and IAM role required for traffic shifting during blue/green deployments."},"containerName":{"type":"string","description":"The name of the container (as it appears in a container definition) to associate with the load balancer.\n You need to specify the container name when configuring the target group for an Amazon ECS load balancer."},"containerPort":{"type":"integer","description":"The port on the container to associate with the load balancer. This port must correspond to a ``containerPort`` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the ``hostPort`` of the port mapping."},"loadBalancerName":{"type":"string","description":"The name of the load balancer to associate with the Amazon ECS service or task set.\n If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted."},"targetGroupArn":{"type":"string","description":"The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.\n A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. \n For services using the ``ECS`` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*.\n For services using the ``CODE_DEPLOY`` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*.\n  If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance``. Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type."}},"type":"object"},"aws-native:ecs:ServiceLogConfiguration":{"description":"The log configuration for the container. This parameter maps to ``LogConfig`` in the docker container create command and the ``--log-driver`` option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition.\n Understand the following when specifying a log configuration for your containers.\n  +  Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``,``syslog``, ``splunk``, and ``awsfirelens``.\n  +  This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.\n  +  For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n  +  For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.","properties":{"logDriver":{"type":"string","description":"The log driver to use for the container.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``syslog``, ``splunk``, and ``awsfirelens``.\n For more information about using the ``awslogs`` log driver, see [Send Amazon ECS logs to CloudWatch](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about using the ``awsfirelens`` log driver, see [Send Amazon ECS logs to an service or Partner](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html).\n  If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software."},"options":{"type":"object","additionalProperties":{"type":"string"},"description":"The configuration options to send to the log driver.\n The options you can specify depend on the log driver. Some of the options you can specify when you use the ``awslogs`` log driver to route logs to Amazon CloudWatch include the following:\n  + awslogs-create-group Required: No Specify whether you want the log group to be created automatically. If this option isn't specified, it defaults to false. Your IAM policy must include the logs:CreateLogGroup permission before you attempt to use awslogs-create-group. + awslogs-region Required: Yes Specify the Region that the awslogs log driver is to send your Docker logs to. You can choose to send all of your logs from clusters in different Regions to a single region in CloudWatch Logs. This is so that they're all visible in one location. Otherwise, you can separate them by Region for more granularity. Make sure that the specified log group exists in the Region that you specify with this option. + awslogs-group Required: Yes Make sure to specify a log group that the awslogs log driver sends its log streams to. + awslogs-stream-prefix Required: Yes, when using Fargate.Optional when using EC2. Use the awslogs-stream-prefix option to associate a log stream with the specified prefix, the container name, and the ID of the Amazon ECS task that the container belongs to. If you specify a prefix with this option, then the log stream takes the format prefix-name/container-name/ecs-task-id. If you don't specify a prefix with this option, then the log stream is named after the container ID that's assigned by the Docker daemon on the container instance. Because it's difficult to trace logs back to the container that sent them with just the Docker container ID (which is only available on the container instance), we recommend that you specify a prefix with this option. For Amazon ECS services, you can use the service name as the prefix. Doing so, you can trace log streams to the service that the container belongs to, the name of the container that sent them, and the ID of the task that the container belongs to. You must specify a stream-prefix for your logs to have your logs appear in the Log pane when using the Amazon ECS console. + awslogs-datetime-format Required: No This option defines a multiline start pattern in Python strftime format. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages. One example of a use case for using this format is for parsing output such as a stack dump, which might otherwise be logged in multiple entries. The correct pattern allows it to be captured in a single entry. For more information, see awslogs-datetime-format. You cannot configure both the awslogs-datetime-format and awslogs-multiline-pattern options. Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance. + awslogs-multiline-pattern Required: No This option defines a multiline start pattern that uses a regular expression. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages. For more information, see awslogs-multiline-pattern. This option is ignored if awslogs-datetime-format is also configured. You cannot configure both the awslogs-datetime-format and awslogs-multiline-pattern options. Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance. \n The following options apply to all supported log drivers.\n  + mode Required: No Valid values: non-blocking | blocking This option defines the delivery mode of log messages from the container to the log driver specified using logDriver. The delivery mode you choose affects application availability when the flow of logs from container is interrupted. If you use the blocking mode and the flow of logs is interrupted, calls from container code to write to the stdout and stderr streams will block. The logging thread of the application will block as a result. This may cause the application to become unresponsive and lead to container healthcheck failure. If you use the non-blocking mode, the container's logs are instead stored in an in-memory intermediate buffer configured with the max-buffer-size option. This prevents the application from becoming unresponsive when logs cannot be sent. We recommend using this mode if you want to ensure service availability and are okay with some log loss. For more information, see Preventing log loss with non-blocking mode in the awslogs container log driver. You can set a default mode for all containers in a specific Region by using the defaultLogDriverMode account setting. If you don't specify the mode option or configure the account setting, Amazon ECS will default to the non-blocking mode. For more information about the account setting, see Default log driver mode in the Amazon Elastic Container Service Developer Guide. On June 25, 2025, Amazon ECS changed the default log driver mode from blocking to non-blocking to prioritize task availability over logging. To continue using the blocking mode after this change, do one of the following: Set the mode option in your container definition's logConfiguration as blocking. Set the defaultLogDriverMode account setting to blocking. + max-buffer-size Required: No Default value: 10m When non-blocking mode is used, the max-buffer-size log option controls the size of the buffer that's used for intermediate message storage. Make sure to specify an adequate buffer size based on your application. When the buffer fills up, further logs cannot be stored. Logs that cannot be stored are lost. \n To route logs using the ``splunk`` log router, you need to specify a ``splunk-token`` and a ``splunk-url``.\n When you use the ``awsfirelens`` log router to route logs to an AWS Service or AWS Partner Network destination for log storage and analytics, you can set the ``log-driver-buffer-limit`` option to limit the number of events that are buffered in memory, before being sent to the log router container. It can help to resolve potential log loss issue because high throughput might result in memory running out for the buffer inside of Docker.\n Other options you can specify when using ``awsfirelens`` to route logs depend on the destination. When you export logs to Amazon Data Firehose, you can specify the AWS Region with ``region`` and a name for the log stream with ``delivery_stream``.\n When you export logs to Amazon Kinesis Data Streams, you can specify an AWS Region with ``region`` and a data stream name with ``stream``.\n  When you export logs to Amazon OpenSearch Service, you can specify options like ``Name``, ``Host`` (OpenSearch Service endpoint without protocol), ``Port``, ``Index``, ``Type``, ``Aws_auth``, ``Aws_region``, ``Suppress_Type_Name``, and ``tls``. For more information, see [Under the hood: FireLens for Amazon ECS Tasks](https://docs.aws.amazon.com/containers/under-the-hood-firelens-for-amazon-ecs-tasks/).\n When you export logs to Amazon S3, you can specify the bucket using the ``bucket`` option. You can also specify ``region``, ``total_file_size``, ``upload_timeout``, and ``use_put_object`` as options.\n This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``"},"secretOptions":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:ServiceSecret"},"description":"The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*."}},"type":"object"},"aws-native:ecs:ServiceManagedEbsVolumeConfiguration":{"description":"The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. For information about the supported launch types and operating systems, see [Supported operating systems and launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volumes-configuration) in the*Amazon Elastic Container Service Developer Guide*.\n Many of these parameters map 1:1 with the Amazon EBS ``CreateVolume`` API request parameters.","properties":{"encrypted":{"type":"boolean","description":"Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS encryption by default but set this value as ``false``, the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*."},"filesystemType":{"type":"string","description":"The filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the tasks will fail to start.\n The available Linux filesystem types are\n ``ext3``, ``ext4``, and ``xfs``. If no value is specified, the ``xfs`` filesystem type is used by default.\n The available Windows filesystem types are ``NTFS``."},"iops":{"type":"integer","description":"The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\n The following are the supported values for each volume type.\n  +  ``gp3``: 3,000 - 16,000 IOPS\n  +  ``io1``: 100 - 64,000 IOPS\n  +  ``io2``: 100 - 256,000 IOPS\n  \n This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS``. This parameter is not supported for ``st1``, ``sc1``, or ``standard`` volume types.\n This parameter maps 1:1 with the ``Iops`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*."},"kmsKeyId":{"type":"string","description":"The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information about encrypting Amazon EBS volumes attached to tasks, see [Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html).\n  AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails."},"roleArn":{"type":"string","description":"The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide*."},"sizeInGiB":{"type":"integer","description":"The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the ``Size`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.\n The following are the supported volume size values for each volume type.\n  +  ``gp2`` and ``gp3``: 1-16,384\n  +  ``io1`` and ``io2``: 4-16,384\n  +  ``st1`` and ``sc1``: 125-16,384\n  +  ``standard``: 1-1,024"},"snapshotId":{"type":"string","description":"The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service. You must specify either ``snapshotId`` or ``sizeInGiB`` in your volume configuration. This parameter maps 1:1 with the ``SnapshotId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*."},"tagSpecifications":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:ServiceEbsTagSpecification"},"description":"The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*."},"throughput":{"type":"integer","description":"The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the ``Throughput`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.\n  This parameter is only supported for the ``gp3`` volume type."},"volumeInitializationRate":{"type":"integer","description":"The rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume to create new volumes for attachment to the tasks maintained by the service. This property can be specified only if you specify a ``snapshotId``. For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EBS User Guide*."},"volumeType":{"type":"string","description":"The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*.\n The following are the supported volume types.\n  +  General Purpose SSD: ``gp2``|``gp3``\n  +  Provisioned IOPS SSD: ``io1``|``io2``\n  +  Throughput Optimized HDD: ``st1``\n  +  Cold HDD: ``sc1``\n  +  Magnetic: ``standard``\n  The magnetic volume type is not supported on Fargate."}},"type":"object","required":["roleArn"]},"aws-native:ecs:ServiceNetworkConfiguration":{"description":"The network configuration for a task or service.","properties":{"awsvpcConfiguration":{"$ref":"#/types/aws-native:ecs:ServiceAwsVpcConfiguration","description":"The VPC subnets and security groups that are associated with a task.\n  All specified subnets and security groups must be from the same VPC."}},"type":"object"},"aws-native:ecs:ServicePlacementConstraint":{"description":"An object representing a constraint on task placement. For more information, see [Task placement constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide*.\n  If you're using the Fargate launch type, task placement constraints aren't supported.","properties":{"expression":{"type":"string","description":"A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is ``distinctInstance``. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*."},"type":{"$ref":"#/types/aws-native:ecs:ServicePlacementConstraintType","description":"The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates."}},"type":"object","required":["type"]},"aws-native:ecs:ServicePlacementConstraintType":{"description":"The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates.","type":"string","enum":[{"name":"DistinctInstance","value":"distinctInstance"},{"name":"MemberOf","value":"memberOf"}]},"aws-native:ecs:ServicePlacementStrategy":{"description":"The task placement strategy for a task or service. For more information, see [Task placement strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"field":{"type":"string","description":"The field to apply the placement strategy against. For the ``spread`` placement strategy, valid values are ``instanceId`` (or ``host``, which has the same effect), or any platform or custom attribute that's applied to a container instance, such as ``attribute:ecs.availability-zone``. For the ``binpack`` placement strategy, valid values are ``cpu`` and ``memory``. For the ``random`` placement strategy, this field is not used."},"type":{"$ref":"#/types/aws-native:ecs:ServicePlacementStrategyType","description":"The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task."}},"type":"object","required":["type"]},"aws-native:ecs:ServicePlacementStrategyType":{"description":"The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.","type":"string","enum":[{"name":"Binpack","value":"binpack"},{"name":"Random","value":"random"},{"name":"Spread","value":"spread"}]},"aws-native:ecs:ServicePropagateTags":{"description":"Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.\n You must set this to a value other than ``NONE`` when you use Cost Explorer. For more information, see [Amazon ECS usage reports](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/usage-reports.html) in the *Amazon Elastic Container Service Developer Guide*.\n The default is ``NONE``.","type":"string","enum":[{"name":"Service","value":"SERVICE"},{"name":"TaskDefinition","value":"TASK_DEFINITION"}]},"aws-native:ecs:ServiceRegistry":{"description":"The details for the service registry.\n Each service may be associated with one service registry. Multiple service registries for each service are not supported.\n When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.","properties":{"containerName":{"type":"string","description":"The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition that your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both."},"containerPort":{"type":"integer","description":"The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both."},"port":{"type":"integer","description":"The port value used if your service discovery service specified an SRV record. This field might be used if both the ``awsvpc`` network mode and SRV records are used."},"registryArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is CMAP. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html)."}},"type":"object"},"aws-native:ecs:ServiceSchedulingStrategy":{"description":"The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).\n There are two service scheduler strategies available:\n  +  ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types.\n  +  ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.\n  Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy.","type":"string","enum":[{"name":"Daemon","value":"DAEMON"},{"name":"Replica","value":"REPLICA"}]},"aws-native:ecs:ServiceSecret":{"description":"An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:\n  +  To inject sensitive data into your containers as environment variables, use the ``secrets`` container definition parameter.\n  +  To reference sensitive information in the log configuration of a container, use the ``secretOptions`` container definition parameter.\n  \n For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"name":{"type":"string","description":"The name of the secret."},"valueFrom":{"type":"string","description":"The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store.\n For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*.\n  If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified."}},"type":"object","required":["name","valueFrom"]},"aws-native:ecs:ServiceTag":{"description":"The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.\n The following basic restrictions apply to tags:\n  +  Maximum number of tags per resource - 50\n  +  For each resource, each tag key must be unique, and each tag key can have only one value.\n  +  Maximum key length - 128 Unicode characters in UTF-8\n  +  Maximum value length - 256 Unicode characters in UTF-8\n  +  If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n  +  Tag keys and values are case-sensitive.\n  +  Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.\n  \n In order to tag a service that has the following ARN format, you need to migrate the service to the long ARN. You must use the API, CLI or console to migrate the service ARN. For more information, see [Migrate an short service ARN to a long ARN](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-arn-migration.html) in the *Developer Guide*.\n  ``arn:aws:ecs:region:aws_account_id:service/service-name`` \n After the migration is complete, the following are true:\n  +   The service ARN is: ``arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name``\n  +  You can use CFN to tag the service as you would a service with a long ARN format.\n  +  When the ``PhysicalResourceId`` in the CFN stack represents a service, the value does not change and will be the short service ARN.","properties":{"key":{"type":"string","description":"One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key)."}},"type":"object"},"aws-native:ecs:ServiceTimeoutConfiguration":{"description":"An object that represents the timeout configurations for Service Connect.\n  If ``idleTimeout`` is set to a time that is less than ``perRequestTimeout``, the connection will close when the ``idleTimeout`` is reached and not the ``perRequestTimeout``.","properties":{"idleTimeoutSeconds":{"type":"integer","description":"The amount of time in seconds a connection will stay active while idle. A value of ``0`` can be set to disable ``idleTimeout``.\n The ``idleTimeout`` default for ``HTTP``/``HTTP2``/``GRPC`` is 5 minutes.\n The ``idleTimeout`` default for ``TCP`` is 1 hour."},"perRequestTimeoutSeconds":{"type":"integer","description":"The amount of time waiting for the upstream to respond with a complete response per request. A value of ``0`` can be set to disable ``perRequestTimeout``. ``perRequestTimeout`` can only be set if Service Connect ``appProtocol`` isn't ``TCP``. Only ``idleTimeout`` is allowed for ``TCP````appProtocol``."}},"type":"object"},"aws-native:ecs:ServiceVolumeConfiguration":{"description":"The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.","properties":{"managedEbsVolume":{"$ref":"#/types/aws-native:ecs:ServiceManagedEbsVolumeConfiguration","description":"The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created."},"name":{"type":"string","description":"The name of the volume. This value must match the volume name from the ``Volume`` object in the task definition."}},"type":"object","required":["name"]},"aws-native:ecs:ServiceVpcLatticeConfiguration":{"description":"The VPC Lattice configuration for your service that holds the information for the target group(s) Amazon ECS tasks will be registered to.","properties":{"portName":{"type":"string","description":"The name of the port mapping to register in the VPC Lattice target group. This is the name of the ``portMapping`` you defined in your task definition."},"roleArn":{"type":"string","description":"The ARN of the IAM role to associate with this VPC Lattice configuration. This is the Amazon ECS\n infrastructure IAM role that is used to manage your VPC Lattice infrastructure."},"targetGroupArn":{"type":"string","description":"The full Amazon Resource Name (ARN) of the target group or groups associated with the VPC Lattice configuration that the Amazon ECS tasks will be registered to."}},"type":"object","required":["portName","roleArn","targetGroupArn"]},"aws-native:ecs:TaskDefinitionAuthorizationConfig":{"description":"The authorization configuration details for the Amazon EFS file system.","properties":{"accessPointId":{"type":"string","description":"The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*."},"iam":{"$ref":"#/types/aws-native:ecs:TaskDefinitionAuthorizationConfigIam","description":"Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*."}},"type":"object"},"aws-native:ecs:TaskDefinitionAuthorizationConfigIam":{"description":"Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:ecs:TaskDefinitionContainerDefinition":{"description":"The ``ContainerDefinition`` property specifies a container definition. Container definitions are used in task definitions to describe the different containers that are launched as part of a task.","properties":{"command":{"type":"array","items":{"type":"string"},"description":"The command that's passed to the container. This parameter maps to ``Cmd`` in the docker container create command and the ``COMMAND`` parameter to docker run. If there are multiple arguments, each argument is a separated string in the array."},"cpu":{"type":"integer","description":"The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the docker container create command and the ``--cpu-shares`` option to docker run.\n This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value.\n  You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://docs.aws.amazon.com/ec2/instance-types/) detail page by 1,024.\n  Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units.\n On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. The minimum valid CPU share value that the Linux kernel allows is 2, and the maximum valid CPU share value that the Linux kernel allows is 262144. However, the CPU parameter isn't required, and you can use CPU values below 2 or above 262144 in your container definitions. For CPU values below 2 (including null) or above 262144, the behavior varies based on your Amazon ECS container agent version:\n  +  *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.\n  +  *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2.\n  +  *Agent versions greater than or equal to 1.84.0:* CPU values greater than 256 vCPU are passed to Docker as 256, which is equivalent to 262144 CPU shares.\n  \n On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0``, which Windows interprets as 1% of one CPU."},"credentialSpecs":{"type":"array","items":{"type":"string"},"description":"A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1.\n There are two formats for each ARN.\n  + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. \n In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3.\n If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html)."},"dependsOn":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionContainerDependency"},"description":"The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.\n For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n  +  Linux platform version ``1.3.0`` or later.\n  +  Windows platform version ``1.0.0`` or later.\n  \n If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported."},"disableNetworking":{"type":"boolean","description":"When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the docker container create command.\n  This parameter is not supported for Windows containers."},"dnsSearchDomains":{"type":"array","items":{"type":"string"},"description":"A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the docker container create command and the ``--dns-search`` option to docker run.\n  This parameter is not supported for Windows containers."},"dnsServers":{"type":"array","items":{"type":"string"},"description":"A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the docker container create command and the ``--dns`` option to docker run.\n  This parameter is not supported for Windows containers."},"dockerLabels":{"type":"object","additionalProperties":{"type":"string"},"description":"A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the docker container create command and the ``--label`` option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``"},"dockerSecurityOptions":{"type":"array","items":{"type":"string"},"description":"A list of strings to provide custom configuration for multiple security systems. This field isn't valid for containers in tasks using the Fargate launch type.\n For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems.\n For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*.\n This parameter maps to ``SecurityOpt`` in the docker container create command and the ``--security-opt`` option to docker run.\n  The Amazon ECS container agent running on a container instance must register with the ``ECS_SELINUX_CAPABLE=true`` or ``ECS_APPARMOR_CAPABLE=true`` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*.\n  Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" | \"credentialspec:CredentialSpecFilePath\""},"entryPoint":{"type":"array","items":{"type":"string"},"description":"Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead.\n  The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in the docker container create command and the ``--entrypoint`` option to docker run."},"environment":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionKeyValuePair"},"description":"The environment variables to pass to a container. This parameter maps to ``Env`` in the docker container create command and the ``--env`` option to docker run.\n  We don't recommend that you use plaintext environment variables for sensitive information, such as credential data."},"environmentFiles":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionEnvironmentFile"},"description":"A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to docker run.\n You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored.\n If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*."},"essential":{"type":"boolean","description":"If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.\n All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*."},"extraHosts":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionHostEntry"},"description":"A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the docker container create command and the ``--add-host`` option to docker run.\n  This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode."},"firelensConfiguration":{"$ref":"#/types/aws-native:ecs:TaskDefinitionFirelensConfiguration","description":"The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*."},"healthCheck":{"$ref":"#/types/aws-native:ecs:TaskDefinitionHealthCheck","description":"The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the docker container create command and the ``HEALTHCHECK`` parameter of docker run."},"hostname":{"type":"string","description":"The hostname to use for your container. This parameter maps to ``Hostname`` in the docker container create command and the ``--hostname`` option to docker run.\n  The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode."},"image":{"type":"string","description":"The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. For images using tags (repository-url/image:tag), up to 255 characters total are allowed, including letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs (#). For images using digests (repository-url/image@digest), the 255 character limit applies only to the repository URL and image name (everything before the @ sign). The only supported hash function is sha256, and the hash value after sha256: must be exactly 64 characters (only letters A-F, a-f, and numbers 0-9 are allowed). This parameter maps to ``Image`` in the docker container create command and the ``IMAGE`` parameter of docker run.\n  +  When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks.\n  +  Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest``. For example, ``012345678910.dkr.ecr.\u003cregion-name\u003e.amazonaws.com/\u003crepository-name\u003e:latest`` or ``012345678910.dkr.ecr.\u003cregion-name\u003e.amazonaws.com/\u003crepository-name\u003e@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE``. \n  +  Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``).\n  +  Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``).\n  +  Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``)."},"interactive":{"type":"boolean","description":"When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the docker container create command and the ``--interactive`` option to docker run."},"links":{"type":"array","items":{"type":"string"},"description":"The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps to ``Links`` in the docker container create command and the ``--link`` option to docker run.\n  This parameter is not supported for Windows containers.\n   Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings."},"linuxParameters":{"$ref":"#/types/aws-native:ecs:TaskDefinitionLinuxParameters","description":"Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).\n  This parameter is not supported for Windows containers."},"logConfiguration":{"$ref":"#/types/aws-native:ecs:TaskDefinitionLogConfiguration","description":"The log configuration specification for the container.\n This parameter maps to ``LogConfig`` in the docker Create a container command and the ``--log-driver`` option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation.\n  Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.\n  This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``\n  The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Developer Guide*."},"memory":{"type":"integer","description":"The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).\n If using the Fargate launch type, this parameter is optional.\n If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used.\n The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers.\n The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers."},"memoryReservation":{"type":"integer","description":"The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the docker container create command and the ``--memory-reservation`` option to docker run.\n If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used.\n For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.\n The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. \n The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers."},"mountPoints":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionMountPoint"},"description":"The mount points for data volumes in your container.\n This parameter maps to ``Volumes`` in the docker container create command and the ``--volume`` option to docker run.\n Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives."},"name":{"type":"string","description":"The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in the docker container create command and the ``--name`` option to docker run."},"portMappings":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionPortMapping"},"description":"The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.\n For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``.\n Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. \n This parameter maps to ``PortBindings`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--publish`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to ``none``, then you can't specify port mappings. If the network mode of a task definition is set to ``host``, then host ports must either be undefined or they must match the container port in the port mapping.\n  After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the ``networkBindings`` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses."},"privileged":{"type":"boolean","description":"When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the docker container create command and the ``--privileged`` option to docker run\n  This parameter is not supported for Windows containers or tasks run on FARGATElong."},"pseudoTerminal":{"type":"boolean","description":"When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in the docker container create command and the ``--tty`` option to docker run."},"readonlyRootFilesystem":{"type":"boolean","description":"When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the docker container create command and the ``--read-only`` option to docker run.\n  This parameter is not supported for Windows containers."},"repositoryCredentials":{"$ref":"#/types/aws-native:ecs:TaskDefinitionRepositoryCredentials","description":"The private repository authentication credentials to use."},"resourceRequirements":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionResourceRequirement"},"description":"The type and amount of a resource to assign to a container. The only supported resource is a GPU."},"restartPolicy":{"$ref":"#/types/aws-native:ecs:TaskDefinitionRestartPolicy","description":"The restart policy for a container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task. For more information, see [Restart individual containers in Amazon ECS tasks with container restart policies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-restart-policy.html) in the *Amazon Elastic Container Service Developer Guide*."},"secrets":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionSecret"},"description":"The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*."},"startTimeout":{"type":"integer","description":"Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state.\n  When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value.\n  For tasks using the Fargate launch type, the task or service requires the following platforms:\n  +  Linux platform version ``1.3.0`` or later.\n  +  Windows platform version ``1.0.0`` or later.\n  \n For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version ``1.26.0-1`` of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n The valid values for Fargate are 2-120 seconds."},"stopTimeout":{"type":"integer","description":"Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.\n For tasks using the Fargate launch type, the task or service requires the following platforms:\n  +  Linux platform version ``1.3.0`` or later.\n  +  Windows platform version ``1.0.0`` or later.\n  \n For tasks that use the Fargate launch type, the max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.\n For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n The valid values for Fargate are 2-120 seconds."},"systemControls":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionSystemControl"},"description":"A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the docker container create command and the ``--sysctl`` option to docker run. For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections."},"ulimits":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionUlimit"},"description":"A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--ulimit`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``\n  This parameter is not supported for Windows containers."},"user":{"type":"string","description":"The user to use inside the container. This parameter maps to ``User`` in the docker container create command and the ``--user`` option to docker run.\n  When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.\n  You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer.\n  +   ``user`` \n  +   ``user:group`` \n  +   ``uid`` \n  +   ``uid:gid`` \n  +   ``user:gid`` \n  +   ``uid:group`` \n  \n  This parameter is not supported for Windows containers."},"versionConsistency":{"$ref":"#/types/aws-native:ecs:TaskDefinitionContainerDefinitionVersionConsistency","description":"Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*."},"volumesFrom":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionVolumeFrom"},"description":"Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the docker container create command and the ``--volumes-from`` option to docker run."},"workingDirectory":{"type":"string","description":"The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the docker container create command and the ``--workdir`` option to docker run."}},"type":"object","required":["image","name"]},"aws-native:ecs:TaskDefinitionContainerDefinitionVersionConsistency":{"description":"Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest. By default, the value is ``enabled``. If you set the value for a container as ``disabled``, Amazon ECS will not resolve the provided container image tag to a digest and will use the original image URI specified in the container definition for deployment. For more information about container image resolution, see [Container image resolution](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html#deployment-container-image-stability) in the *Amazon ECS Developer Guide*.","type":"string","enum":[{"name":"Enabled","value":"enabled"},{"name":"Disabled","value":"disabled"}]},"aws-native:ecs:TaskDefinitionContainerDependency":{"description":"The ``ContainerDependency`` property specifies the dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.\n Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*.\n  For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.","properties":{"condition":{"type":"string","description":"The dependency condition of the container. The following are the available conditions and their behavior:\n  +  ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.\n  +  ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.\n  +  ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container.\n  +  ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup."},"containerName":{"type":"string","description":"The name of a container."}},"type":"object"},"aws-native:ecs:TaskDefinitionDevice":{"description":"The ``Device`` property specifies an object representing a container instance host device.","properties":{"containerPath":{"type":"string","description":"The path inside the container at which to expose the host device."},"hostPath":{"type":"string","description":"The path for the device on the host container instance."},"permissions":{"type":"array","items":{"type":"string"},"description":"The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device."}},"type":"object"},"aws-native:ecs:TaskDefinitionDockerVolumeConfiguration":{"description":"The ``DockerVolumeConfiguration`` property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify a ``host`` instead.","properties":{"autoprovision":{"type":"boolean","description":"If this value is ``true``, the Docker volume is created if it doesn't already exist.\n  This field is only used if the ``scope`` is ``shared``."},"driver":{"type":"string","description":"The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. This parameter maps to ``Driver`` in the docker container create command and the ``xxdriver`` option to docker volume create."},"driverOpts":{"type":"object","additionalProperties":{"type":"string"},"description":"A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the docker create-volume command and the ``xxopt`` option to docker volume create."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the docker container create command and the ``xxlabel`` option to docker volume create."},"scope":{"type":"string","description":"The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a ``task`` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as ``shared`` persist after the task stops."}},"type":"object"},"aws-native:ecs:TaskDefinitionEfsVolumeConfiguration":{"description":"This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see [Amazon EFS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"authorizationConfig":{"$ref":"#/types/aws-native:ecs:TaskDefinitionAuthorizationConfig","description":"The authorization configuration details for the Amazon EFS file system."},"filesystemId":{"type":"string","description":"The Amazon EFS file system ID to use."},"rootDirectory":{"type":"string","description":"The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter.\n  If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point."},"transitEncryption":{"$ref":"#/types/aws-native:ecs:TaskDefinitionEfsVolumeConfigurationTransitEncryption","description":"Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*."},"transitEncryptionPort":{"type":"integer","description":"The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*."}},"type":"object","required":["filesystemId"]},"aws-native:ecs:TaskDefinitionEfsVolumeConfigurationTransitEncryption":{"description":"Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:ecs:TaskDefinitionEnvironmentFile":{"description":"A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file should contain an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored.\n If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Use a file to pass environment variables to a container](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/use-environment-file.html) in the *Amazon Elastic Container Service Developer Guide*.\n Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply. \n You must use the following platforms for the Fargate launch type:\n  +  Linux platform version ``1.4.0`` or later.\n  +  Windows platform version ``1.0.0`` or later.\n  \n Consider the following when using the Fargate launch type:\n  +  The file is handled like a native Docker env-file.\n  +  There is no support for shell escape handling.\n  +  The container entry point interperts the ``VARIABLE`` values.","properties":{"type":{"type":"string","description":"The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``."},"value":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file."}},"type":"object"},"aws-native:ecs:TaskDefinitionEphemeralStorage":{"description":"The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon ECS Developer Guide;*.\n  For tasks using the Fargate launch type, the task requires the following platforms:\n  +  Linux platform version ``1.4.0`` or later.\n  +  Windows platform version ``1.0.0`` or later.","properties":{"sizeInGiB":{"type":"integer","description":"The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``21`` GiB and the maximum supported value is ``200`` GiB."}},"type":"object"},"aws-native:ecs:TaskDefinitionFSxAuthorizationConfig":{"description":"The authorization configuration details for Amazon FSx for Windows File Server file system. See [FSxWindowsFileServerVolumeConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html) in the *Amazon ECS API Reference*.\n For more information and the input format, see [Amazon FSx for Windows File Server Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"credentialsParameter":{"type":"string","description":"The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an ASMlong secret or SSM Parameter Store parameter. The ARN refers to the stored credentials."},"domain":{"type":"string","description":"A fully qualified domain name hosted by an [](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2."}},"type":"object","required":["credentialsParameter","domain"]},"aws-native:ecs:TaskDefinitionFSxWindowsFileServerVolumeConfiguration":{"description":"This parameter is specified when you're using [Amazon FSx for Windows File Server](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system for task storage.\n For more information and the input format, see [Amazon FSx for Windows File Server volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"authorizationConfig":{"$ref":"#/types/aws-native:ecs:TaskDefinitionFSxAuthorizationConfig","description":"The authorization configuration details for the Amazon FSx for Windows File Server file system."},"fileSystemId":{"type":"string","description":"The Amazon FSx for Windows File Server file system ID to use."},"rootDirectory":{"type":"string","description":"The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host."}},"type":"object","required":["fileSystemId","rootDirectory"]},"aws-native:ecs:TaskDefinitionFirelensConfiguration":{"description":"The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"options":{"type":"object","additionalProperties":{"type":"string"},"description":"The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event.\n  If specified, valid option keys are:\n  +  ``enable-ecs-log-metadata``, which can be ``true`` or ``false``\n  +  ``config-file-type``, which can be ``s3`` or ``file``\n  +  ``config-file-value``, which is either an S3 ARN or a file path"},"type":{"type":"string","description":"The log router to use. The valid values are ``fluentd`` or ``fluentbit``."}},"type":"object"},"aws-native:ecs:TaskDefinitionHealthCheck":{"description":"The ``HealthCheck`` property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the ``HEALTHCHECK`` parameter of docker run.\n  The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.\n  If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.\n The following are notes about container health check support:\n  +  Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html).\n  +  Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see [Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).\n  +  Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.","properties":{"command":{"type":"array","items":{"type":"string"},"description":"A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. \n  When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets.\n  ``[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]`` \n You don't include the double quotes and brackets when you use the AWS Management Console.\n  ``CMD-SHELL, curl -f http://localhost/ || exit 1`` \n An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the docker container create command."},"interval":{"type":"integer","description":"The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds. This value applies only when you specify a ``command``."},"retries":{"type":"integer","description":"The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3. This value applies only when you specify a ``command``."},"startPeriod":{"type":"integer","description":"The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off. This value applies only when you specify a ``command``. \n  If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries."},"timeout":{"type":"integer","description":"The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5. This value applies only when you specify a ``command``."}},"type":"object"},"aws-native:ecs:TaskDefinitionHostEntry":{"description":"The ``HostEntry`` property specifies a hostname and an IP address that are added to the ``/etc/hosts`` file of a container through the ``extraHosts`` parameter of its ``ContainerDefinition`` resource.","properties":{"hostname":{"type":"string","description":"The hostname to use in the ``/etc/hosts`` entry."},"ipAddress":{"type":"string","description":"The IP address to use in the ``/etc/hosts`` entry."}},"type":"object"},"aws-native:ecs:TaskDefinitionHostVolumeProperties":{"description":"The ``HostVolumeProperties`` property specifies details on a container instance bind mount host volume.","properties":{"sourcePath":{"type":"string","description":"When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.\n If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported."}},"type":"object"},"aws-native:ecs:TaskDefinitionInferenceAccelerator":{"properties":{"deviceName":{"type":"string"},"deviceType":{"type":"string"}},"type":"object"},"aws-native:ecs:TaskDefinitionKernelCapabilities":{"description":"The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more detailed information about these Linux capabilities, see the [capabilities(7)](https://docs.aws.amazon.com/http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page.\n The following describes how Docker processes the Linux capabilities specified in the ``add`` and ``drop`` request parameters. For information about the latest behavior, see [Docker Compose: order of cap_drop and cap_add](https://docs.aws.amazon.com/https://forums.docker.com/t/docker-compose-order-of-cap-drop-and-cap-add/97136/1) in the Docker Community Forum.\n  +  When the container is a privleged container, the container capabilities are all of the default Docker capabilities. The capabilities specified in the ``add`` request parameter, and the ``drop`` request parameter are ignored.\n  +  When the ``add`` request parameter is set to ALL, the container capabilities are all of the default Docker capabilities, excluding those specified in the ``drop`` request parameter.\n  +  When the ``drop`` request parameter is set to ALL, the container capabilities are the capabilities specified in the ``add`` request parameter.\n  +  When the ``add`` request parameter and the ``drop`` request parameter are both empty, the capabilities the container capabilities are all of the default Docker capabilities.\n  +  The default is to first drop the capabilities specified in the ``drop`` request parameter, and then add the capabilities specified in the ``add`` request parameter.","properties":{"add":{"type":"array","items":{"type":"string"},"description":"The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the docker container create command and the ``--cap-add`` option to docker run.\n  Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability.\n  Valid values: ``\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"``"},"drop":{"type":"array","items":{"type":"string"},"description":"The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the docker container create command and the ``--cap-drop`` option to docker run.\n Valid values: ``\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"``"}},"type":"object"},"aws-native:ecs:TaskDefinitionKeyValuePair":{"description":"A key-value pair object.","properties":{"name":{"type":"string","description":"The name of the key-value pair. For environment variables, this is the name of the environment variable."},"value":{"type":"string","description":"The value of the key-value pair. For environment variables, this is the value of the environment variable."}},"type":"object"},"aws-native:ecs:TaskDefinitionLinuxParameters":{"description":"The Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).","properties":{"capabilities":{"$ref":"#/types/aws-native:ecs:TaskDefinitionKernelCapabilities","description":"The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.\n  For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later."},"devices":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionDevice"},"description":"Any host devices to expose to the container. This parameter maps to ``Devices`` in the docker container create command and the ``--device`` option to docker run.\n  If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported."},"initProcessEnabled":{"type":"boolean","description":"Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``"},"maxSwap":{"type":"integer","description":"The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to docker run where the value would be the sum of the container memory plus the ``maxSwap`` value.\n If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used.\n  If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported.\n If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported."},"sharedMemorySize":{"type":"integer","description":"The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to docker run.\n  If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported."},"swappiness":{"type":"integer","description":"This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps to the ``--memory-swappiness`` option to docker run.\n  If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported.\n If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported."},"tmpfs":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionTmpfs"},"description":"The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to docker run.\n  If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported."}},"type":"object"},"aws-native:ecs:TaskDefinitionLogConfiguration":{"description":"The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container.","properties":{"logDriver":{"type":"string","description":"The log driver to use for the container.\n For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``.\n For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``syslog``, ``splunk``, and ``awsfirelens``.\n For more information about using the ``awslogs`` log driver, see [Send Amazon ECS logs to CloudWatch](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*.\n For more information about using the ``awsfirelens`` log driver, see [Send Amazon ECS logs to an service or Partner](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html).\n  If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software."},"options":{"type":"object","additionalProperties":{"type":"string"},"description":"The configuration options to send to the log driver.\n The options you can specify depend on the log driver. Some of the options you can specify when you use the ``awslogs`` log driver to route logs to Amazon CloudWatch include the following:\n  + awslogs-create-group Required: No Specify whether you want the log group to be created automatically. If this option isn't specified, it defaults to false. Your IAM policy must include the logs:CreateLogGroup permission before you attempt to use awslogs-create-group. + awslogs-region Required: Yes Specify the Region that the awslogs log driver is to send your Docker logs to. You can choose to send all of your logs from clusters in different Regions to a single region in CloudWatch Logs. This is so that they're all visible in one location. Otherwise, you can separate them by Region for more granularity. Make sure that the specified log group exists in the Region that you specify with this option. + awslogs-group Required: Yes Make sure to specify a log group that the awslogs log driver sends its log streams to. + awslogs-stream-prefix Required: Yes, when using Fargate.Optional when using EC2. Use the awslogs-stream-prefix option to associate a log stream with the specified prefix, the container name, and the ID of the Amazon ECS task that the container belongs to. If you specify a prefix with this option, then the log stream takes the format prefix-name/container-name/ecs-task-id. If you don't specify a prefix with this option, then the log stream is named after the container ID that's assigned by the Docker daemon on the container instance. Because it's difficult to trace logs back to the container that sent them with just the Docker container ID (which is only available on the container instance), we recommend that you specify a prefix with this option. For Amazon ECS services, you can use the service name as the prefix. Doing so, you can trace log streams to the service that the container belongs to, the name of the container that sent them, and the ID of the task that the container belongs to. You must specify a stream-prefix for your logs to have your logs appear in the Log pane when using the Amazon ECS console. + awslogs-datetime-format Required: No This option defines a multiline start pattern in Python strftime format. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages. One example of a use case for using this format is for parsing output such as a stack dump, which might otherwise be logged in multiple entries. The correct pattern allows it to be captured in a single entry. For more information, see awslogs-datetime-format. You cannot configure both the awslogs-datetime-format and awslogs-multiline-pattern options. Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance. + awslogs-multiline-pattern Required: No This option defines a multiline start pattern that uses a regular expression. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages. For more information, see awslogs-multiline-pattern. This option is ignored if awslogs-datetime-format is also configured. You cannot configure both the awslogs-datetime-format and awslogs-multiline-pattern options. Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance. \n The following options apply to all supported log drivers.\n  + mode Required: No Valid values: non-blocking | blocking This option defines the delivery mode of log messages from the container to the log driver specified using logDriver. The delivery mode you choose affects application availability when the flow of logs from container is interrupted. If you use the blocking mode and the flow of logs is interrupted, calls from container code to write to the stdout and stderr streams will block. The logging thread of the application will block as a result. This may cause the application to become unresponsive and lead to container healthcheck failure. If you use the non-blocking mode, the container's logs are instead stored in an in-memory intermediate buffer configured with the max-buffer-size option. This prevents the application from becoming unresponsive when logs cannot be sent. We recommend using this mode if you want to ensure service availability and are okay with some log loss. For more information, see Preventing log loss with non-blocking mode in the awslogs container log driver. You can set a default mode for all containers in a specific Region by using the defaultLogDriverMode account setting. If you don't specify the mode option or configure the account setting, Amazon ECS will default to the non-blocking mode. For more information about the account setting, see Default log driver mode in the Amazon Elastic Container Service Developer Guide. On June 25, 2025, Amazon ECS changed the default log driver mode from blocking to non-blocking to prioritize task availability over logging. To continue using the blocking mode after this change, do one of the following: Set the mode option in your container definition's logConfiguration as blocking. Set the defaultLogDriverMode account setting to blocking. + max-buffer-size Required: No Default value: 10m When non-blocking mode is used, the max-buffer-size log option controls the size of the buffer that's used for intermediate message storage. Make sure to specify an adequate buffer size based on your application. When the buffer fills up, further logs cannot be stored. Logs that cannot be stored are lost. \n To route logs using the ``splunk`` log router, you need to specify a ``splunk-token`` and a ``splunk-url``.\n When you use the ``awsfirelens`` log router to route logs to an AWS Service or AWS Partner Network destination for log storage and analytics, you can set the ``log-driver-buffer-limit`` option to limit the number of events that are buffered in memory, before being sent to the log router container. It can help to resolve potential log loss issue because high throughput might result in memory running out for the buffer inside of Docker.\n Other options you can specify when using ``awsfirelens`` to route logs depend on the destination. When you export logs to Amazon Data Firehose, you can specify the AWS Region with ``region`` and a name for the log stream with ``delivery_stream``.\n When you export logs to Amazon Kinesis Data Streams, you can specify an AWS Region with ``region`` and a data stream name with ``stream``.\n  When you export logs to Amazon OpenSearch Service, you can specify options like ``Name``, ``Host`` (OpenSearch Service endpoint without protocol), ``Port``, ``Index``, ``Type``, ``Aws_auth``, ``Aws_region``, ``Suppress_Type_Name``, and ``tls``. For more information, see [Under the hood: FireLens for Amazon ECS Tasks](https://docs.aws.amazon.com/containers/under-the-hood-firelens-for-amazon-ecs-tasks/).\n When you export logs to Amazon S3, you can specify the bucket using the ``bucket`` option. You can also specify ``region``, ``total_file_size``, ``upload_timeout``, and ``use_put_object`` as options.\n This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``"},"secretOptions":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionSecret"},"description":"The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*."}},"type":"object","required":["logDriver"]},"aws-native:ecs:TaskDefinitionMountPoint":{"description":"The details for a volume mount point that's used in a container definition.","properties":{"containerPath":{"type":"string","description":"The path on the container to mount the host volume at."},"readOnly":{"type":"boolean","description":"If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``."},"sourceVolume":{"type":"string","description":"The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``."}},"type":"object"},"aws-native:ecs:TaskDefinitionPlacementConstraint":{"description":"The constraint on task placement in the task definition. For more information, see [Task placement constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the *Amazon Elastic Container Service Developer Guide*.\n  Task placement constraints aren't supported for tasks run on FARGATElong.","properties":{"expression":{"type":"string","description":"A cluster query language expression to apply to the constraint. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*."},"type":{"type":"string","description":"The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates."}},"type":"object","required":["type"]},"aws-native:ecs:TaskDefinitionPortMapping":{"description":"The ``PortMapping`` property specifies a port mapping. Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.\n If you are using containers in a task with the ``awsvpc`` or ``host`` network mode, exposed ports should be specified using ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``.\n After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the ``networkBindings`` section of [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) API responses.","properties":{"appProtocol":{"$ref":"#/types/aws-native:ecs:TaskDefinitionPortMappingAppProtocol","description":"The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.\n If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.\n ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*."},"containerPort":{"type":"integer","description":"The port number on the container that's bound to the user-specified or automatically assigned host port.\n If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``.\n If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance."},"containerPortRange":{"type":"string","description":"The port number range on the container that's bound to the dynamically mapped host port range. \n The following rules apply when you specify a ``containerPortRange``:\n  +  You must use either the ``bridge`` network mode or the ``awsvpc`` network mode.\n  +  This parameter is available for both the EC2 and FARGATElong launch types.\n  +  This parameter is available for both the Linux and Windows operating systems.\n  +  The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ``ecs-init`` package \n  +  You can specify a maximum of 100 port ranges per container.\n  +  You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows:\n  +  For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy.\n  +  For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports.\n  \n  +  The ``containerPortRange`` valid values are between 1 and 65535.\n  +  A port can only be included in one port mapping per container.\n  +  You cannot specify overlapping port ranges.\n  +  The first port in the range must be less than last port in the range.\n  +  Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports.\n For more information, see [Issue #11185](https://docs.aws.amazon.com/https://github.com/moby/moby/issues/11185) on the Github website.\n For information about how to turn off the docker-proxy in the Docker daemon config file, see [Docker daemon](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) in the *Amazon ECS Developer Guide*.\n  \n You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports."},"hostPort":{"type":"integer","description":"The port number on the container instance to reserve for your container.\n If you specify a ``containerPortRange``, leave this field empty and the value of the ``hostPort`` is set as follows:\n  +  For containers in a task with the ``awsvpc`` network mode, the ``hostPort`` is set to the same value as the ``containerPort``. This is a static mapping strategy.\n  +  For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy.\n  \n If you use containers in a task with the ``awsvpc`` or ``host`` network mode, the ``hostPort`` can either be left blank or set to the same value as the ``containerPort``.\n If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.\n The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under ``/proc/sys/net/ipv4/ip_local_port_range``. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.\n The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the ``remainingResources`` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota."},"name":{"type":"string","description":"The name that's used for the port mapping. This parameter is the name that you use in the ``serviceConnectConfiguration`` and the ``vpcLatticeConfigurations`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen."},"protocol":{"type":"string","description":"The protocol used for the port mapping. Valid values are ``tcp`` and ``udp``. The default is ``tcp``. ``protocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment."}},"type":"object"},"aws-native:ecs:TaskDefinitionPortMappingAppProtocol":{"description":"The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch.\n If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP.\n ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.\n Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.","type":"string","enum":[{"name":"Http","value":"http"},{"name":"Http2","value":"http2"},{"name":"Grpc","value":"grpc"}]},"aws-native:ecs:TaskDefinitionProxyConfiguration":{"description":"The configuration details for the App Mesh proxy.\n For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)","properties":{"containerName":{"type":"string","description":"The name of the container that will serve as the App Mesh proxy."},"proxyConfigurationProperties":{"type":"array","items":{"$ref":"#/types/aws-native:ecs:TaskDefinitionKeyValuePair"},"description":"The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.\n  +  ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty.\n  +  ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty.\n  +  ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``.\n  +  ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to.\n  +  ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to.\n  +  ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list.\n  +  ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list."},"type":{"type":"string","description":"The proxy type. The only supported value is ``APPMESH``."}},"type":"object","required":["containerName"]},"aws-native:ecs:TaskDefinitionRepositoryCredentials":{"description":"The repository credentials for private registry authentication.","properties":{"credentialsParameter":{"type":"string","description":"The Amazon Resource Name (ARN) of the secret containing the private repository credentials.\n  When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret."}},"type":"object"},"aws-native:ecs:TaskDefinitionResourceRequirement":{"description":"The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see [Working with GPUs on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide*","properties":{"type":{"type":"string","description":"The type of resource to assign to a container."},"value":{"type":"string","description":"The value for the specified resource type.\n When the type is ``GPU``, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.\n When the type is ``InferenceAccelerator``, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition."}},"type":"object","required":["type","value"]},"aws-native:ecs:TaskDefinitionRestartPolicy":{"description":"You can enable a restart policy for each container defined in your task definition, to overcome transient failures faster and maintain task availability. When you enable a restart policy for a container, Amazon ECS can restart the container if it exits, without needing to replace the task. For more information, see [Restart individual containers in Amazon ECS tasks with container restart policies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-restart-policy.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"enabled":{"type":"boolean","description":"Specifies whether a restart policy is enabled for the container."},"ignoredExitCodes":{"type":"array","items":{"type":"integer"},"description":"A list of exit codes that Amazon ECS will ignore and not attempt a restart on. You can specify a maximum of 50 container exit codes. By default, Amazon ECS does not ignore any exit codes."},"restartAttemptPeriod":{"type":"integer","description":"A period of time (in seconds) that the container must run for before a restart can be attempted. A container can be restarted only once every ``restartAttemptPeriod`` seconds. If a container isn't able to run for this time period and exits early, it will not be restarted. You can set a minimum ``restartAttemptPeriod`` of 60 seconds and a maximum ``restartAttemptPeriod`` of 1800 seconds. By default, a container must run for 300 seconds before it can be restarted."}},"type":"object"},"aws-native:ecs:TaskDefinitionRuntimePlatform":{"description":"Information about the platform for the Amazon ECS service or task.\n For more information about ``RuntimePlatform``, see [RuntimePlatform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"cpuArchitecture":{"type":"string","description":"The CPU architecture.\n You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance, Amazon ECS Managed Instances, or Linux containers on Fargate."},"operatingSystemFamily":{"type":"string","description":"The operating system."}},"type":"object"},"aws-native:ecs:TaskDefinitionSecret":{"description":"An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:\n  +  To inject sensitive data into your containers as environment variables, use the ``secrets`` container definition parameter.\n  +  To reference sensitive information in the log configuration of a container, use the ``secretOptions`` container definition parameter.\n  \n For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.","properties":{"name":{"type":"string","description":"The name of the secret."},"valueFrom":{"type":"string","description":"The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store.\n For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*.\n  If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified."}},"type":"object","required":["name","valueFrom"]},"aws-native:ecs:TaskDefinitionSystemControl":{"description":"A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the docker container create command and the ``--sysctl`` option to docker run. For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections.\n We don't recommend that you specify network-related ``systemControls`` parameters for multiple containers in a single task that also uses either the ``awsvpc`` or ``host`` network mode. Doing this has the following disadvantages:\n  +  For tasks that use the ``awsvpc`` network mode including Fargate, if you set ``systemControls`` for any container, it applies to all containers in the task. If you set different ``systemControls`` for multiple containers in a single task, the container that's started last determines which ``systemControls`` take effect.\n  +  For tasks that use the ``host`` network mode, the network namespace ``systemControls`` aren't supported.\n  \n If you're setting an IPC resource namespace to use for the containers in the task, the following conditions apply to your system controls. For more information, see [IPC mode](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode).\n  +  For tasks that use the ``host`` IPC mode, IPC namespace ``systemControls`` aren't supported.\n  +  For tasks that use the ``task`` IPC mode, IPC namespace ``systemControls`` values apply to all containers within a task.\n  \n  This parameter is not supported for Windows containers.\n   This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.","properties":{"namespace":{"type":"string","description":"The namespaced kernel parameter to set a ``value`` for."},"value":{"type":"string","description":"The namespaced kernel parameter to set a ``value`` for.\n Valid IPC namespace values: ``\"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\" | \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" | \"kernel.shm_rmid_forced\"``, and ``Sysctls`` that start with ``\"fs.mqueue.*\"``\n Valid network namespace values: ``Sysctls`` that start with ``\"net.*\"``. Only namespaced ``Sysctls`` that exist within the container starting with \"net.* are accepted.\n All of these values are supported by Fargate."}},"type":"object"},"aws-native:ecs:TaskDefinitionTag":{"description":"The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.\n The following basic restrictions apply to tags:\n  +  Maximum number of tags per resource - 50\n  +  For each resource, each tag key must be unique, and each tag key can have only one value.\n  +  Maximum key length - 128 Unicode characters in UTF-8\n  +  Maximum value length - 256 Unicode characters in UTF-8\n  +  If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.\n  +  Tag keys and values are case-sensitive.\n  +  Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.","properties":{"key":{"type":"string","description":"One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key)."}},"type":"object"},"aws-native:ecs:TaskDefinitionTmpfs":{"description":"The container path, mount options, and size of the tmpfs mount.","properties":{"containerPath":{"type":"string","description":"The absolute file path where the tmpfs volume is to be mounted."},"mountOptions":{"type":"array","items":{"type":"string"},"description":"The list of tmpfs volume mount options.\n Valid values: ``\"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"``"},"size":{"type":"integer","description":"The maximum size (in MiB) of the tmpfs volume."}},"type":"object","required":["size"]},"aws-native:ecs:TaskDefinitionUlimit":{"description":"The ``ulimit`` settings to pass to the container.\n Amazon ECS tasks hosted on FARGATElong use the default resource limit values set by the operating system with the exception of the ``nofile`` resource limit parameter which FARGATElong overrides. The ``nofile`` resource limit sets a restriction on the number of open files that a container can use. The default ``nofile`` soft limit is ``65535`` and the default hard limit is ``65535``.\n You can specify the ``ulimit`` settings for a container in a task definition.","properties":{"hardLimit":{"type":"integer","description":"The hard limit for the ``ulimit`` type. The value can be specified in bytes, seconds, or as a count, depending on the ``type`` of the ``ulimit``."},"name":{"type":"string","description":"The ``type`` of the ``ulimit``."},"softLimit":{"type":"integer","description":"The soft limit for the ``ulimit`` type. The value can be specified in bytes, seconds, or as a count, depending on the ``type`` of the ``ulimit``."}},"type":"object","required":["hardLimit","name","softLimit"]},"aws-native:ecs:TaskDefinitionVolume":{"description":"The data volume configuration for tasks launched using this task definition. Specifying a volume configuration in a task definition is optional. The volume configuration may contain multiple volumes but only one volume configured at launch is supported. Each volume defined in the volume configuration may only specify a ``name`` and one of either ``configuredAtLaunch``, ``dockerVolumeConfiguration``, ``efsVolumeConfiguration``, ``fsxWindowsFileServerVolumeConfiguration``, or ``host``. If an empty volume configuration is specified, by default Amazon ECS uses a host volume. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html).","properties":{"configuredAtLaunch":{"type":"boolean","description":"Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.\n To configure a volume at launch time, use this task definition revision and specify a ``volumeConfigurations`` object when calling the ``CreateService``, ``UpdateService``, ``RunTask`` or ``StartTask`` APIs."},"dockerVolumeConfiguration":{"$ref":"#/types/aws-native:ecs:TaskDefinitionDockerVolumeConfiguration","description":"This parameter is specified when you use Docker volumes.\n Windows containers only support the use of the ``local`` driver. To use bind mounts, specify the ``host`` parameter instead.\n  Docker volumes aren't supported by tasks run on FARGATElong."},"efsVolumeConfiguration":{"$ref":"#/types/aws-native:ecs:TaskDefinitionEfsVolumeConfiguration","description":"This parameter is specified when you use an Amazon Elastic File System file system for task storage."},"fSxWindowsFileServerVolumeConfiguration":{"$ref":"#/types/aws-native:ecs:TaskDefinitionFSxWindowsFileServerVolumeConfiguration","description":"This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage."},"host":{"$ref":"#/types/aws-native:ecs:TaskDefinitionHostVolumeProperties","description":"This parameter is specified when you use bind mount host volumes. The contents of the ``host`` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the ``host`` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.\n Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount ``C:\\my\\path:C:\\my\\path`` and ``D:\\:D:\\``, but not ``D:\\my\\path:C:\\my\\path`` or ``D:\\:C:\\my\\path``."},"name":{"type":"string","description":"The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.\n When using a volume configured at launch, the ``name`` is required and must also be specified as the volume name in the ``ServiceVolumeConfiguration`` or ``TaskVolumeConfiguration`` parameter when creating your service or standalone task.\n For all other types of volumes, this name is referenced in the ``sourceVolume`` parameter of the ``mountPoints`` object in the container definition.\n When a volume is using the ``efsVolumeConfiguration``, the name is required."}},"type":"object"},"aws-native:ecs:TaskDefinitionVolumeFrom":{"description":"Details on a data volume from another container in the same task definition.","properties":{"readOnly":{"type":"boolean","description":"If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``."},"sourceContainer":{"type":"string","description":"The name of another container within the same task definition to mount volumes from."}},"type":"object"},"aws-native:ecs:TaskSetAwsVpcConfiguration":{"description":"The VPC subnets and security groups associated with a task. All specified subnets and security groups must be from the same VPC.","properties":{"assignPublicIp":{"$ref":"#/types/aws-native:ecs:TaskSetAwsVpcConfigurationAssignPublicIp","description":"Whether the task's elastic network interface receives a public IP address. The default value is DISABLED."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration."},"subnets":{"type":"array","items":{"type":"string"},"description":"The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration."}},"type":"object","required":["subnets"]},"aws-native:ecs:TaskSetAwsVpcConfigurationAssignPublicIp":{"description":"Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:ecs:TaskSetCapacityProviderStrategyItem":{"properties":{"base":{"type":"integer","description":"The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider for each service. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of `0` is used.\n\nBase value characteristics:\n\n- Only one capacity provider in a strategy can have a base defined\n- The default value is `0` if not specified\n- The valid range is 0 to 100,000\n- Base requirements are satisfied first before weight distribution"},"capacityProvider":{"type":"string","description":"The short name of the capacity provider. This can be either an AWS managed capacity provider ( `FARGATE` or `FARGATE_SPOT` ) or the name of a custom capacity provider that you created."},"weight":{"type":"integer","description":"The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The `weight` value is taken into consideration after the `base` value, if defined, is satisfied.\n\nIf no `weight` value is specified, the default value of `0` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of `0` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of `0` , any `RunTask` or `CreateService` actions using the capacity provider strategy will fail.\n\nWeight value characteristics:\n\n- Weight is considered after the base value is satisfied\n- The default value is `0` if not specified\n- The valid range is 0 to 1,000\n- At least one capacity provider must have a weight greater than zero\n- Capacity providers with weight of `0` cannot place tasks\n\nTask distribution logic:\n\n- Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider\n- Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios\n\nExamples:\n\nEqual Distribution: Two capacity providers both with weight `1` will split tasks evenly after base requirements are met.\n\nWeighted Distribution: If capacityProviderA has weight `1` and capacityProviderB has weight `4` , then for every 1 task on A, 4 tasks will run on B."}},"type":"object"},"aws-native:ecs:TaskSetLaunchType":{"description":"The launch type that new tasks in the task set will use. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html in the Amazon Elastic Container Service Developer Guide. ","type":"string","enum":[{"name":"Ec2","value":"EC2"},{"name":"Fargate","value":"FARGATE"}]},"aws-native:ecs:TaskSetLoadBalancer":{"description":"A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer. ","properties":{"containerName":{"type":"string","description":"The name of the container (as it appears in a container definition) to associate with the load balancer."},"containerPort":{"type":"integer","description":"The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping."},"targetGroupArn":{"type":"string","description":"The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted. For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html in the Amazon Elastic Container Service Developer Guide. For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html in the Amazon Elastic Container Service Developer Guide. If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance."}},"type":"object"},"aws-native:ecs:TaskSetNetworkConfiguration":{"description":"An object representing the network configuration for a task or service.","properties":{"awsVpcConfiguration":{"$ref":"#/types/aws-native:ecs:TaskSetAwsVpcConfiguration","description":"The VPC subnets and security groups that are associated with a task.\n\n\u003e All specified subnets and security groups must be from the same VPC."}},"type":"object"},"aws-native:ecs:TaskSetScale":{"properties":{"unit":{"$ref":"#/types/aws-native:ecs:TaskSetScaleUnit","description":"The unit of measure for the scale value."},"value":{"type":"number","description":"The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100."}},"type":"object"},"aws-native:ecs:TaskSetScaleUnit":{"description":"The unit of measure for the scale value.","type":"string","enum":[{"name":"Percent","value":"PERCENT"}]},"aws-native:ecs:TaskSetServiceRegistry":{"properties":{"containerName":{"type":"string","description":"The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both."},"containerPort":{"type":"integer","description":"The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both."},"port":{"type":"integer","description":"The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used."},"registryArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html"}},"type":"object"},"aws-native:ecs:TaskSetTag":{"properties":{"key":{"type":"string","description":"One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key)."}},"type":"object"},"aws-native:efs:AccessPointCreationInfo":{"description":"Required if the ``RootDirectory`` \u003e ``Path`` specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point's ``RootDirectory`` \u003e ``Path``. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying ``CreationInfo``, you must include values for all properties. \n Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.\n  If you do not provide ``CreationInfo`` and the specified ``RootDirectory`` does not exist, attempts to mount the file system using the access point will fail.","properties":{"ownerGid":{"type":"string","description":"Specifies the POSIX group ID to apply to the ``RootDirectory``. Accepts values from 0 to 2^32 (4294967295)."},"ownerUid":{"type":"string","description":"Specifies the POSIX user ID to apply to the ``RootDirectory``. Accepts values from 0 to 2^32 (4294967295)."},"permissions":{"type":"string","description":"Specifies the POSIX permissions to apply to the ``RootDirectory``, in the format of an octal number representing the file's mode bits."}},"type":"object","required":["ownerGid","ownerUid","permissions"]},"aws-native:efs:AccessPointPosixUser":{"description":"The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.","properties":{"gid":{"type":"string","description":"The POSIX group ID used for all file system operations using this access point.","replaceOnChanges":true},"secondaryGids":{"type":"array","items":{"type":"string"},"description":"Secondary POSIX group IDs used for all file system operations using this access point.","replaceOnChanges":true},"uid":{"type":"string","description":"The POSIX user ID used for all file system operations using this access point.","replaceOnChanges":true}},"type":"object","required":["gid","uid"]},"aws-native:efs:AccessPointRootDirectory":{"description":"Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's ``RootDirectory`` and its subdirectories.","properties":{"creationInfo":{"$ref":"#/types/aws-native:efs:AccessPointCreationInfo","description":"(Optional) Specifies the POSIX IDs and permissions to apply to the access point's ``RootDirectory``. If the ``RootDirectory`` \u003e ``Path`` specified does not exist, EFS creates the root directory using the ``CreationInfo`` settings when a client connects to an access point. When specifying the ``CreationInfo``, you must provide values for all properties. \n  If you do not provide ``CreationInfo`` and the specified ``RootDirectory`` \u003e ``Path`` does not exist, attempts to mount the file system using the access point will fail.","replaceOnChanges":true},"path":{"type":"string","description":"Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the ``CreationInfo``.","replaceOnChanges":true}},"type":"object"},"aws-native:efs:AccessPointTag":{"description":"A tag is a key-value pair attached to a file system. Allowed characters in the ``Key`` and ``Value`` properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters:``+ - = . _ : /``","properties":{"key":{"type":"string","description":"The tag key (String). The key can't start with ``aws:``."},"value":{"type":"string","description":"The value of the tag key."}},"type":"object"},"aws-native:efs:FileSystemBackupPolicy":{"description":"The backup policy turns automatic backups for the file system on or off.","properties":{"status":{"$ref":"#/types/aws-native:efs:FileSystemBackupPolicyStatus","description":"Set the backup policy status for the file system.\n  +  *ENABLED* - Turns automatic backups on for the file system. \n  +  *DISABLED* - Turns automatic backups off for the file system."}},"type":"object","required":["status"]},"aws-native:efs:FileSystemBackupPolicyStatus":{"description":"Set the backup policy status for the file system.\n  +  *ENABLED* - Turns automatic backups on for the file system. \n  +  *DISABLED* - Turns automatic backups off for the file system.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:efs:FileSystemElasticFileSystemTag":{"description":"A tag is a key-value pair attached to a file system. Allowed characters in the ``Key`` and ``Value`` properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters:``+ - = . _ : /``","properties":{"key":{"type":"string","description":"The tag key (String). The key can't start with ``aws:``."},"value":{"type":"string","description":"The value of the tag key."}},"type":"object","required":["key","value"]},"aws-native:efs:FileSystemLifecyclePolicy":{"description":"Describes a policy used by Lifecycle management that specifies when to transition files into and out of the EFS storage classes. For more information, see [Managing file system storage](https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html).\n   +  Each ``LifecyclePolicy`` object can have only a single transition. This means that in a request body, ``LifecyclePolicies`` must be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive``, ``TransitionToPrimaryStorageClass``.\n  +  See the AWS::EFS::FileSystem examples for the correct ``LifecyclePolicy`` structure. Do not use the syntax shown on this page.","properties":{"transitionToArchive":{"type":"string","description":"The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events."},"transitionToIa":{"type":"string","description":"The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events."},"transitionToPrimaryStorageClass":{"type":"string","description":"Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events."}},"type":"object"},"aws-native:efs:FileSystemProtection":{"description":"Describes the protection on the file system.","properties":{"replicationOverwriteProtection":{"$ref":"#/types/aws-native:efs:FileSystemProtectionReplicationOverwriteProtection","description":"The status of the file system's replication overwrite protection.\n  +  ``ENABLED`` – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. \n  +  ``DISABLED`` – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.\n  +  ``REPLICATING`` – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is modified only by EFS replication.\n  \n If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable."}},"type":"object"},"aws-native:efs:FileSystemProtectionReplicationOverwriteProtection":{"description":"The status of the file system's replication overwrite protection.\n  +  ``ENABLED`` – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. \n  +  ``DISABLED`` – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.\n  +  ``REPLICATING`` – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is modified only by EFS replication.\n  \n If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"},{"name":"Replicating","value":"REPLICATING"}]},"aws-native:efs:FileSystemReplicationConfiguration":{"description":"Describes the replication configuration for a specific file system.","properties":{"destinations":{"type":"array","items":{"$ref":"#/types/aws-native:efs:FileSystemReplicationDestination"},"description":"An array of destination objects. Only one destination object is supported."}},"type":"object"},"aws-native:efs:FileSystemReplicationDestination":{"description":"Describes the destination file system in the replication configuration.","properties":{"availabilityZoneName":{"type":"string","description":"For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. \n Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*.\n  One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available."},"fileSystemId":{"type":"string","description":"The ID of the destination Amazon EFS file system."},"kmsKeyId":{"type":"string","description":"The ID of an kms-key-long used to protect the encrypted file system."},"region":{"type":"string","description":"The AWS-Region in which the destination file system is located.\n  For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the current source file system in the replication configuration."},"status":{"type":"string","description":"Describes the status of the replication configuration. For more information about replication status, see [Viewing replication details](https://docs.aws.amazon.com//efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html) in the *Amazon EFS User Guide*."},"statusMessage":{"type":"string","description":"Message that provides details about the ``PAUSED`` or ``ERRROR`` state of the replication destination configuration. For more information about replication status messages, see [Viewing replication details](https://docs.aws.amazon.com//efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html) in the *Amazon EFS User Guide*."}},"type":"object"},"aws-native:efs:MountTargetIpAddressType":{"description":"The IP address type for the mount target. The possible values are ``IPV4_ONLY`` (only IPv4 addresses), ``IPV6_ONLY`` (only IPv6 addresses), and ``DUAL_STACK`` (dual-stack, both IPv4 and IPv6 addresses). If you don’t specify an ``IpAddressType``, then ``IPV4_ONLY`` is used.\n  The ``IPAddressType`` must match the IP type of the subnet. Additionally, the ``IPAddressType`` parameter overrides the value set as the default IP address for the subnet in the VPC. For example, if the ``IPAddressType`` is ``IPV4_ONLY`` and ``AssignIpv6AddressOnCreation`` is ``true``, then IPv4 is used for the mount target. For more information, see [Modify the IP addressing attributes of your subnet](https://docs.aws.amazon.com/vpc/latest/userguide/subnet-public-ip.html).","type":"string","enum":[{"name":"Ipv4Only","value":"IPV4_ONLY"},{"name":"Ipv6Only","value":"IPV6_ONLY"},{"name":"DualStack","value":"DUAL_STACK"}]},"aws-native:eks:AccessEntryAccessPolicy":{"description":"An access policy to associate with the current access entry.","properties":{"accessScope":{"$ref":"#/types/aws-native:eks:AccessEntryAccessScope","description":"The scope of an `AccessPolicy` that's associated to an `AccessEntry` ."},"policyArn":{"type":"string","description":"The ARN of the access policy to add to the access entry."}},"type":"object","required":["accessScope","policyArn"]},"aws-native:eks:AccessEntryAccessScope":{"description":"The access scope of the access policy.","properties":{"namespaces":{"type":"array","items":{"type":"string"},"description":"The namespaces to associate with the access scope. Only specify if Type is set to 'namespace'."},"type":{"$ref":"#/types/aws-native:eks:AccessEntryAccessScopeType","description":"The type of the access scope."}},"type":"object","required":["type"]},"aws-native:eks:AccessEntryAccessScopeType":{"description":"The type of the access scope.","type":"string","enum":[{"name":"Namespace","value":"namespace"},{"name":"Cluster","value":"cluster"}]},"aws-native:eks:AccessEntryTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:eks:AddonPodIdentityAssociation":{"description":"A pod identity to associate with an add-on.","properties":{"roleArn":{"type":"string","description":"The IAM role ARN that the pod identity association is created for."},"serviceAccount":{"type":"string","description":"The Kubernetes service account that the pod identity association is created for."}},"type":"object","required":["roleArn","serviceAccount"]},"aws-native:eks:AddonResolveConflicts":{"description":"Resolve parameter value conflicts","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Overwrite","value":"OVERWRITE"},{"name":"Preserve","value":"PRESERVE"}]},"aws-native:eks:AddonTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:eks:CapabilityArgoCd":{"description":"Configuration settings for an Argo CD capability. This includes the Kubernetes namespace, IAM Identity Center integration, RBAC role mappings, and network access configuration.","properties":{"awsIdc":{"$ref":"#/types/aws-native:eks:CapabilityAwsIdc","replaceOnChanges":true},"namespace":{"type":"string","description":"The Kubernetes namespace where Argo CD resources will be created. If not specified, the default namespace is used.","replaceOnChanges":true},"networkAccess":{"$ref":"#/types/aws-native:eks:CapabilityNetworkAccess"},"rbacRoleMappings":{"type":"array","items":{"$ref":"#/types/aws-native:eks:CapabilityArgoCdRoleMapping"},"description":"A list of role mappings that define which IAM Identity Center users or groups have which Argo CD roles. Each mapping associates an Argo CD role (ADMIN, EDITOR, or VIEWER) with one or more IAM Identity Center identities."},"serverUrl":{"type":"string","description":"The URL of the Argo CD server. Use this URL to access the Argo CD web interface and API."}},"type":"object","required":["awsIdc"]},"aws-native:eks:CapabilityArgoCdRoleMapping":{"description":"A mapping between an Argo CD role and IAM Identity Center identities. This defines which users or groups have specific permissions in Argo CD.","properties":{"identities":{"type":"array","items":{"$ref":"#/types/aws-native:eks:CapabilitySsoIdentity"},"description":"A list of IAM Identity Center identities (users or groups) that should be assigned this Argo CD role."},"role":{"$ref":"#/types/aws-native:eks:CapabilityArgoCdRoleMappingRole","description":"The Argo CD role to assign. Valid values are: ADMIN (full administrative access to Argo CD), EDITOR (edit access to Argo CD resources), or VIEWER (read-only access to Argo CD resources)."}},"type":"object","required":["identities","role"]},"aws-native:eks:CapabilityArgoCdRoleMappingRole":{"description":"The Argo CD role to assign. Valid values are: ADMIN (full administrative access to Argo CD), EDITOR (edit access to Argo CD resources), or VIEWER (read-only access to Argo CD resources).","type":"string","enum":[{"name":"Admin","value":"ADMIN"},{"name":"Editor","value":"EDITOR"},{"name":"Viewer","value":"VIEWER"}]},"aws-native:eks:CapabilityAwsIdc":{"description":"Configuration for integrating Argo CD with IAM Identity Center. This allows you to use your organization's identity provider for authentication to Argo CD.","properties":{"idcInstanceArn":{"type":"string","description":"The ARN of the IAM Identity Center instance to use for authentication."},"idcManagedApplicationArn":{"type":"string","description":"The ARN of the managed application created in IAM Identity Center for this Argo CD capability. This application is automatically created and managed by EKS."},"idcRegion":{"type":"string","description":"The Region where your IAM Identity Center instance is located."}},"type":"object","required":["idcInstanceArn"]},"aws-native:eks:CapabilityConfiguration":{"description":"Configuration settings for a capability. The structure of this object varies depending on the capability type.","properties":{"argoCd":{"$ref":"#/types/aws-native:eks:CapabilityArgoCd"}},"type":"object"},"aws-native:eks:CapabilityDeletePropagationPolicy":{"description":"Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted. Currently, the only supported value is RETAIN which retains all Kubernetes resources managed by the capability when the capability is deleted.","type":"string","enum":[{"name":"Retain","value":"RETAIN"}]},"aws-native:eks:CapabilityNetworkAccess":{"description":"Configuration for network access to the Argo CD capability's managed API server endpoint. By default, the Argo CD server is accessible via a public endpoint. You can optionally specify one or more VPC endpoint IDs to enable private connectivity from your VPCs.","properties":{"vpceIds":{"type":"array","items":{"type":"string"},"description":"A list of VPC endpoint IDs to associate with the managed Argo CD API server endpoint. Each VPC endpoint provides private connectivity from a specific VPC to the Argo CD server. You can specify multiple VPC endpoint IDs to enable access from multiple VPCs."}},"type":"object"},"aws-native:eks:CapabilitySsoIdentity":{"description":"An IAM Identity Center identity (user or group) that can be assigned permissions in a capability.","properties":{"id":{"type":"string","description":"The unique identifier of the IAM Identity Center user or group."},"type":{"$ref":"#/types/aws-native:eks:CapabilitySsoIdentityType","description":"The type of identity. Valid values are SSO_USER or SSO_GROUP."}},"type":"object","required":["id","type"]},"aws-native:eks:CapabilitySsoIdentityType":{"description":"The type of identity. Valid values are SSO_USER or SSO_GROUP.","type":"string","enum":[{"name":"SsoUser","value":"SSO_USER"},{"name":"SsoGroup","value":"SSO_GROUP"}]},"aws-native:eks:CapabilityTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:eks:CapabilityType":{"description":"The type of capability to create. Valid values are: ACK (AWS Controllers for Kubernetes, which lets you manage AWS resources directly from Kubernetes), ARGOCD (Argo CD for GitOps-based continuous delivery), or KRO (Kube Resource Orchestrator for composing and managing custom Kubernetes resources).","type":"string","enum":[{"name":"Argocd","value":"ARGOCD"},{"name":"Ack","value":"ACK"},{"name":"Kro","value":"KRO"}]},"aws-native:eks:ClusterAccessConfig":{"description":"An object representing the Access Config to use for the cluster.","properties":{"authenticationMode":{"$ref":"#/types/aws-native:eks:ClusterAccessConfigAuthenticationMode","description":"Specify the authentication mode that should be used to create your cluster."},"bootstrapClusterCreatorAdminPermissions":{"type":"boolean","description":"Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster.","replaceOnChanges":true}},"type":"object"},"aws-native:eks:ClusterAccessConfigAuthenticationMode":{"description":"Specify the authentication mode that should be used to create your cluster.","type":"string","enum":[{"name":"ConfigMap","value":"CONFIG_MAP"},{"name":"ApiAndConfigMap","value":"API_AND_CONFIG_MAP"},{"name":"Api","value":"API"}]},"aws-native:eks:ClusterBlockStorage":{"description":"Todo: add description","properties":{"enabled":{"type":"boolean","description":"Todo: add description"}},"type":"object"},"aws-native:eks:ClusterComputeConfig":{"description":"Todo: add description","properties":{"enabled":{"type":"boolean","description":"Todo: add description"},"nodePools":{"type":"array","items":{"type":"string"},"description":"Todo: add description"},"nodeRoleArn":{"type":"string","description":"Todo: add description"}},"type":"object"},"aws-native:eks:ClusterControlPlanePlacement":{"description":"Specify the placement group of the control plane machines for your cluster.","properties":{"groupName":{"type":"string","description":"Specify the placement group name of the control place machines for your cluster."}},"type":"object"},"aws-native:eks:ClusterControlPlaneScalingConfig":{"description":"Configuration for provisioned control plane scaling.","properties":{"tier":{"$ref":"#/types/aws-native:eks:ClusterControlPlaneScalingConfigTier","description":"The scaling tier for the provisioned control plane."}},"type":"object"},"aws-native:eks:ClusterControlPlaneScalingConfigTier":{"description":"The scaling tier for the provisioned control plane.","type":"string","enum":[{"name":"Standard","value":"standard"},{"name":"TierXl","value":"tier-xl"},{"name":"Tier2xl","value":"tier-2xl"},{"name":"Tier4xl","value":"tier-4xl"},{"name":"Tier8xl","value":"tier-8xl"},{"name":"TierUltra","value":"tier-ultra"}]},"aws-native:eks:ClusterElasticLoadBalancing":{"description":"Todo: add description","properties":{"enabled":{"type":"boolean","description":"Todo: add description"}},"type":"object"},"aws-native:eks:ClusterEncryptionConfig":{"description":"The encryption configuration for the cluster","properties":{"provider":{"$ref":"#/types/aws-native:eks:ClusterProvider","description":"The encryption provider for the cluster."},"resources":{"type":"array","items":{"type":"string"},"description":"Specifies the resources to be encrypted. The only supported value is \"secrets\"."}},"type":"object"},"aws-native:eks:ClusterKubernetesNetworkConfig":{"description":"The Kubernetes network configuration for the cluster.","properties":{"elasticLoadBalancing":{"$ref":"#/types/aws-native:eks:ClusterElasticLoadBalancing","description":"Todo: add description"},"ipFamily":{"$ref":"#/types/aws-native:eks:ClusterKubernetesNetworkConfigIpFamily","description":"Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on","replaceOnChanges":true},"serviceIpv4Cidr":{"type":"string","description":"The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. ","replaceOnChanges":true},"serviceIpv6Cidr":{"type":"string","description":"The CIDR block to assign Kubernetes service IP addresses from."}},"type":"object"},"aws-native:eks:ClusterKubernetesNetworkConfigIpFamily":{"description":"Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on","type":"string","enum":[{"name":"Ipv4","value":"ipv4"},{"name":"Ipv6","value":"ipv6"}]},"aws-native:eks:ClusterLoggingEnabledTypes":{"description":"The cluster control plane logging configuration for your cluster. ","properties":{"enabledTypes":{"type":"array","items":{"$ref":"#/types/aws-native:eks:ClusterLoggingTypeConfig"},"description":"The enabled control plane logs for your cluster. All log types are disabled if the array is empty.\n\n\u003e When updating a resource, you must include this `EnabledTypes` property if the previous CloudFormation template of the resource had it."}},"type":"object"},"aws-native:eks:ClusterLoggingTypeConfig":{"description":"Enabled Logging Type","properties":{"type":{"$ref":"#/types/aws-native:eks:ClusterLoggingTypeConfigType","description":"name of the log type"}},"type":"object"},"aws-native:eks:ClusterLoggingTypeConfigType":{"description":"name of the log type","type":"string","enum":[{"name":"Api","value":"api"},{"name":"Audit","value":"audit"},{"name":"Authenticator","value":"authenticator"},{"name":"ControllerManager","value":"controllerManager"},{"name":"Scheduler","value":"scheduler"}]},"aws-native:eks:ClusterOutpostConfig":{"description":"An object representing the Outpost configuration to use for AWS EKS outpost cluster.","properties":{"controlPlaneInstanceType":{"type":"string","description":"Specify the Instance type of the machines that should be used to create your cluster."},"controlPlanePlacement":{"$ref":"#/types/aws-native:eks:ClusterControlPlanePlacement","description":"Specify the placement group of the control plane machines for your cluster."},"outpostArns":{"type":"array","items":{"type":"string"},"description":"Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster."}},"type":"object","required":["controlPlaneInstanceType","outpostArns"]},"aws-native:eks:ClusterProvider":{"properties":{"keyArn":{"type":"string","description":"Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key."}},"type":"object"},"aws-native:eks:ClusterRemoteNetworkConfig":{"description":"Configuration fields for specifying on-premises node and pod CIDRs that are external to the VPC passed during cluster creation.","properties":{"remoteNodeNetworks":{"type":"array","items":{"$ref":"#/types/aws-native:eks:ClusterRemoteNodeNetwork"},"description":"Network configuration of nodes run on-premises with EKS Hybrid Nodes."},"remotePodNetworks":{"type":"array","items":{"$ref":"#/types/aws-native:eks:ClusterRemotePodNetwork"},"description":"Network configuration of pods run on-premises with EKS Hybrid Nodes."}},"type":"object"},"aws-native:eks:ClusterRemoteNodeNetwork":{"description":"Network configuration of nodes run on-premises with EKS Hybrid Nodes.","properties":{"cidrs":{"type":"array","items":{"type":"string"},"description":"Specifies the list of remote node CIDRs."}},"type":"object","required":["cidrs"]},"aws-native:eks:ClusterRemotePodNetwork":{"description":"Network configuration of pods run on-premises with EKS Hybrid Nodes.","properties":{"cidrs":{"type":"array","items":{"type":"string"},"description":"Specifies the list of remote pod CIDRs."}},"type":"object","required":["cidrs"]},"aws-native:eks:ClusterResourcesVpcConfig":{"description":"An object representing the VPC configuration to use for an Amazon EKS cluster.","properties":{"endpointPrivateAccess":{"type":"boolean","description":"Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods."},"endpointPublicAccess":{"type":"boolean","description":"Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server."},"publicAccessCidrs":{"type":"array","items":{"type":"string"},"description":"The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks."},"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane."}},"type":"object","required":["subnetIds"]},"aws-native:eks:ClusterStorageConfig":{"description":"Todo: add description","properties":{"blockStorage":{"$ref":"#/types/aws-native:eks:ClusterBlockStorage","description":"Todo: add description"}},"type":"object"},"aws-native:eks:ClusterTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:eks:ClusterUpgradePolicy":{"description":"An object representing the Upgrade Policy to use for the cluster.","properties":{"supportType":{"$ref":"#/types/aws-native:eks:ClusterUpgradePolicySupportType","description":"Specify the support type for your cluster."}},"type":"object"},"aws-native:eks:ClusterUpgradePolicySupportType":{"description":"Specify the support type for your cluster.","type":"string","enum":[{"name":"Standard","value":"STANDARD"},{"name":"Extended","value":"EXTENDED"}]},"aws-native:eks:ClusterZonalShiftConfig":{"description":"The current zonal shift configuration to use for the cluster.","properties":{"enabled":{"type":"boolean","description":"Set this value to true to enable zonal shift for the cluster."}},"type":"object"},"aws-native:eks:FargateProfileLabel":{"description":"A key-value pair to associate with a pod.","properties":{"key":{"type":"string","description":"The key name of the label."},"value":{"type":"string","description":"The value for the label. "}},"type":"object","required":["key","value"]},"aws-native:eks:FargateProfileSelector":{"properties":{"labels":{"type":"array","items":{"$ref":"#/types/aws-native:eks:FargateProfileLabel"},"description":"The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match."},"namespace":{"type":"string","description":"The Kubernetes `namespace` that the selector should match."}},"type":"object","required":["namespace"]},"aws-native:eks:FargateProfileTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:eks:IdentityProviderConfigOidcIdentityProviderConfig":{"description":"An object representing an OpenID Connect (OIDC) configuration.","properties":{"clientId":{"type":"string","description":"This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider."},"groupsClaim":{"type":"string","description":"The JWT claim that the provider uses to return your groups."},"groupsPrefix":{"type":"string","description":"The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups)."},"issuerUrl":{"type":"string","description":"The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens."},"requiredClaims":{"type":"array","items":{"$ref":"#/types/aws-native:eks:IdentityProviderConfigRequiredClaim"},"description":"The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value."},"usernameClaim":{"type":"string","description":"The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins."},"usernamePrefix":{"type":"string","description":"The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing."}},"type":"object","required":["clientId","issuerUrl"]},"aws-native:eks:IdentityProviderConfigRequiredClaim":{"description":"The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.","properties":{"key":{"type":"string","description":"The key of the requiredClaims."},"value":{"type":"string","description":"The value for the requiredClaims."}},"type":"object","required":["key","value"]},"aws-native:eks:IdentityProviderConfigTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:eks:IdentityProviderConfigType":{"description":"The type of the identity provider configuration.","type":"string","enum":[{"name":"Oidc","value":"oidc"}]},"aws-native:eks:Logging":{"description":"Enable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs.","properties":{"clusterLogging":{"$ref":"#/types/aws-native:eks:ClusterLoggingEnabledTypes","description":"The cluster control plane logging configuration for your cluster. ","language":{"csharp":{"name":"ClusterLoggingValue"}}}},"type":"object"},"aws-native:eks:NamespaceConfigProperties":{"description":"The custom namespace configuration to use with the add-on","properties":{"namespace":{"type":"string","description":"The custom namespace for creating the add-on"}},"type":"object","required":["namespace"]},"aws-native:eks:NodegroupLaunchTemplateSpecification":{"description":"An object representing a launch template specification for AWS EKS Nodegroup.","properties":{"id":{"type":"string","description":"The ID of the launch template.\n\nYou must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID."},"name":{"type":"string","description":"The name of the launch template.\n\nYou must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name."},"version":{"type":"string","description":"The version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates."}},"type":"object"},"aws-native:eks:NodegroupNodeRepairConfig":{"description":"The node auto repair configuration for node group.","properties":{"enabled":{"type":"boolean","description":"Set this value to true to enable node auto repair for the node group."},"maxParallelNodesRepairedCount":{"type":"integer","description":"Specify the maximum number of nodes that can be repaired concurrently or in parallel, expressed as a count of unhealthy nodes. This gives you finer-grained control over the pace of node replacements. When using this, you cannot also set MaxParallelNodesRepairedPercentage at the same time."},"maxParallelNodesRepairedPercentage":{"type":"integer","description":"Specify the maximum number of nodes that can be repaired concurrently or in parallel, expressed as a percentage of unhealthy nodes. This gives you finer-grained control over the pace of node replacements. When using this, you cannot also set MaxParallelNodesRepairedCount at the same time."},"maxUnhealthyNodeThresholdCount":{"type":"integer","description":"Specify a count threshold of unhealthy nodes, above which node auto repair actions will stop. When using this, you cannot also set MaxUnhealthyNodeThresholdPercentage at the same time."},"maxUnhealthyNodeThresholdPercentage":{"type":"integer","description":"Specify a percentage threshold of unhealthy nodes, above which node auto repair actions will stop. When using this, you cannot also set MaxUnhealthyNodeThresholdCount at the same time."},"nodeRepairConfigOverrides":{"type":"array","items":{"$ref":"#/types/aws-native:eks:NodegroupNodeRepairConfigOverrides"},"description":"Specify granular overrides for specific repair actions. These overrides control the repair action and the repair delay time before a node is considered eligible for repair. If you use this, you must specify all the values."}},"type":"object"},"aws-native:eks:NodegroupNodeRepairConfigOverrides":{"description":"Specify granular overrides for specific repair actions. These overrides control the repair action and the repair delay time before a node is considered eligible for repair. If you use this, you must specify all the values.","properties":{"minRepairWaitTimeMins":{"type":"integer","description":"Specify the minimum time in minutes to wait before attempting to repair a node with this specific NodeMonitoringCondition and NodeUnhealthyReason."},"nodeMonitoringCondition":{"type":"string","description":"Specify an unhealthy condition reported by the node monitoring agent that this override would apply to."},"nodeUnhealthyReason":{"type":"string","description":"Specify a reason reported by the node monitoring agent that this override would apply to."},"repairAction":{"$ref":"#/types/aws-native:eks:NodegroupNodeRepairConfigOverridesRepairAction","description":"Specify the repair action to take for nodes when all of the specified conditions are met."}},"type":"object"},"aws-native:eks:NodegroupNodeRepairConfigOverridesRepairAction":{"description":"Specify the repair action to take for nodes when all of the specified conditions are met.","type":"string","enum":[{"name":"Replace","value":"Replace"},{"name":"Reboot","value":"Reboot"},{"name":"NoAction","value":"NoAction"}]},"aws-native:eks:NodegroupRemoteAccess":{"description":"An object representing a remote access configuration specification for AWS EKS Nodegroup.","properties":{"ec2SshKey":{"type":"string","description":"The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group. For more information, see [Amazon EC2 key pairs and Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the *Amazon Elastic Compute Cloud User Guide for Linux Instances* . For Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more information, see [Amazon EC2 key pairs and Windows instances](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html) in the *Amazon Elastic Compute Cloud User Guide for Windows Instances* ."},"sourceSecurityGroups":{"type":"array","items":{"type":"string"},"description":"The security group IDs that are allowed SSH access (port 22) to the nodes. For Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't specify a source security group when you create a managed node group, then the port on the nodes is opened to the internet ( `0.0.0.0/0` ). For more information, see [Security Groups for Your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide* ."}},"type":"object","required":["ec2SshKey"]},"aws-native:eks:NodegroupScalingConfig":{"description":"An object representing a auto scaling group specification for AWS EKS Nodegroup.","properties":{"desiredSize":{"type":"integer","description":"The current number of nodes that the managed node group should maintain.\n\n\u003e If you use the Kubernetes [Cluster Autoscaler](https://docs.aws.amazon.com/https://github.com/kubernetes/autoscaler#kubernetes-autoscaler) , you shouldn't change the `desiredSize` value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down. \n\nWhenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.\n\nThis parameter can be different from `minSize` in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the `desiredSize` parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than `minSize` or higher than `maxSize` ."},"maxSize":{"type":"integer","description":"The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see [Amazon EKS service quotas](https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html) in the *Amazon EKS User Guide* ."},"minSize":{"type":"integer","description":"The minimum number of nodes that the managed node group can scale in to."}},"type":"object"},"aws-native:eks:NodegroupTaint":{"description":"An object representing a Taint specification for AWS EKS Nodegroup.","properties":{"effect":{"type":"string","description":"The effect of the taint."},"key":{"type":"string","description":"The key of the taint."},"value":{"type":"string","description":"The value of the taint."}},"type":"object"},"aws-native:eks:NodegroupUpdateConfig":{"description":"The node group update configuration.","properties":{"maxUnavailable":{"type":"number","description":"The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100. "},"maxUnavailablePercentage":{"type":"number","description":"The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value."},"updateStrategy":{"type":"string","description":"The configuration for the behavior to follow during an node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action."}},"type":"object"},"aws-native:eks:PodIdentityAssociationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:elasticache:AuthenticationModeProperties":{"description":"Specifies the authentication mode to use. Below is an example of the possible JSON values:\n\n```\n{ Passwords: [\"*****\", \"******\"] // If Type is password.\n}\n```","properties":{"passwords":{"type":"array","items":{"type":"string"},"description":"Passwords used for this user account. You can create up to two passwords for each user."},"type":{"$ref":"#/types/aws-native:elasticache:UserAuthenticationModePropertiesType","description":"Authentication Type"}},"type":"object","required":["type"]},"aws-native:elasticache:GlobalReplicationGroupMember":{"properties":{"replicationGroupId":{"type":"string","description":"Regionally unique identifier for the member i.e. ReplicationGroupId."},"replicationGroupRegion":{"type":"string","description":"The AWS region of the Global Datastore member."},"role":{"$ref":"#/types/aws-native:elasticache:GlobalReplicationGroupMemberRole","description":"Indicates the role of the member, primary or secondary."}},"type":"object"},"aws-native:elasticache:GlobalReplicationGroupMemberRole":{"description":"Indicates the role of the member, primary or secondary.","type":"string","enum":[{"name":"Primary","value":"PRIMARY"},{"name":"Secondary","value":"SECONDARY"}]},"aws-native:elasticache:GlobalReplicationGroupRegionalConfiguration":{"properties":{"replicationGroupId":{"type":"string","description":"The replication group id of the Global Datastore member."},"replicationGroupRegion":{"type":"string","description":"The AWS region of the Global Datastore member."},"reshardingConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:elasticache:GlobalReplicationGroupReshardingConfiguration"},"description":"A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster. "}},"type":"object"},"aws-native:elasticache:GlobalReplicationGroupReshardingConfiguration":{"properties":{"nodeGroupId":{"type":"string","description":"Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id."},"preferredAvailabilityZones":{"type":"array","items":{"type":"string"},"description":"A list of preferred availability zones for the nodes of new node groups."}},"type":"object"},"aws-native:elasticache:ParameterGroupTag":{"properties":{"key":{"type":"string","description":"The key for the tag. May not be null."},"value":{"type":"string","description":"The tag's value. May be null."}},"type":"object","required":["key","value"]},"aws-native:elasticache:ServerlessCacheCacheUsageLimits":{"description":"The cache capacity limit of the Serverless Cache.","properties":{"dataStorage":{"$ref":"#/types/aws-native:elasticache:ServerlessCacheDataStorage","description":"The maximum data storage limit in the cache, expressed in Gigabytes."},"ecpuPerSecond":{"$ref":"#/types/aws-native:elasticache:ServerlessCacheEcpuPerSecond","description":"The number of ElastiCache Processing Units (ECPU) the cache can consume per second."}},"type":"object"},"aws-native:elasticache:ServerlessCacheDataStorage":{"description":"The cached data capacity of the Serverless Cache.","properties":{"maximum":{"type":"integer","description":"The maximum cached data capacity of the Serverless Cache."},"minimum":{"type":"integer","description":"The minimum cached data capacity of the Serverless Cache."},"unit":{"$ref":"#/types/aws-native:elasticache:ServerlessCacheDataStorageUnit","description":"The unit of cached data capacity of the Serverless Cache."}},"type":"object","required":["unit"]},"aws-native:elasticache:ServerlessCacheDataStorageUnit":{"description":"The unit of cached data capacity of the Serverless Cache.","type":"string","enum":[{"name":"Gb","value":"GB"}]},"aws-native:elasticache:ServerlessCacheEcpuPerSecond":{"description":"The ECPU per second of the Serverless Cache.","properties":{"maximum":{"type":"integer","description":"The maximum ECPU per second of the Serverless Cache."},"minimum":{"type":"integer","description":"The minimum ECPU per second of the Serverless Cache."}},"type":"object"},"aws-native:elasticache:ServerlessCacheEndpoint":{"description":"The address and the port.","properties":{"address":{"type":"string","description":"Endpoint address."},"port":{"type":"string","description":"Endpoint port."}},"type":"object"},"aws-native:elasticache:ServerlessCacheTag":{"description":"A key-value pair to associate with Serverless Cache.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:elasticache:SubnetGroupTag":{"description":"A tag that can be added to an ElastiCache subnet group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted.","properties":{"key":{"type":"string","description":"The key for the tag. May not be null."},"value":{"type":"string","description":"The tag's value. May be null."}},"type":"object","required":["key","value"]},"aws-native:elasticache:UserAuthenticationModePropertiesType":{"description":"Authentication Type","type":"string","enum":[{"name":"Password","value":"password"},{"name":"NoPasswordRequired","value":"no-password-required"},{"name":"Iam","value":"iam"}]},"aws-native:elasticache:UserEngine":{"description":"The target cache engine for the user.","type":"string","enum":[{"name":"Redis","value":"redis"},{"name":"Valkey","value":"valkey"}]},"aws-native:elasticache:UserGroupEngine":{"description":"The target cache engine for the user group.","type":"string","enum":[{"name":"Redis","value":"redis"},{"name":"Valkey","value":"valkey"}]},"aws-native:elasticache:UserGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:elasticache:UserTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:elasticbeanstalk:ApplicationMaxAgeRule":{"properties":{"deleteSourceFromS3":{"type":"boolean","description":"Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version."},"enabled":{"type":"boolean","description":"Specify true to apply the rule, or false to disable it."},"maxAgeInDays":{"type":"integer","description":"Specify the number of days to retain an application versions."}},"type":"object"},"aws-native:elasticbeanstalk:ApplicationMaxCountRule":{"properties":{"deleteSourceFromS3":{"type":"boolean","description":"Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version."},"enabled":{"type":"boolean","description":"Specify true to apply the rule, or false to disable it."},"maxCount":{"type":"integer","description":"Specify the maximum number of application versions to retain."}},"type":"object"},"aws-native:elasticbeanstalk:ApplicationResourceLifecycleConfig":{"properties":{"serviceRole":{"type":"string","description":"The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value."},"versionLifecycleConfig":{"$ref":"#/types/aws-native:elasticbeanstalk:ApplicationVersionLifecycleConfig","description":"Defines lifecycle settings for application versions."}},"type":"object"},"aws-native:elasticbeanstalk:ApplicationVersionLifecycleConfig":{"properties":{"maxAgeRule":{"$ref":"#/types/aws-native:elasticbeanstalk:ApplicationMaxAgeRule","description":"Specify a max age rule to restrict the length of time that application versions are retained for an application."},"maxCountRule":{"$ref":"#/types/aws-native:elasticbeanstalk:ApplicationMaxCountRule","description":"Specify a max count rule to restrict the number of application versions that are retained for an application."}},"type":"object"},"aws-native:elasticbeanstalk:ApplicationVersionSourceBundle":{"properties":{"s3Bucket":{"type":"string","description":"The Amazon S3 bucket where the data is located."},"s3Key":{"type":"string","description":"The Amazon S3 key where the data is located."}},"type":"object","required":["s3Bucket","s3Key"]},"aws-native:elasticbeanstalk:ConfigurationTemplateConfigurationOptionSetting":{"properties":{"namespace":{"type":"string","description":"A unique namespace that identifies the option's associated AWS resource."},"optionName":{"type":"string","description":"The name of the configuration option."},"resourceName":{"type":"string","description":"A unique resource name for the option setting. Use it for a time–based scaling configuration option. "},"value":{"type":"string","description":"The current value for the configuration option."}},"type":"object","required":["namespace","optionName"]},"aws-native:elasticbeanstalk:ConfigurationTemplateSourceConfiguration":{"properties":{"applicationName":{"type":"string","description":"The name of the application associated with the configuration."},"templateName":{"type":"string","description":"The name of the configuration template."}},"type":"object","required":["applicationName","templateName"]},"aws-native:elasticbeanstalk:EnvironmentOptionSetting":{"properties":{"namespace":{"type":"string","description":"A unique namespace that identifies the option's associated AWS resource."},"optionName":{"type":"string","description":"The name of the configuration option."},"resourceName":{"type":"string","description":"A unique resource name for the option setting. Use it for a time–based scaling configuration option."},"value":{"type":"string","description":"The current value for the configuration option."}},"type":"object","required":["namespace","optionName"]},"aws-native:elasticbeanstalk:EnvironmentTag":{"properties":{"key":{"type":"string","description":"The key name of the tag."},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key","value"]},"aws-native:elasticbeanstalk:EnvironmentTier":{"properties":{"name":{"type":"string","description":"The name of this environment tier.","replaceOnChanges":true},"type":{"type":"string","description":"The type of this environment tier.","replaceOnChanges":true},"version":{"type":"string","description":"The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerAction":{"description":"Specifies an action for a listener rule.","properties":{"authenticateCognitoConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerAuthenticateCognitoConfig","description":"[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``."},"authenticateOidcConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerAuthenticateOidcConfig","description":"[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``."},"fixedResponseConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerFixedResponseConfig","description":"[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``."},"forwardConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerForwardConfig","description":"Information for creating an action that distributes requests among multiple target groups. Specify only when ``Type`` is ``forward``.\n If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``."},"jwtValidationConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerJwtValidationConfig","description":"[HTTPS listeners] Information for validating JWT access tokens in client requests. Specify only when ``Type`` is ``jwt-validation``."},"order":{"type":"integer","description":"The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first."},"redirectConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRedirectConfig","description":"[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``."},"targetGroupArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to multiple target groups, you must use ``ForwardConfig`` instead."},"type":{"type":"string","description":"The type of action."}},"type":"object","required":["type"]},"aws-native:elasticloadbalancingv2:ListenerAttribute":{"description":"Information about a listener attribute.","properties":{"key":{"type":"string","description":"The name of the attribute.\n The following attribute is supported by Network Load Balancers, and Gateway Load Balancers.\n  +  ``tcp.idle_timeout.seconds`` - The tcp idle timeout value, in seconds. The valid range is 60-6000 seconds. The default is 350 seconds.\n  \n The following attributes are only supported by Application Load Balancers.\n  +  ``routing.http.request.x_amzn_mtls_clientcert_serial_number.header_name`` - Enables you to modify the header name of the *X-Amzn-Mtls-Clientcert-Serial-Number* HTTP request header.\n  +  ``routing.http.request.x_amzn_mtls_clientcert_issuer.header_name`` - Enables you to modify the header name of the *X-Amzn-Mtls-Clientcert-Issuer* HTTP request header.\n  +  ``routing.http.request.x_amzn_mtls_clientcert_subject.header_name`` - Enables you to modify the header name of the *X-Amzn-Mtls-Clientcert-Subject* HTTP request header.\n  +  ``routing.http.request.x_amzn_mtls_clientcert_validity.header_name`` - Enables you to modify the header name of the *X-Amzn-Mtls-Clientcert-Validity* HTTP request header.\n  +  ``routing.http.request.x_amzn_mtls_clientcert_leaf.header_name`` - Enables you to modify the header name of the *X-Amzn-Mtls-Clientcert-Leaf* HTTP request header.\n  +  ``routing.http.request.x_amzn_mtls_clientcert.header_name`` - Enables you to modify the header name of the *X-Amzn-Mtls-Clientcert* HTTP request header.\n  +  ``routing.http.request.x_amzn_tls_version.header_name`` - Enables you to modify the header name of the *X-Amzn-Tls-Version* HTTP request header.\n  +  ``routing.http.request.x_amzn_tls_cipher_suite.header_name`` - Enables you to modify the header name of the *X-Amzn-Tls-Cipher-Suite* HTTP request header.\n  +  ``routing.http.response.server.enabled`` - Enables you to allow or remove the HTTP response server header.\n  +  ``routing.http.response.strict_transport_security.header_value`` - Informs browsers that the site should only be accessed using HTTPS, and that any future attempts to access it using HTTP should automatically be converted to HTTPS.\n  +  ``routing.http.response.access_control_allow_origin.header_value`` - Specifies which origins are allowed to access the server.\n  +  ``routing.http.response.access_control_allow_methods.header_value`` - Returns which HTTP methods are allowed when accessing the server from a different origin.\n  +  ``routing.http.response.access_control_allow_headers.header_value`` - Specifies which headers can be used during the request.\n  +  ``routing.http.response.access_control_allow_credentials.header_value`` - Indicates whether the browser should include credentials such as cookies or authentication when making requests.\n  +  ``routing.http.response.access_control_expose_headers.header_value`` - Returns which headers the browser can expose to the requesting client.\n  +  ``routing.http.response.access_control_max_age.header_value`` - Specifies how long the results of a preflight request can be cached, in seconds.\n  +  ``routing.http.response.content_security_policy.header_value`` - Specifies restrictions enforced by the browser to help minimize the risk of certain types of security threats.\n  +  ``routing.http.response.x_content_type_options.header_value`` - Indicates whether the MIME types advertised in the *Content-Type* headers should be followed and not be changed.\n  +  ``routing.http.response.x_frame_options.header_value`` - Indicates whether the browser is allowed to render a page in a *frame*, *iframe*, *embed* or *object*."},"value":{"type":"string","description":"The value of the attribute."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerAuthenticateCognitoConfig":{"description":"Specifies information required when integrating with Amazon Cognito to authenticate users.","properties":{"authenticationRequestExtraParams":{"type":"object","additionalProperties":{"type":"string"},"description":"The query parameters (up to 10) to include in the redirect request to the authorization endpoint."},"onUnauthenticatedRequest":{"type":"string","description":"The behavior if the user is not authenticated. The following are possible values:\n  +  deny```` - Return an HTTP 401 Unauthorized error.\n  +  allow```` - Allow the request to be forwarded to the target.\n  +  authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value."},"scope":{"type":"string","description":"The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP."},"sessionCookieName":{"type":"string","description":"The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie."},"sessionTimeout":{"type":"string","description":"The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days)."},"userPoolArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon Cognito user pool."},"userPoolClientId":{"type":"string","description":"The ID of the Amazon Cognito user pool client."},"userPoolDomain":{"type":"string","description":"The domain prefix or fully-qualified domain name of the Amazon Cognito user pool."}},"type":"object","required":["userPoolArn","userPoolClientId","userPoolDomain"]},"aws-native:elasticloadbalancingv2:ListenerAuthenticateOidcConfig":{"description":"Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.","properties":{"authenticationRequestExtraParams":{"type":"object","additionalProperties":{"type":"string"},"description":"The query parameters (up to 10) to include in the redirect request to the authorization endpoint."},"authorizationEndpoint":{"type":"string","description":"The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path."},"clientId":{"type":"string","description":"The OAuth 2.0 client identifier."},"clientSecret":{"type":"string","description":"The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true."},"issuer":{"type":"string","description":"The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path."},"onUnauthenticatedRequest":{"type":"string","description":"The behavior if the user is not authenticated. The following are possible values:\n  +  deny```` - Return an HTTP 401 Unauthorized error.\n  +  allow```` - Allow the request to be forwarded to the target.\n  +  authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value."},"scope":{"type":"string","description":"The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP."},"sessionCookieName":{"type":"string","description":"The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie."},"sessionTimeout":{"type":"string","description":"The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days)."},"tokenEndpoint":{"type":"string","description":"The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path."},"useExistingClientSecret":{"type":"boolean","description":"Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false."},"userInfoEndpoint":{"type":"string","description":"The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path."}},"type":"object","required":["authorizationEndpoint","clientId","issuer","tokenEndpoint","userInfoEndpoint"]},"aws-native:elasticloadbalancingv2:ListenerCertificate":{"description":"Specifies an SSL server certificate to use as the default certificate for a secure listener.","properties":{"certificateArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the certificate."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerFixedResponseConfig":{"description":"Specifies information required when returning a custom HTTP response.","properties":{"contentType":{"type":"string","description":"The content type.\n Valid Values: text/plain | text/css | text/html | application/javascript | application/json"},"messageBody":{"type":"string","description":"The message."},"statusCode":{"type":"string","description":"The HTTP response code (2XX, 4XX, or 5XX)."}},"type":"object","required":["statusCode"]},"aws-native:elasticloadbalancingv2:ListenerForwardConfig":{"description":"Information for creating an action that distributes requests among multiple target groups. Specify only when ``Type`` is ``forward``.\n If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``.","properties":{"targetGroupStickinessConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerTargetGroupStickinessConfig","description":"Information about the target group stickiness for a rule."},"targetGroups":{"type":"array","items":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerTargetGroupTuple"},"description":"Information about how traffic will be distributed between multiple target groups in a forward rule."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerJwtValidationActionAdditionalClaim":{"description":"Information about an additional claim to validate.","properties":{"format":{"type":"string","description":"The format of the claim value."},"name":{"type":"string","description":"The name of the claim. You can't specify ``exp``, ``iss``, ``nbf``, or ``iat`` because we validate them by default."},"values":{"type":"array","items":{"type":"string"},"description":"The claim value. The maximum size of the list is 10. Each value can be up to 256 characters in length. If the format is ``space-separated-values``, the values can't include spaces."}},"type":"object","required":["format","name","values"]},"aws-native:elasticloadbalancingv2:ListenerJwtValidationConfig":{"properties":{"additionalClaims":{"type":"array","items":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerJwtValidationActionAdditionalClaim"}},"issuer":{"type":"string"},"jwksEndpoint":{"type":"string"}},"type":"object","required":["issuer","jwksEndpoint"]},"aws-native:elasticloadbalancingv2:ListenerMutualAuthentication":{"description":"The mutual authentication configuration information.","properties":{"advertiseTrustStoreCaNames":{"type":"string","description":"Indicates whether trust store CA certificate names are advertised."},"ignoreClientCertificateExpiry":{"type":"boolean","description":"Indicates whether expired client certificates are ignored."},"mode":{"type":"string","description":"The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``."},"trustStoreArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the trust store."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerRedirectConfig":{"description":"Information about a redirect action.\n A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.\n You can reuse URI components using the following reserved keywords:\n  +  #{protocol}\n  +  #{host}\n  +  #{port}\n  +  #{path} (the leading \"/\" is removed)\n  +  #{query}\n  \n For example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\", or the query to \"#{query}\u0026value=xyz\".","properties":{"host":{"type":"string","description":"The hostname. This component is not percent-encoded. The hostname can contain #{host}."},"path":{"type":"string","description":"The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}."},"port":{"type":"string","description":"The port. You can specify a value from 1 to 65535 or #{port}."},"protocol":{"type":"string","description":"The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You can't redirect HTTPS to HTTP."},"query":{"type":"string","description":"The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\", as it is automatically added. You can specify any of the reserved keywords."},"statusCode":{"type":"string","description":"The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302)."}},"type":"object","required":["statusCode"]},"aws-native:elasticloadbalancingv2:ListenerRuleAction":{"description":"Specifies an action for a listener rule.","properties":{"authenticateCognitoConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleAuthenticateCognitoConfig","description":"[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``."},"authenticateOidcConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleAuthenticateOidcConfig","description":"[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``."},"fixedResponseConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleFixedResponseConfig","description":"[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``."},"forwardConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleForwardConfig","description":"Information for creating an action that distributes requests among multiple target groups. Specify only when ``Type`` is ``forward``.\n If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``."},"jwtValidationConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleJwtValidationConfig","description":"[HTTPS listeners] Information for validating JWT access tokens in client requests. Specify only when ``Type`` is ``jwt-validation``."},"order":{"type":"integer","description":"The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first."},"redirectConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleRedirectConfig","description":"[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``."},"targetGroupArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to multiple target groups, you must use ``ForwardConfig`` instead."},"type":{"type":"string","description":"The type of action."}},"type":"object","required":["type"]},"aws-native:elasticloadbalancingv2:ListenerRuleAuthenticateCognitoConfig":{"description":"Specifies information required when integrating with Amazon Cognito to authenticate users.","properties":{"authenticationRequestExtraParams":{"type":"object","additionalProperties":{"type":"string"},"description":"The query parameters (up to 10) to include in the redirect request to the authorization endpoint."},"onUnauthenticatedRequest":{"type":"string","description":"The behavior if the user is not authenticated. The following are possible values:\n  +  deny```` - Return an HTTP 401 Unauthorized error.\n  +  allow```` - Allow the request to be forwarded to the target.\n  +  authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value."},"scope":{"type":"string","description":"The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP."},"sessionCookieName":{"type":"string","description":"The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie."},"sessionTimeout":{"type":"integer","description":"The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days)."},"userPoolArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon Cognito user pool."},"userPoolClientId":{"type":"string","description":"The ID of the Amazon Cognito user pool client."},"userPoolDomain":{"type":"string","description":"The domain prefix or fully-qualified domain name of the Amazon Cognito user pool."}},"type":"object","required":["userPoolArn","userPoolClientId","userPoolDomain"]},"aws-native:elasticloadbalancingv2:ListenerRuleAuthenticateOidcConfig":{"description":"Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.","properties":{"authenticationRequestExtraParams":{"type":"object","additionalProperties":{"type":"string"},"description":"The query parameters (up to 10) to include in the redirect request to the authorization endpoint."},"authorizationEndpoint":{"type":"string","description":"The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path."},"clientId":{"type":"string","description":"The OAuth 2.0 client identifier."},"clientSecret":{"type":"string","description":"The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true."},"issuer":{"type":"string","description":"The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path."},"onUnauthenticatedRequest":{"type":"string","description":"The behavior if the user is not authenticated. The following are possible values:\n  +  deny```` - Return an HTTP 401 Unauthorized error.\n  +  allow```` - Allow the request to be forwarded to the target.\n  +  authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value."},"scope":{"type":"string","description":"The set of user claims to be requested from the IdP. The default is ``openid``.\n To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP."},"sessionCookieName":{"type":"string","description":"The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie."},"sessionTimeout":{"type":"integer","description":"The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days)."},"tokenEndpoint":{"type":"string","description":"The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path."},"useExistingClientSecret":{"type":"boolean","description":"Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false."},"userInfoEndpoint":{"type":"string","description":"The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path."}},"type":"object","required":["authorizationEndpoint","clientId","issuer","tokenEndpoint","userInfoEndpoint"]},"aws-native:elasticloadbalancingv2:ListenerRuleFixedResponseConfig":{"description":"Specifies information required when returning a custom HTTP response.","properties":{"contentType":{"type":"string","description":"The content type.\n Valid Values: text/plain | text/css | text/html | application/javascript | application/json"},"messageBody":{"type":"string","description":"The message."},"statusCode":{"type":"string","description":"The HTTP response code (2XX, 4XX, or 5XX)."}},"type":"object","required":["statusCode"]},"aws-native:elasticloadbalancingv2:ListenerRuleForwardConfig":{"description":"Information for creating an action that distributes requests among multiple target groups. Specify only when ``Type`` is ``forward``.\n If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``.","properties":{"targetGroupStickinessConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleTargetGroupStickinessConfig","description":"Information about the target group stickiness for a rule."},"targetGroups":{"type":"array","items":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleTargetGroupTuple"},"description":"Information about how traffic will be distributed between multiple target groups in a forward rule."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerRuleHostHeaderConfig":{"description":"Information about a host header condition.","properties":{"regexValues":{"type":"array","items":{"type":"string"}},"values":{"type":"array","items":{"type":"string"},"description":"The host names. The maximum length of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). You must include at least one \".\" character. You can include only alphabetical characters after the final \".\" character.\n If you specify multiple strings, the condition is satisfied if one of the strings matches the host name."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerRuleHttpHeaderConfig":{"description":"Information about an HTTP header condition.\n There is a set of standard HTTP header fields. You can also define custom HTTP header fields.","properties":{"httpHeaderName":{"type":"string","description":"The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported."},"regexValues":{"type":"array","items":{"type":"string"}},"values":{"type":"array","items":{"type":"string"},"description":"The strings to compare against the value of the HTTP header. The maximum length of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If the same header appears multiple times in the request, we search them in order until a match is found.\n If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerRuleHttpRequestMethodConfig":{"description":"Information about an HTTP method condition.\n HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the [HTTP Method Registry](https://docs.aws.amazon.com/https://www.iana.org/assignments/http-methods/http-methods.xhtml). You can also define custom HTTP methods.","properties":{"values":{"type":"array","items":{"type":"string"},"description":"The name of the request method. The maximum length is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.\n If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerRuleJwtValidationActionAdditionalClaim":{"description":"Information about an additional claim to validate.","properties":{"format":{"type":"string","description":"The format of the claim value."},"name":{"type":"string","description":"The name of the claim. You can't specify ``exp``, ``iss``, ``nbf``, or ``iat`` because we validate them by default."},"values":{"type":"array","items":{"type":"string"},"description":"The claim value. The maximum size of the list is 10. Each value can be up to 256 characters in length. If the format is ``space-separated-values``, the values can't include spaces."}},"type":"object","required":["format","name","values"]},"aws-native:elasticloadbalancingv2:ListenerRuleJwtValidationConfig":{"properties":{"additionalClaims":{"type":"array","items":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleJwtValidationActionAdditionalClaim"}},"issuer":{"type":"string"},"jwksEndpoint":{"type":"string"}},"type":"object","required":["issuer","jwksEndpoint"]},"aws-native:elasticloadbalancingv2:ListenerRulePathPatternConfig":{"description":"Information about a path pattern condition.","properties":{"regexValues":{"type":"array","items":{"type":"string"}},"values":{"type":"array","items":{"type":"string"},"description":"The path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).\n If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerRuleQueryStringConfig":{"description":"Information about a query string condition.\n The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '\u0026' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded.","properties":{"values":{"type":"array","items":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleQueryStringKeyValue"},"description":"The key/value pairs or values to find in the query string. The maximum length of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in ``Values`` using a '\\' character.\n If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerRuleQueryStringKeyValue":{"description":"Information about a key/value pair.","properties":{"key":{"type":"string","description":"The key. You can omit the key."},"value":{"type":"string","description":"The value."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerRuleRedirectConfig":{"description":"Information about a redirect action.\n A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.\n You can reuse URI components using the following reserved keywords:\n  +  #{protocol}\n  +  #{host}\n  +  #{port}\n  +  #{path} (the leading \"/\" is removed)\n  +  #{query}\n  \n For example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\", or the query to \"#{query}\u0026value=xyz\".","properties":{"host":{"type":"string","description":"The hostname. This component is not percent-encoded. The hostname can contain #{host}."},"path":{"type":"string","description":"The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}."},"port":{"type":"string","description":"The port. You can specify a value from 1 to 65535 or #{port}."},"protocol":{"type":"string","description":"The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You can't redirect HTTPS to HTTP."},"query":{"type":"string","description":"The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\", as it is automatically added. You can specify any of the reserved keywords."},"statusCode":{"type":"string","description":"The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302)."}},"type":"object","required":["statusCode"]},"aws-native:elasticloadbalancingv2:ListenerRuleRewriteConfig":{"description":"Information about a rewrite transform. This transform matches a pattern and replaces it with the specified string.","properties":{"regex":{"type":"string","description":"The regular expression to match in the input string. The maximum length of the string is 1,024 characters."},"replace":{"type":"string","description":"The replacement string to use when rewriting the matched input. The maximum length of the string is 1,024 characters. You can specify capture groups in the regular expression (for example, $1 and $2)."}},"type":"object","required":["regex","replace"]},"aws-native:elasticloadbalancingv2:ListenerRuleRewriteConfigObject":{"properties":{"rewrites":{"type":"array","items":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleRewriteConfig"}}},"type":"object","required":["rewrites"]},"aws-native:elasticloadbalancingv2:ListenerRuleRuleCondition":{"description":"Specifies a condition for a listener rule.","properties":{"field":{"type":"string","description":"The field in the HTTP request. The following are the possible values:\n  +   ``http-header`` \n  +   ``http-request-method`` \n  +   ``host-header`` \n  +   ``path-pattern`` \n  +   ``query-string`` \n  +   ``source-ip``"},"hostHeaderConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleHostHeaderConfig","description":"Information for a host header condition. Specify only when ``Field`` is ``host-header``."},"httpHeaderConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleHttpHeaderConfig","description":"Information for an HTTP header condition. Specify only when ``Field`` is ``http-header``."},"httpRequestMethodConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleHttpRequestMethodConfig","description":"Information for an HTTP method condition. Specify only when ``Field`` is ``http-request-method``."},"pathPatternConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRulePathPatternConfig","description":"Information for a path pattern condition. Specify only when ``Field`` is ``path-pattern``."},"queryStringConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleQueryStringConfig","description":"Information for a query string condition. Specify only when ``Field`` is ``query-string``."},"regexValues":{"type":"array","items":{"type":"string"},"description":"The regular expressions to match against the condition field. The maximum length of each string is 128 characters. Specify only when ``Field`` is ``http-header``, ``host-header``, or ``path-pattern``."},"sourceIpConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleSourceIpConfig","description":"Information for a source IP condition. Specify only when ``Field`` is ``source-ip``."},"values":{"type":"array","items":{"type":"string"},"description":"The condition value. Specify only when ``Field`` is ``host-header`` or ``path-pattern``. Alternatively, to specify multiple host names or multiple path patterns, use ``HostHeaderConfig`` or ``PathPatternConfig``.\n If ``Field`` is ``host-header`` and you're not using ``HostHeaderConfig``, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.\n  +  A-Z, a-z, 0-9\n  +  - .\n  +  * (matches 0 or more characters)\n  +  ? (matches exactly 1 character)\n  \n If ``Field`` is ``path-pattern`` and you're not using ``PathPatternConfig``, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.\n  +  A-Z, a-z, 0-9\n  +  _ - . $ / ~ \" ' @ : +\n  +  \u0026 (using \u0026amp;)\n  +  * (matches 0 or more characters)\n  +  ? (matches exactly 1 character)"}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerRuleSourceIpConfig":{"description":"Information about a source IP condition.\n You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.","properties":{"values":{"type":"array","items":{"type":"string"},"description":"The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.\n If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerRuleTargetGroupStickinessConfig":{"description":"Information about the target group stickiness for a rule.","properties":{"durationSeconds":{"type":"integer","description":"[Application Load Balancers] The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days). You must specify this value when enabling target group stickiness."},"enabled":{"type":"boolean","description":"Indicates whether target group stickiness is enabled."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerRuleTargetGroupTuple":{"description":"Information about how traffic will be distributed between multiple target groups in a forward rule.","properties":{"targetGroupArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the target group."},"weight":{"type":"integer","description":"The weight. The range is 0 to 999."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerRuleTransform":{"properties":{"hostHeaderRewriteConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleRewriteConfigObject"},"type":{"type":"string"},"urlRewriteConfig":{"$ref":"#/types/aws-native:elasticloadbalancingv2:ListenerRuleRewriteConfigObject"}},"type":"object","required":["type"]},"aws-native:elasticloadbalancingv2:ListenerTargetGroupStickinessConfig":{"description":"Information about the target group stickiness for a rule.","properties":{"durationSeconds":{"type":"integer","description":"[Application Load Balancers] The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days). You must specify this value when enabling target group stickiness."},"enabled":{"type":"boolean","description":"Indicates whether target group stickiness is enabled."}},"type":"object"},"aws-native:elasticloadbalancingv2:ListenerTargetGroupTuple":{"description":"Information about how traffic will be distributed between multiple target groups in a forward rule.","properties":{"targetGroupArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the target group."},"weight":{"type":"integer","description":"The weight. The range is 0 to 999."}},"type":"object"},"aws-native:elasticloadbalancingv2:LoadBalancerAttribute":{"description":"Specifies an attribute for an Application Load Balancer, a Network Load Balancer, or a Gateway Load Balancer.","properties":{"key":{"type":"string","description":"The name of the attribute.\n The following attributes are supported by all load balancers:\n  +  ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``.\n  +  ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and can't be changed.\n  \n The following attributes are supported by both Application Load Balancers and Network Load Balancers:\n  +  ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``.\n  +  ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.\n  +  ``access_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the access logs.\n  +  ``ipv6.deny_all_igw_traffic`` - Blocks internet gateway (IGW) access to the load balancer. It is set to ``false`` for internet-facing load balancers and ``true`` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway.\n  +  ``zonal_shift.config.enabled`` - Indicates whether zonal shift is enabled. The possible values are ``true`` and ``false``. The default is ``false``.\n  \n The following attributes are supported by only Application Load Balancers:\n  +  ``idle_timeout.timeout_seconds`` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.\n  +  ``client_keep_alive.seconds`` - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds.\n  +  ``connection_logs.s3.enabled`` - Indicates whether connection logs are enabled. The value is ``true`` or ``false``. The default is ``false``.\n  +  ``connection_logs.s3.bucket`` - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.\n  +  ``connection_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the connection logs.\n  +  ``health_check_logs.s3.enabled`` - Indicates whether health check logs are enabled. The value is ``true`` or ``false``. The default is ``false``.\n  +  ``health_check_logs.s3.bucket`` - The name of the S3 bucket for the health check logs. This attribute is required if health check logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.\n  +  ``health_check_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the health check logs.\n  +  ``routing.http.desync_mitigation_mode`` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are ``monitor``, ``defensive``, and ``strictest``. The default is ``defensive``.\n  +  ``routing.http.drop_invalid_header_fields.enabled`` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (``true``) or routed to targets (``false``). The default is ``false``.\n  +  ``routing.http.preserve_host_header.enabled`` - Indicates whether the Application Load Balancer should preserve the ``Host`` header in the HTTP request and send it to the target without any change. The possible values are ``true`` and ``false``. The default is ``false``.\n  +  ``routing.http.x_amzn_tls_version_and_cipher_suite.enabled`` - Indicates whether the two headers (``x-amzn-tls-version`` and ``x-amzn-tls-cipher-suite``), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The ``x-amzn-tls-version`` header has information about the TLS protocol version negotiated with the client, and the ``x-amzn-tls-cipher-suite`` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are ``true`` and ``false``. The default is ``false``.\n  +  ``routing.http.xff_client_port.enabled`` - Indicates whether the ``X-Forwarded-For`` header should preserve the source port that the client used to connect to the load balancer. The possible values are ``true`` and ``false``. The default is ``false``.\n  +  ``routing.http.xff_header_processing.mode`` - Enables you to modify, preserve, or remove the ``X-Forwarded-For`` header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are ``append``, ``preserve``, and ``remove``. The default is ``append``.\n  +  If the value is ``append``, the Application Load Balancer adds the client IP address (of the last hop) to the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets.\n  +  If the value is ``preserve`` the Application Load Balancer preserves the ``X-Forwarded-For`` header in the HTTP request, and sends it to targets without any change.\n  +  If the value is ``remove``, the Application Load Balancer removes the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets.\n  \n  +  ``routing.http2.enabled`` - Indicates whether clients can connect to the load balancer using HTTP/2. If ``true``, clients can connect using HTTP/2 or HTTP/1.1. However, all client requests are subject to the stricter HTTP/2 header validation rules. For example, message header names must contain only alphanumeric characters and hyphens. If ``false``, clients must connect using HTTP/1.1. The default is ``true``.\n  +  ``waf.fail_open.enabled`` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are ``true`` and ``false``. The default is ``false``.\n  \n The following attributes are supported by only Network Load Balancers:\n  +  ``dns_record.client_routing_policy`` - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are ``availability_zone_affinity`` with 100 percent zonal affinity, ``partial_availability_zone_affinity`` with 85 percent zonal affinity, and ``any_availability_zone`` with 0 percent zonal affinity.\n  +  ``secondary_ips.auto_assigned.per_subnet`` - The number of secondary IP addresses to configure for your load balancer nodes. Use to address port allocation errors if you can't add targets. The valid range is 0 to 7. The default is 0. After you set this value, you can't decrease it."},"value":{"type":"string","description":"The value of the attribute."}},"type":"object"},"aws-native:elasticloadbalancingv2:LoadBalancerMinimumLoadBalancerCapacity":{"description":"The minimum capacity for a load balancer.","properties":{"capacityUnits":{"type":"integer","description":"The number of capacity units."}},"type":"object","required":["capacityUnits"]},"aws-native:elasticloadbalancingv2:LoadBalancerSubnetMapping":{"description":"Specifies a subnet for a load balancer.","properties":{"allocationId":{"type":"string","description":"[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer."},"iPv6Address":{"type":"string","description":"[Network Load Balancers] The IPv6 address."},"privateIPv4Address":{"type":"string","description":"[Network Load Balancers] The private IPv4 address for an internal load balancer."},"sourceNatIpv6Prefix":{"type":"string","description":"[Network Load Balancers with UDP listeners] The IPv6 prefix to use for source NAT. Specify an IPv6 prefix (/80 netmask) from the subnet CIDR block or ``auto_assigned`` to use an IPv6 prefix selected at random from the subnet CIDR block."},"subnetId":{"type":"string","description":"The ID of the subnet."}},"type":"object","required":["subnetId"]},"aws-native:elasticloadbalancingv2:LoadBalancerTag":{"description":"Information about a tag.","properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key"]},"aws-native:elasticloadbalancingv2:TargetGroupAttribute":{"properties":{"key":{"type":"string","description":"The value of the attribute."},"value":{"type":"string","description":"The name of the attribute."}},"type":"object"},"aws-native:elasticloadbalancingv2:TargetGroupMatcher":{"properties":{"grpcCode":{"type":"string","description":"You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12."},"httpCode":{"type":"string","description":"For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values. "}},"type":"object"},"aws-native:elasticloadbalancingv2:TargetGroupTag":{"properties":{"key":{"type":"string","description":"The value for the tag. "},"value":{"type":"string","description":"The key name of the tag. "}},"type":"object","required":["key","value"]},"aws-native:elasticloadbalancingv2:TargetGroupTargetDescription":{"properties":{"availabilityZone":{"type":"string","description":"An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer."},"id":{"type":"string","description":"The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target. "},"port":{"type":"integer","description":"The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function."},"quicServerId":{"type":"string","description":"The Server ID used by targets when using QUIC or TCP_QUIC protocols."}},"type":"object","required":["id"]},"aws-native:elasticloadbalancingv2:TrustStoreRevocation":{"properties":{"numberOfRevokedEntries":{"type":"integer","description":"The number of revoked certificates."},"revocationId":{"type":"string","description":"The revocation ID of the revocation file."},"revocationType":{"type":"string","description":"The type of revocation file."},"trustStoreArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the trust store."}},"type":"object"},"aws-native:elasticloadbalancingv2:TrustStoreRevocationRevocationContent":{"properties":{"revocationType":{"type":"string","description":"The type of revocation file."},"s3Bucket":{"type":"string","description":"The Amazon S3 bucket for the revocation file."},"s3Key":{"type":"string","description":"The Amazon S3 path for the revocation file."},"s3ObjectVersion":{"type":"string","description":"The Amazon S3 object version of the revocation file."}},"type":"object"},"aws-native:elasticloadbalancingv2:TrustStoreTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:emr:StepHadoopJarStepConfig":{"properties":{"args":{"type":"array","items":{"type":"string"},"description":"A list of command line arguments passed to the JAR file's main function when executed."},"jar":{"type":"string","description":"A path to a JAR file run during the step."},"mainClass":{"type":"string","description":"The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file."},"stepProperties":{"type":"array","items":{"$ref":"#/types/aws-native:emr:StepKeyValue"},"description":"A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function."}},"type":"object","required":["jar"]},"aws-native:emr:StepKeyValue":{"properties":{"key":{"type":"string","description":"The unique identifier of a key-value pair."},"value":{"type":"string","description":"The value part of the identified key."}},"type":"object"},"aws-native:emr:StudioAuthMode":{"description":"Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.","type":"string","enum":[{"name":"Sso","value":"SSO"},{"name":"Iam","value":"IAM"}]},"aws-native:emr:StudioIdcUserAssignment":{"description":"Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.","type":"string","enum":[{"name":"Required","value":"REQUIRED"},{"name":"Optional","value":"OPTIONAL"}]},"aws-native:emr:StudioSessionMappingIdentityType":{"description":"Specifies whether the identity to map to the Studio is a user or a group.","type":"string","enum":[{"name":"User","value":"USER"},{"name":"Group","value":"GROUP"}]},"aws-native:emr:StudioTag":{"description":"An arbitrary set of tags (key-value pairs) for this EMR Studio.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:emr:WalWorkspaceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:emrcontainers:EndpointCertificate":{"properties":{"certificateArn":{"type":"string"},"certificateData":{"type":"string"}},"type":"object"},"aws-native:emrcontainers:EndpointCloudWatchMonitoringConfiguration":{"properties":{"logGroupName":{"type":"string"},"logStreamNamePrefix":{"type":"string"}},"type":"object","required":["logGroupName"]},"aws-native:emrcontainers:EndpointConfigurationOverrides":{"properties":{"applicationConfiguration":{"type":"array","items":{"$ref":"#/types/aws-native:emrcontainers:EndpointEmreksConfiguration"}},"monitoringConfiguration":{"$ref":"#/types/aws-native:emrcontainers:EndpointMonitoringConfiguration"}},"type":"object"},"aws-native:emrcontainers:EndpointContainerLogRotationConfiguration":{"properties":{"maxFilesToKeep":{"type":"integer"},"rotationSize":{"type":"string"}},"type":"object","required":["maxFilesToKeep","rotationSize"]},"aws-native:emrcontainers:EndpointEmreksConfiguration":{"properties":{"classification":{"type":"string"},"configurations":{"type":"array","items":{"$ref":"#/types/aws-native:emrcontainers:EndpointEmreksConfiguration"}},"properties":{"type":"object","additionalProperties":{"type":"string"}}},"type":"object","required":["classification"]},"aws-native:emrcontainers:EndpointMonitoringConfiguration":{"properties":{"cloudWatchMonitoringConfiguration":{"$ref":"#/types/aws-native:emrcontainers:EndpointCloudWatchMonitoringConfiguration"},"containerLogRotationConfiguration":{"$ref":"#/types/aws-native:emrcontainers:EndpointContainerLogRotationConfiguration"},"persistentAppUi":{"$ref":"#/types/aws-native:emrcontainers:EndpointMonitoringConfigurationPersistentAppUi"},"s3MonitoringConfiguration":{"$ref":"#/types/aws-native:emrcontainers:EndpointS3MonitoringConfiguration"}},"type":"object"},"aws-native:emrcontainers:EndpointMonitoringConfigurationPersistentAppUi":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:emrcontainers:EndpointS3MonitoringConfiguration":{"properties":{"logUri":{"type":"string"}},"type":"object","required":["logUri"]},"aws-native:emrcontainers:EndpointTag":{"properties":{"key":{"type":"string","description":"A user-defined key, which is the minimum required information for a valid tag."},"value":{"type":"string","description":"A user-defined value, which is optional in a tag."}},"type":"object","required":["key","value"]},"aws-native:emrcontainers:SecurityConfigurationAtRestEncryptionConfiguration":{"description":"At-rest encryption configuration.","properties":{"localDiskEncryptionConfiguration":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationLocalDiskEncryptionConfiguration"},"s3EncryptionConfiguration":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationS3EncryptionConfiguration"}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationAuthenticationConfiguration":{"description":"Authentication configuration for the security configuration.","properties":{"iamConfiguration":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationIamConfiguration"},"identityCenterConfiguration":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationIdentityCenterConfiguration"}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationAuthorizationConfiguration":{"description":"Authorization configuration for the security configuration.","properties":{"lakeFormationConfiguration":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationLakeFormationConfiguration"}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationContainerInfo":{"description":"Container information.","properties":{"eksInfo":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationEksInfo"}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationContainerProvider":{"description":"Container provider information.","properties":{"id":{"type":"string","description":"The container provider ID."},"info":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationContainerInfo"},"type":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationContainerProviderType","description":"The container provider type."}},"type":"object","required":["id","type"]},"aws-native:emrcontainers:SecurityConfigurationContainerProviderType":{"description":"The container provider type.","type":"string","enum":[{"name":"Eks","value":"EKS"}]},"aws-native:emrcontainers:SecurityConfigurationData":{"description":"Security configuration data containing encryption and authorization settings.","properties":{"authenticationConfiguration":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationAuthenticationConfiguration"},"authorizationConfiguration":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationAuthorizationConfiguration"},"encryptionConfiguration":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationEncryptionConfiguration"}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationEksInfo":{"description":"EKS information.","properties":{"namespace":{"type":"string","description":"The EKS namespace."}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationEncryptionConfiguration":{"description":"Encryption configuration for the security configuration.","properties":{"atRestEncryptionConfiguration":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationAtRestEncryptionConfiguration"},"inTransitEncryptionConfiguration":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationInTransitEncryptionConfiguration"}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationIamConfiguration":{"description":"IAM configuration.","properties":{"systemRole":{"type":"string","description":"The system role ARN."}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationIdentityCenterConfiguration":{"description":"Identity Center configuration.","properties":{"enableIdentityCenter":{"type":"boolean","description":"Whether to enable Identity Center integration."},"identityCenterApplicationAssignmentRequired":{"type":"boolean","description":"Whether Identity Center application assignment is required."},"identityCenterInstanceArn":{"type":"string","description":"The ARN of the Identity Center instance."}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationInTransitEncryptionConfiguration":{"description":"In-transit encryption configuration.","properties":{"tlsCertificateConfiguration":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationTlsCertificateConfiguration"}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationLakeFormationConfiguration":{"description":"Lake Formation configuration.","properties":{"authorizedSessionTagValue":{"type":"string","description":"The session tag to authorize Lake Formation access."},"queryAccessControlEnabled":{"type":"boolean","description":"Whether query access control is enabled."},"queryEngineRoleArn":{"type":"string","description":"The ARN of the query engine role."},"secureNamespaceInfo":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationSecureNamespaceInfo"}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationLocalDiskEncryptionConfiguration":{"description":"Local disk encryption configuration.","properties":{"awsKmsKeyId":{"type":"string","description":"The AWS KMS key ID."},"encryptionKeyProviderType":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationLocalDiskEncryptionConfigurationEncryptionKeyProviderType","description":"The encryption key provider type."}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationLocalDiskEncryptionConfigurationEncryptionKeyProviderType":{"description":"The encryption key provider type.","type":"string","enum":[{"name":"AwsKms","value":"AwsKms"}]},"aws-native:emrcontainers:SecurityConfigurationS3EncryptionConfiguration":{"description":"S3 encryption configuration.","properties":{"encryptionOption":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationS3EncryptionConfigurationEncryptionOption","description":"The S3 encryption option."},"kmsKeyId":{"type":"string","description":"The KMS key ID for encryption."}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationS3EncryptionConfigurationEncryptionOption":{"description":"The S3 encryption option.","type":"string","enum":[{"name":"SseS3","value":"SSE-S3"},{"name":"SseKms","value":"SSE-KMS"},{"name":"CseKms","value":"CSE-KMS"}]},"aws-native:emrcontainers:SecurityConfigurationSecureNamespaceInfo":{"description":"Secure namespace information for Lake Formation.","properties":{"clusterId":{"type":"string","description":"The ID of the cluster."},"namespace":{"type":"string","description":"The namespace."}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationTag":{"description":"An arbitrary set of tags (key-value pairs) for this security configuration.","properties":{"key":{"type":"string","description":"The key name of the tag."},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key","value"]},"aws-native:emrcontainers:SecurityConfigurationTlsCertificateConfiguration":{"description":"TLS certificate configuration for in-transit encryption.","properties":{"certificateProviderType":{"$ref":"#/types/aws-native:emrcontainers:SecurityConfigurationTlsCertificateConfigurationCertificateProviderType","description":"The certificate provider type."},"privateKeySecretArn":{"type":"string","description":"The ARN of the secret containing the private key."},"publicKeySecretArn":{"type":"string","description":"The ARN of the secret containing the public key."}},"type":"object"},"aws-native:emrcontainers:SecurityConfigurationTlsCertificateConfigurationCertificateProviderType":{"description":"The certificate provider type.","type":"string","enum":[{"name":"Pem","value":"PEM"}]},"aws-native:emrcontainers:VirtualClusterContainerInfo":{"properties":{"eksInfo":{"$ref":"#/types/aws-native:emrcontainers:VirtualClusterEksInfo","description":"The information about the Amazon EKS cluster."}},"type":"object","required":["eksInfo"]},"aws-native:emrcontainers:VirtualClusterContainerProvider":{"properties":{"id":{"type":"string","description":"The ID of the container cluster"},"info":{"$ref":"#/types/aws-native:emrcontainers:VirtualClusterContainerInfo","description":"The information about the container cluster."},"type":{"type":"string","description":"The type of the container provider"}},"type":"object","required":["id","info","type"]},"aws-native:emrcontainers:VirtualClusterEksInfo":{"properties":{"namespace":{"type":"string","description":"The namespaces of the EKS cluster.\n\n*Minimum* : 1\n\n*Maximum* : 63\n\n*Pattern* : `[a-z0-9]([-a-z0-9]*[a-z0-9])?`"}},"type":"object","required":["namespace"]},"aws-native:emrcontainers:VirtualClusterTag":{"description":"An arbitrary set of tags (key-value pairs) for this virtual cluster.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:emrserverless:ApplicationArchitecture":{"description":"The cpu architecture of an application.","type":"string","enum":[{"name":"Arm64","value":"ARM64"},{"name":"X8664","value":"X86_64"}]},"aws-native:emrserverless:ApplicationAutoStartConfiguration":{"description":"Configuration for Auto Start of Application","properties":{"enabled":{"type":"boolean","description":"If set to true, the Application will automatically start. Defaults to true."}},"type":"object"},"aws-native:emrserverless:ApplicationAutoStopConfiguration":{"description":"Configuration for Auto Stop of Application","properties":{"enabled":{"type":"boolean","description":"If set to true, the Application will automatically stop after being idle. Defaults to true."},"idleTimeoutMinutes":{"type":"integer","description":"The amount of time [in minutes] to wait before auto stopping the Application when idle. Defaults to 15 minutes."}},"type":"object"},"aws-native:emrserverless:ApplicationCloudWatchLoggingConfiguration":{"properties":{"enabled":{"type":"boolean","description":"If set to false, CloudWatch logging will be turned off. Defaults to false."},"encryptionKeyArn":{"type":"string","description":"KMS key ARN to encrypt the logs stored in given CloudWatch log-group."},"logGroupName":{"type":"string","description":"Log-group name to produce log-streams on CloudWatch. If undefined, logs will be produced in a default log-group /aws/emr-serverless"},"logStreamNamePrefix":{"type":"string","description":"Log-stream name prefix by which log-stream names will start in the CloudWatch Log-group."},"logTypeMap":{"type":"array","items":{"$ref":"#/types/aws-native:emrserverless:ApplicationLogTypeMapKeyValuePair"},"description":"The specific log-streams which need to be uploaded to CloudWatch."}},"type":"object"},"aws-native:emrserverless:ApplicationConfigurationObject":{"description":"Configuration for a JobRun.","properties":{"classification":{"type":"string","description":"String with a maximum length of 1024."},"configurations":{"type":"array","items":{"$ref":"#/types/aws-native:emrserverless:ApplicationConfigurationObject"}},"properties":{"type":"object","additionalProperties":{"type":"string"}}},"type":"object","required":["classification"]},"aws-native:emrserverless:ApplicationIdentityCenterConfiguration":{"description":"The IAM IdentityCenter configuration for trusted-identity-propagation on this application. Supported with release labels emr-7.8.0 and above.","properties":{"identityCenterInstanceArn":{"type":"string","description":"The IAM IdentityCenter instance arn"}},"type":"object"},"aws-native:emrserverless:ApplicationImageConfigurationInput":{"description":"The image configuration.","properties":{"imageUri":{"type":"string","description":"The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration."}},"type":"object"},"aws-native:emrserverless:ApplicationInitialCapacityConfig":{"properties":{"workerConfiguration":{"$ref":"#/types/aws-native:emrserverless:ApplicationWorkerConfiguration"},"workerCount":{"type":"integer","description":"Initial count of workers to be initialized when an Application is started. This count will be continued to be maintained until the Application is stopped"}},"type":"object","required":["workerConfiguration","workerCount"]},"aws-native:emrserverless:ApplicationInitialCapacityConfigKeyValuePair":{"properties":{"key":{"type":"string","description":"Worker type for an analytics framework."},"value":{"$ref":"#/types/aws-native:emrserverless:ApplicationInitialCapacityConfig"}},"type":"object","required":["key","value"]},"aws-native:emrserverless:ApplicationInteractiveConfiguration":{"properties":{"livyEndpointEnabled":{"type":"boolean","description":"Enables an Apache Livy endpoint that you can connect to and run interactive jobs"},"studioEnabled":{"type":"boolean","description":"Enabled you to connect an Application to Amazon EMR Studio to run interactive workloads in a notebook"}},"type":"object"},"aws-native:emrserverless:ApplicationLogTypeMapKeyValuePair":{"properties":{"key":{"type":"string"},"value":{"type":"array","items":{"type":"string"}}},"type":"object","required":["key","value"]},"aws-native:emrserverless:ApplicationManagedPersistenceMonitoringConfiguration":{"properties":{"enabled":{"type":"boolean","description":"If set to false, managed logging will be turned off. Defaults to true."},"encryptionKeyArn":{"type":"string","description":"KMS key ARN to encrypt the logs stored in managed persistence"}},"type":"object"},"aws-native:emrserverless:ApplicationMaximumAllowedResources":{"properties":{"cpu":{"type":"string","description":"Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional."},"disk":{"type":"string","description":"Per worker Disk resource. GB is the only supported unit and specifying GB is optional"},"memory":{"type":"string","description":"Per worker memory resource. GB is the only supported unit and specifying GB is optional."}},"type":"object","required":["cpu","memory"]},"aws-native:emrserverless:ApplicationMonitoringConfiguration":{"description":"Monitoring configuration for batch and interactive JobRun.","properties":{"cloudWatchLoggingConfiguration":{"$ref":"#/types/aws-native:emrserverless:ApplicationCloudWatchLoggingConfiguration","description":"CloudWatch logging configurations for a JobRun."},"managedPersistenceMonitoringConfiguration":{"$ref":"#/types/aws-native:emrserverless:ApplicationManagedPersistenceMonitoringConfiguration","description":"Managed log persistence configurations for a JobRun."},"prometheusMonitoringConfiguration":{"$ref":"#/types/aws-native:emrserverless:ApplicationPrometheusMonitoringConfiguration","description":"Prometheus monitoring configurations for a JobRun."},"s3MonitoringConfiguration":{"$ref":"#/types/aws-native:emrserverless:ApplicationS3MonitoringConfiguration","description":"S3 monitoring configurations for a JobRun."}},"type":"object"},"aws-native:emrserverless:ApplicationNetworkConfiguration":{"properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The ID of the security groups in the VPC to which you want to connect your job or application."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The ID of the subnets in the VPC to which you want to connect your job or application."}},"type":"object"},"aws-native:emrserverless:ApplicationPrometheusMonitoringConfiguration":{"properties":{"remoteWriteUrl":{"type":"string","description":"The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to."}},"type":"object"},"aws-native:emrserverless:ApplicationS3MonitoringConfiguration":{"properties":{"encryptionKeyArn":{"type":"string","description":"KMS key ARN to encrypt the logs stored in given s3"},"logUri":{"type":"string"}},"type":"object"},"aws-native:emrserverless:ApplicationSchedulerConfiguration":{"description":"The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.","properties":{"maxConcurrentRuns":{"type":"integer","description":"The maximum concurrent job runs on this application. If scheduler configuration is enabled on your application, the default value is 15. The valid range is 1 to 1000."},"queueTimeoutMinutes":{"type":"integer","description":"The maximum duration in minutes for the job in QUEUED state. If scheduler configuration is enabled on your application, the default value is 360 minutes (6 hours). The valid range is from 15 to 720."}},"type":"object"},"aws-native:emrserverless:ApplicationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 128 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:emrserverless:ApplicationWorkerConfiguration":{"properties":{"cpu":{"type":"string","description":"Per worker CPU resource. vCPU is the only supported unit and specifying vCPU is optional."},"disk":{"type":"string","description":"Per worker Disk resource. GB is the only supported unit and specifying GB is optional"},"diskType":{"type":"string","description":"Per worker DiskType resource. Shuffle optimized and Standard are only supported types and specifying diskType is optional"},"memory":{"type":"string","description":"Per worker memory resource. GB is the only supported unit and specifying GB is optional."}},"type":"object","required":["cpu","memory"]},"aws-native:emrserverless:ApplicationWorkerTypeSpecificationInput":{"description":"The specifications for a worker type.","properties":{"imageConfiguration":{"$ref":"#/types/aws-native:emrserverless:ApplicationImageConfigurationInput","description":"The image configuration for a worker type."}},"type":"object"},"aws-native:entityresolution:IdMappingWorkflowIdMappingIncrementalRunConfig":{"properties":{"incrementalRunType":{"$ref":"#/types/aws-native:entityresolution:IdMappingWorkflowIdMappingIncrementalRunConfigIncrementalRunType"}},"type":"object","required":["incrementalRunType"]},"aws-native:entityresolution:IdMappingWorkflowIdMappingIncrementalRunConfigIncrementalRunType":{"type":"string","enum":[{"name":"OnDemand","value":"ON_DEMAND"}]},"aws-native:entityresolution:IdMappingWorkflowIdMappingRuleBasedProperties":{"properties":{"attributeMatchingModel":{"$ref":"#/types/aws-native:entityresolution:IdMappingWorkflowIdMappingRuleBasedPropertiesAttributeMatchingModel","description":"The comparison type. You can either choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` .\n\nIf you choose `ONE_TO_ONE` , the system can only match attributes if the sub-types are an exact match. For example, for the `Email` attribute type, the system will only consider it a match if the value of the `Email` field of Profile A matches the value of the `Email` field of Profile B.\n\nIf you choose `MANY_TO_MANY` , the system can match attributes across the sub-types of an attribute type. For example, if the value of the `Email` field of Profile A matches the value of the `BusinessEmail` field of Profile B, the two profiles are matched on the `Email` attribute type."},"recordMatchingModel":{"$ref":"#/types/aws-native:entityresolution:IdMappingWorkflowIdMappingRuleBasedPropertiesRecordMatchingModel","description":"The type of matching record that is allowed to be used in an ID mapping workflow.\n\nIf the value is set to `ONE_SOURCE_TO_ONE_TARGET` , only one record in the source can be matched to the same record in the target.\n\nIf the value is set to `MANY_SOURCE_TO_ONE_TARGET` , multiple records in the source can be matched to one record in the target."},"ruleDefinitionType":{"$ref":"#/types/aws-native:entityresolution:IdMappingWorkflowIdMappingRuleBasedPropertiesRuleDefinitionType","description":"The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible."},"rules":{"type":"array","items":{"$ref":"#/types/aws-native:entityresolution:IdMappingWorkflowRule"},"description":"The rules that can be used for ID mapping."}},"type":"object","required":["attributeMatchingModel","recordMatchingModel"]},"aws-native:entityresolution:IdMappingWorkflowIdMappingRuleBasedPropertiesAttributeMatchingModel":{"description":"The comparison type. You can either choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` .\n\nIf you choose `ONE_TO_ONE` , the system can only match attributes if the sub-types are an exact match. For example, for the `Email` attribute type, the system will only consider it a match if the value of the `Email` field of Profile A matches the value of the `Email` field of Profile B.\n\nIf you choose `MANY_TO_MANY` , the system can match attributes across the sub-types of an attribute type. For example, if the value of the `Email` field of Profile A matches the value of the `BusinessEmail` field of Profile B, the two profiles are matched on the `Email` attribute type.","type":"string","enum":[{"name":"OneToOne","value":"ONE_TO_ONE"},{"name":"ManyToMany","value":"MANY_TO_MANY"}]},"aws-native:entityresolution:IdMappingWorkflowIdMappingRuleBasedPropertiesRecordMatchingModel":{"description":"The type of matching record that is allowed to be used in an ID mapping workflow.\n\nIf the value is set to `ONE_SOURCE_TO_ONE_TARGET` , only one record in the source can be matched to the same record in the target.\n\nIf the value is set to `MANY_SOURCE_TO_ONE_TARGET` , multiple records in the source can be matched to one record in the target.","type":"string","enum":[{"name":"OneSourceToOneTarget","value":"ONE_SOURCE_TO_ONE_TARGET"},{"name":"ManySourceToOneTarget","value":"MANY_SOURCE_TO_ONE_TARGET"}]},"aws-native:entityresolution:IdMappingWorkflowIdMappingRuleBasedPropertiesRuleDefinitionType":{"description":"The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible.","type":"string","enum":[{"name":"Source","value":"SOURCE"},{"name":"Target","value":"TARGET"}]},"aws-native:entityresolution:IdMappingWorkflowIdMappingTechniques":{"properties":{"idMappingType":{"$ref":"#/types/aws-native:entityresolution:IdMappingWorkflowIdMappingTechniquesIdMappingType","description":"The type of ID mapping."},"normalizationVersion":{"type":"string"},"providerProperties":{"$ref":"#/types/aws-native:entityresolution:IdMappingWorkflowProviderProperties","description":"An object which defines any additional configurations required by the provider service."},"ruleBasedProperties":{"$ref":"#/types/aws-native:entityresolution:IdMappingWorkflowIdMappingRuleBasedProperties","description":"An object which defines any additional configurations required by rule-based matching."}},"type":"object"},"aws-native:entityresolution:IdMappingWorkflowIdMappingTechniquesIdMappingType":{"description":"The type of ID mapping.","type":"string","enum":[{"name":"Provider","value":"PROVIDER"},{"name":"RuleBased","value":"RULE_BASED"}]},"aws-native:entityresolution:IdMappingWorkflowInputSource":{"properties":{"inputSourceArn":{"type":"string","description":"An Glue table ARN for the input source table, MatchingWorkflow arn or IdNamespace ARN"},"schemaArn":{"type":"string","description":"The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the `SchemaMapping` ."},"type":{"$ref":"#/types/aws-native:entityresolution:IdMappingWorkflowInputSourceType","description":"The type of ID namespace. There are two types: `SOURCE` and `TARGET` .\n\nThe `SOURCE` contains configurations for `sourceId` data that will be processed in an ID mapping workflow.\n\nThe `TARGET` contains a configuration of `targetId` which all `sourceIds` will resolve to."}},"type":"object","required":["inputSourceArn"]},"aws-native:entityresolution:IdMappingWorkflowInputSourceType":{"description":"The type of ID namespace. There are two types: `SOURCE` and `TARGET` .\n\nThe `SOURCE` contains configurations for `sourceId` data that will be processed in an ID mapping workflow.\n\nThe `TARGET` contains a configuration of `targetId` which all `sourceIds` will resolve to.","type":"string","enum":[{"name":"Source","value":"SOURCE"},{"name":"Target","value":"TARGET"}]},"aws-native:entityresolution:IdMappingWorkflowIntermediateSourceConfiguration":{"properties":{"intermediateS3Path":{"type":"string","description":"The s3 path that would be used to stage the intermediate data being generated during workflow execution."}},"type":"object","required":["intermediateS3Path"]},"aws-native:entityresolution:IdMappingWorkflowOutputSource":{"properties":{"kmsArn":{"type":"string","description":"Customer AWS  ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key."},"outputS3Path":{"type":"string","description":"The S3 path to which Entity Resolution will write the output table"}},"type":"object","required":["outputS3Path"]},"aws-native:entityresolution:IdMappingWorkflowProviderProperties":{"properties":{"intermediateSourceConfiguration":{"$ref":"#/types/aws-native:entityresolution:IdMappingWorkflowIntermediateSourceConfiguration","description":"The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently."},"providerConfiguration":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format"},"providerServiceArn":{"type":"string","description":"Arn of the Provider Service being used."}},"type":"object","required":["providerServiceArn"]},"aws-native:entityresolution:IdMappingWorkflowRule":{"properties":{"matchingKeys":{"type":"array","items":{"type":"string"},"description":"A list of `MatchingKeys` . The `MatchingKeys` must have been defined in the `SchemaMapping` . Two records are considered to match according to this rule if all of the `MatchingKeys` match."},"ruleName":{"type":"string","description":"A name for the matching rule."}},"type":"object","required":["matchingKeys","ruleName"]},"aws-native:entityresolution:IdMappingWorkflowTag":{"description":"A key-value pair to associate with a resource","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:entityresolution:IdNamespaceIdMappingWorkflowProperties":{"properties":{"idMappingType":{"$ref":"#/types/aws-native:entityresolution:IdNamespaceIdMappingWorkflowPropertiesIdMappingType","description":"The type of ID mapping."},"providerProperties":{"$ref":"#/types/aws-native:entityresolution:IdNamespaceNamespaceProviderProperties","description":"An object which defines any additional configurations required by the provider service."},"ruleBasedProperties":{"$ref":"#/types/aws-native:entityresolution:IdNamespaceNamespaceRuleBasedProperties","description":"An object which defines any additional configurations required by rule-based matching."}},"type":"object","required":["idMappingType"]},"aws-native:entityresolution:IdNamespaceIdMappingWorkflowPropertiesIdMappingType":{"description":"The type of ID mapping.","type":"string","enum":[{"name":"Provider","value":"PROVIDER"},{"name":"RuleBased","value":"RULE_BASED"}]},"aws-native:entityresolution:IdNamespaceInputSource":{"properties":{"inputSourceArn":{"type":"string","description":"An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table."},"schemaName":{"type":"string","description":"The name of the schema."}},"type":"object","required":["inputSourceArn"]},"aws-native:entityresolution:IdNamespaceNamespaceProviderProperties":{"properties":{"providerConfiguration":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format."},"providerServiceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the provider service."}},"type":"object","required":["providerServiceArn"]},"aws-native:entityresolution:IdNamespaceNamespaceRuleBasedProperties":{"properties":{"attributeMatchingModel":{"$ref":"#/types/aws-native:entityresolution:IdNamespaceNamespaceRuleBasedPropertiesAttributeMatchingModel","description":"The comparison type. You can either choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` .\n\nIf you choose `ONE_TO_ONE` , the system can only match attributes if the sub-types are an exact match. For example, for the `Email` attribute type, the system will only consider it a match if the value of the `Email` field of Profile A matches the value of the `Email` field of Profile B.\n\nIf you choose `MANY_TO_MANY` , the system can match attributes across the sub-types of an attribute type. For example, if the value of the `Email` field of Profile A matches the value of `BusinessEmail` field of Profile B, the two profiles are matched on the `Email` attribute type."},"recordMatchingModels":{"type":"array","items":{"$ref":"#/types/aws-native:entityresolution:IdNamespaceRecordMatchingModel"},"description":"The type of matching record that is allowed to be used in an ID mapping workflow.\n\nIf the value is set to `ONE_SOURCE_TO_ONE_TARGET` , only one record in the source is matched to one record in the target.\n\nIf the value is set to `MANY_SOURCE_TO_ONE_TARGET` , all matching records in the source are matched to one record in the target."},"ruleDefinitionTypes":{"type":"array","items":{"$ref":"#/types/aws-native:entityresolution:IdNamespaceRuleDefinitionType"},"description":"The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible."},"rules":{"type":"array","items":{"$ref":"#/types/aws-native:entityresolution:IdNamespaceRule"},"description":"The rules for the ID namespace."}},"type":"object"},"aws-native:entityresolution:IdNamespaceNamespaceRuleBasedPropertiesAttributeMatchingModel":{"description":"The comparison type. You can either choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` .\n\nIf you choose `ONE_TO_ONE` , the system can only match attributes if the sub-types are an exact match. For example, for the `Email` attribute type, the system will only consider it a match if the value of the `Email` field of Profile A matches the value of the `Email` field of Profile B.\n\nIf you choose `MANY_TO_MANY` , the system can match attributes across the sub-types of an attribute type. For example, if the value of the `Email` field of Profile A matches the value of `BusinessEmail` field of Profile B, the two profiles are matched on the `Email` attribute type.","type":"string","enum":[{"name":"OneToOne","value":"ONE_TO_ONE"},{"name":"ManyToMany","value":"MANY_TO_MANY"}]},"aws-native:entityresolution:IdNamespaceRecordMatchingModel":{"type":"string","enum":[{"name":"OneSourceToOneTarget","value":"ONE_SOURCE_TO_ONE_TARGET"},{"name":"ManySourceToOneTarget","value":"MANY_SOURCE_TO_ONE_TARGET"}]},"aws-native:entityresolution:IdNamespaceRule":{"properties":{"matchingKeys":{"type":"array","items":{"type":"string"},"description":"A list of `MatchingKeys` . The `MatchingKeys` must have been defined in the `SchemaMapping` . Two records are considered to match according to this rule if all of the `MatchingKeys` match."},"ruleName":{"type":"string","description":"A name for the matching rule."}},"type":"object","required":["matchingKeys","ruleName"]},"aws-native:entityresolution:IdNamespaceRuleDefinitionType":{"type":"string","enum":[{"name":"Source","value":"SOURCE"},{"name":"Target","value":"TARGET"}]},"aws-native:entityresolution:IdNamespaceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:entityresolution:IdNamespaceType":{"description":"The type of ID namespace. There are two types: `SOURCE` and `TARGET` .\n\nThe `SOURCE` contains configurations for `sourceId` data that will be processed in an ID mapping workflow.\n\nThe `TARGET` contains a configuration of `targetId` which all `sourceIds` will resolve to.","type":"string","enum":[{"name":"Source","value":"SOURCE"},{"name":"Target","value":"TARGET"}]},"aws-native:entityresolution:MatchingWorkflowCustomerProfilesIntegrationConfig":{"properties":{"domainArn":{"type":"string"},"objectTypeArn":{"type":"string"}},"type":"object","required":["domainArn","objectTypeArn"]},"aws-native:entityresolution:MatchingWorkflowIncrementalRunConfig":{"properties":{"incrementalRunType":{"$ref":"#/types/aws-native:entityresolution:MatchingWorkflowIncrementalRunConfigIncrementalRunType","description":"The type of incremental run. The only valid value is `IMMEDIATE` . This appears as \"Automatic\" in the console.\n\n\u003e For workflows where `resolutionType` is `ML_MATCHING` or `PROVIDER` , incremental processing is not supported."}},"type":"object","required":["incrementalRunType"]},"aws-native:entityresolution:MatchingWorkflowIncrementalRunConfigIncrementalRunType":{"description":"The type of incremental run. The only valid value is `IMMEDIATE` . This appears as \"Automatic\" in the console.\n\n\u003e For workflows where `resolutionType` is `ML_MATCHING` or `PROVIDER` , incremental processing is not supported.","type":"string","enum":[{"name":"Immediate","value":"IMMEDIATE"}]},"aws-native:entityresolution:MatchingWorkflowInputSource":{"properties":{"applyNormalization":{"type":"boolean","description":"Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an `AttributeType` of `PHONE_NUMBER` , and the data in the input table is in a format of 1234567890, AWS Entity Resolution will normalize this field in the output to (123)-456-7890."},"inputSourceArn":{"type":"string","description":"An Glue table ARN for the input source table"},"schemaArn":{"type":"string","description":"The name of the schema."}},"type":"object","required":["inputSourceArn","schemaArn"]},"aws-native:entityresolution:MatchingWorkflowIntermediateSourceConfiguration":{"properties":{"intermediateS3Path":{"type":"string","description":"The s3 path that would be used to stage the intermediate data being generated during workflow execution."}},"type":"object","required":["intermediateS3Path"]},"aws-native:entityresolution:MatchingWorkflowOutputAttribute":{"properties":{"hashed":{"type":"boolean","description":"Enables the ability to hash the column values in the output."},"name":{"type":"string","description":"A name of a column to be written to the output. This must be an `InputField` name in the schema mapping."}},"type":"object","required":["name"]},"aws-native:entityresolution:MatchingWorkflowOutputSource":{"properties":{"applyNormalization":{"type":"boolean","description":"Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an `AttributeType` of `PHONE_NUMBER` , and the data in the input table is in a format of 1234567890, AWS Entity Resolution will normalize this field in the output to (123)-456-7890."},"customerProfilesIntegrationConfig":{"$ref":"#/types/aws-native:entityresolution:MatchingWorkflowCustomerProfilesIntegrationConfig"},"kmsArn":{"type":"string","description":"Customer KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key."},"output":{"type":"array","items":{"$ref":"#/types/aws-native:entityresolution:MatchingWorkflowOutputAttribute"},"description":"A list of `OutputAttribute` objects, each of which have the fields `Name` and `Hashed` . Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed."},"outputS3Path":{"type":"string","description":"The S3 path to which Entity Resolution will write the output table"}},"type":"object","required":["output"]},"aws-native:entityresolution:MatchingWorkflowProviderProperties":{"properties":{"intermediateSourceConfiguration":{"$ref":"#/types/aws-native:entityresolution:MatchingWorkflowIntermediateSourceConfiguration","description":"The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently."},"providerConfiguration":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional Provider configuration that would be required for the provider service. The Configuration must be in JSON string format"},"providerServiceArn":{"type":"string","description":"Arn of the Provider service being used."}},"type":"object","required":["providerServiceArn"]},"aws-native:entityresolution:MatchingWorkflowResolutionTechniques":{"properties":{"providerProperties":{"$ref":"#/types/aws-native:entityresolution:MatchingWorkflowProviderProperties","description":"The properties of the provider service."},"resolutionType":{"$ref":"#/types/aws-native:entityresolution:MatchingWorkflowResolutionType","description":"The type of matching workflow to create. Specify one of the following types:\n\n- `RULE_MATCHING` : Match records using configurable rule-based criteria\n- `ML_MATCHING` : Match records using machine learning models\n- `PROVIDER` : Match records using a third-party matching provider"},"ruleBasedProperties":{"$ref":"#/types/aws-native:entityresolution:MatchingWorkflowRuleBasedProperties","description":"An object which defines the list of matching rules to run and has a field `rules` , which is a list of rule objects."},"ruleConditionProperties":{"$ref":"#/types/aws-native:entityresolution:MatchingWorkflowRuleConditionProperties","description":"An object containing the `rules` for a matching workflow."}},"type":"object"},"aws-native:entityresolution:MatchingWorkflowResolutionType":{"type":"string","enum":[{"name":"RuleMatching","value":"RULE_MATCHING"},{"name":"MlMatching","value":"ML_MATCHING"},{"name":"Provider","value":"PROVIDER"}]},"aws-native:entityresolution:MatchingWorkflowRule":{"properties":{"matchingKeys":{"type":"array","items":{"type":"string"},"description":"A list of `MatchingKeys` . The `MatchingKeys` must have been defined in the `SchemaMapping` . Two records are considered to match according to this rule if all of the `MatchingKeys` match."},"ruleName":{"type":"string","description":"A name for the matching rule."}},"type":"object","required":["matchingKeys","ruleName"]},"aws-native:entityresolution:MatchingWorkflowRuleBasedProperties":{"properties":{"attributeMatchingModel":{"$ref":"#/types/aws-native:entityresolution:MatchingWorkflowRuleBasedPropertiesAttributeMatchingModel","description":"The comparison type. You can choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` .\n\nIf you choose `ONE_TO_ONE` , the system can only match attributes if the sub-types are an exact match. For example, for the `Email` attribute type, the system will only consider it a match if the value of the `Email` field of Profile A matches the value of the `Email` field of Profile B.\n\nIf you choose `MANY_TO_MANY` , the system can match attributes across the sub-types of an attribute type. For example, if the value of the `Email` field of Profile A and the value of `BusinessEmail` field of Profile B matches, the two profiles are matched on the `Email` attribute type."},"matchPurpose":{"$ref":"#/types/aws-native:entityresolution:MatchingWorkflowRuleBasedPropertiesMatchPurpose","description":"An indicator of whether to generate IDs and index the data or not.\n\nIf you choose `IDENTIFIER_GENERATION` , the process generates IDs and indexes the data.\n\nIf you choose `INDEXING` , the process indexes the data without generating IDs."},"rules":{"type":"array","items":{"$ref":"#/types/aws-native:entityresolution:MatchingWorkflowRule"},"description":"A list of `Rule` objects, each of which have fields `RuleName` and `MatchingKeys` ."}},"type":"object","required":["attributeMatchingModel","rules"]},"aws-native:entityresolution:MatchingWorkflowRuleBasedPropertiesAttributeMatchingModel":{"description":"The comparison type. You can choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` .\n\nIf you choose `ONE_TO_ONE` , the system can only match attributes if the sub-types are an exact match. For example, for the `Email` attribute type, the system will only consider it a match if the value of the `Email` field of Profile A matches the value of the `Email` field of Profile B.\n\nIf you choose `MANY_TO_MANY` , the system can match attributes across the sub-types of an attribute type. For example, if the value of the `Email` field of Profile A and the value of `BusinessEmail` field of Profile B matches, the two profiles are matched on the `Email` attribute type.","type":"string","enum":[{"name":"OneToOne","value":"ONE_TO_ONE"},{"name":"ManyToMany","value":"MANY_TO_MANY"}]},"aws-native:entityresolution:MatchingWorkflowRuleBasedPropertiesMatchPurpose":{"description":"An indicator of whether to generate IDs and index the data or not.\n\nIf you choose `IDENTIFIER_GENERATION` , the process generates IDs and indexes the data.\n\nIf you choose `INDEXING` , the process indexes the data without generating IDs.","type":"string","enum":[{"name":"IdentifierGeneration","value":"IDENTIFIER_GENERATION"},{"name":"Indexing","value":"INDEXING"}]},"aws-native:entityresolution:MatchingWorkflowRuleCondition":{"properties":{"condition":{"type":"string","description":"A statement that specifies the conditions for a matching rule.\n\nIf your data is accurate, use an Exact matching function: `Exact` or `ExactManyToMany` .\n\nIf your data has variations in spelling or pronunciation, use a Fuzzy matching function: `Cosine` , `Levenshtein` , or `Soundex` .\n\nUse operators if you want to combine ( `AND` ), separate ( `OR` ), or group matching functions `(...)` .\n\nFor example: `(Cosine(a, 10) AND Exact(b, true)) OR ExactManyToMany(c, d)`"},"ruleName":{"type":"string","description":"A name for the matching rule.\n\nFor example: `Rule1`"}},"type":"object"},"aws-native:entityresolution:MatchingWorkflowRuleConditionProperties":{"properties":{"rules":{"type":"array","items":{"$ref":"#/types/aws-native:entityresolution:MatchingWorkflowRuleCondition"},"description":"A list of rule objects, each of which have fields `ruleName` and `condition` ."}},"type":"object","required":["rules"]},"aws-native:entityresolution:MatchingWorkflowTag":{"description":"A key-value pair to associate with a resource","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:entityresolution:PolicyStatementStatementEffect":{"type":"string","enum":[{"name":"Allow","value":"Allow"},{"name":"Deny","value":"Deny"}]},"aws-native:entityresolution:SchemaMappingSchemaAttributeType":{"type":"string","enum":[{"name":"Name","value":"NAME"},{"name":"NameFirst","value":"NAME_FIRST"},{"name":"NameMiddle","value":"NAME_MIDDLE"},{"name":"NameLast","value":"NAME_LAST"},{"name":"Address","value":"ADDRESS"},{"name":"AddressStreet1","value":"ADDRESS_STREET1"},{"name":"AddressStreet2","value":"ADDRESS_STREET2"},{"name":"AddressStreet3","value":"ADDRESS_STREET3"},{"name":"AddressCity","value":"ADDRESS_CITY"},{"name":"AddressState","value":"ADDRESS_STATE"},{"name":"AddressCountry","value":"ADDRESS_COUNTRY"},{"name":"AddressPostalcode","value":"ADDRESS_POSTALCODE"},{"name":"Phone","value":"PHONE"},{"name":"PhoneNumber","value":"PHONE_NUMBER"},{"name":"PhoneCountrycode","value":"PHONE_COUNTRYCODE"},{"name":"EmailAddress","value":"EMAIL_ADDRESS"},{"name":"UniqueId","value":"UNIQUE_ID"},{"name":"Date","value":"DATE"},{"name":"String","value":"STRING"},{"name":"ProviderId","value":"PROVIDER_ID"}]},"aws-native:entityresolution:SchemaMappingSchemaInputAttribute":{"properties":{"fieldName":{"type":"string"},"groupName":{"type":"string"},"hashed":{"type":"boolean"},"matchKey":{"type":"string"},"subType":{"type":"string","description":"The subtype of the Attribute. Would be required only when type is PROVIDER_ID"},"type":{"$ref":"#/types/aws-native:entityresolution:SchemaMappingSchemaAttributeType"}},"type":"object","required":["fieldName","type"]},"aws-native:entityresolution:SchemaMappingTag":{"description":"A key-value pair to associate with a resource","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:events:ApiDestinationHttpMethod":{"description":"The method to use for the request to the HTTP invocation endpoint.","type":"string","enum":[{"name":"Get","value":"GET"},{"name":"Head","value":"HEAD"},{"name":"Post","value":"POST"},{"name":"Options","value":"OPTIONS"},{"name":"Put","value":"PUT"},{"name":"Delete","value":"DELETE"},{"name":"Patch","value":"PATCH"}]},"aws-native:events:ConnectionApiKeyAuthParameters":{"properties":{"apiKeyName":{"type":"string","description":"The name of the API key to use for authorization."},"apiKeyValue":{"type":"string","description":"The value for the API key to use for authorization."}},"type":"object","required":["apiKeyName","apiKeyValue"]},"aws-native:events:ConnectionAuthParameters":{"properties":{"apiKeyAuthParameters":{"$ref":"#/types/aws-native:events:ConnectionApiKeyAuthParameters","description":"The API Key parameters to use for authorization."},"basicAuthParameters":{"$ref":"#/types/aws-native:events:ConnectionBasicAuthParameters","description":"The authorization parameters for Basic authorization."},"connectivityParameters":{"$ref":"#/types/aws-native:events:ConnectionConnectivityParameters","description":"For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.\n\nFor more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the **Amazon EventBridge User Guide** ."},"invocationHttpParameters":{"$ref":"#/types/aws-native:events:ConnectionHttpParameters","description":"Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint."},"oAuthParameters":{"$ref":"#/types/aws-native:events:ConnectionOAuthParameters","description":"The OAuth parameters to use for authorization."}},"type":"object"},"aws-native:events:ConnectionAuthorizationType":{"description":"The type of authorization to use for the connection.\n\n\u003e OAUTH tokens are refreshed when a 401 or 407 response is returned.","type":"string","enum":[{"name":"ApiKey","value":"API_KEY"},{"name":"Basic","value":"BASIC"},{"name":"OauthClientCredentials","value":"OAUTH_CLIENT_CREDENTIALS"}]},"aws-native:events:ConnectionBasicAuthParameters":{"properties":{"password":{"type":"string","description":"The password associated with the user name to use for Basic authorization."},"username":{"type":"string","description":"The user name to use for Basic authorization."}},"type":"object","required":["password","username"]},"aws-native:events:ConnectionClientParameters":{"properties":{"clientId":{"type":"string","description":"The client ID to use for OAuth authorization."},"clientSecret":{"type":"string","description":"The client secret assciated with the client ID to use for OAuth authorization."}},"type":"object","required":["clientId","clientSecret"]},"aws-native:events:ConnectionConnectivityParameters":{"properties":{"resourceParameters":{"$ref":"#/types/aws-native:events:ConnectionResourceParameters","description":"The parameters for EventBridge to use when invoking the resource endpoint."}},"type":"object","required":["resourceParameters"]},"aws-native:events:ConnectionHttpParameters":{"properties":{"bodyParameters":{"type":"array","items":{"$ref":"#/types/aws-native:events:ConnectionParameter"},"description":"Any additional body string parameters for the connection."},"headerParameters":{"type":"array","items":{"$ref":"#/types/aws-native:events:ConnectionParameter"},"description":"Any additional header parameters for the connection."},"queryStringParameters":{"type":"array","items":{"$ref":"#/types/aws-native:events:ConnectionParameter"},"description":"Any additional query string parameters for the connection."}},"type":"object"},"aws-native:events:ConnectionOAuthParameters":{"properties":{"authorizationEndpoint":{"type":"string","description":"The URL to the authorization endpoint when OAuth is specified as the authorization type."},"clientParameters":{"$ref":"#/types/aws-native:events:ConnectionClientParameters","description":"The client parameters for OAuth authorization."},"httpMethod":{"$ref":"#/types/aws-native:events:ConnectionOAuthParametersHttpMethod","description":"The method to use for the authorization request."},"oAuthHttpParameters":{"$ref":"#/types/aws-native:events:ConnectionHttpParameters","description":"Details about the additional parameters to use for the connection."}},"type":"object","required":["authorizationEndpoint","clientParameters","httpMethod"]},"aws-native:events:ConnectionOAuthParametersHttpMethod":{"description":"The method to use for the authorization request.","type":"string","enum":[{"name":"Get","value":"GET"},{"name":"Post","value":"POST"},{"name":"Put","value":"PUT"}]},"aws-native:events:ConnectionParameter":{"properties":{"isValueSecret":{"type":"boolean","description":"Specifies whether the value is secret."},"key":{"type":"string","description":"The key for a query string parameter."},"value":{"type":"string","description":"The value associated with the key for the query string parameter."}},"type":"object","required":["key","value"]},"aws-native:events:ConnectionResourceParameters":{"properties":{"resourceAssociationArn":{"type":"string","description":"For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.\n\n\u003e The value of this property is set by EventBridge . Any value you specify in your template is ignored."},"resourceConfigurationArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint."}},"type":"object","required":["resourceConfigurationArn"]},"aws-native:events:DeadLetterConfigProperties":{"description":"Dead Letter Queue for the event bus.","properties":{"arn":{"type":"string","description":"The ARN of the SQS queue specified as the target for the dead-letter queue."}},"type":"object"},"aws-native:events:EndpointEventBus":{"properties":{"eventBusArn":{"type":"string"}},"type":"object","required":["eventBusArn"]},"aws-native:events:EndpointFailoverConfig":{"properties":{"primary":{"$ref":"#/types/aws-native:events:EndpointPrimary","description":"The main Region of the endpoint."},"secondary":{"$ref":"#/types/aws-native:events:EndpointSecondary","description":"The Region that events are routed to when failover is triggered or event replication is enabled."}},"type":"object","required":["primary","secondary"]},"aws-native:events:EndpointPrimary":{"properties":{"healthCheck":{"type":"string","description":"The ARN of the health check used by the endpoint to determine whether failover is triggered."}},"type":"object","required":["healthCheck"]},"aws-native:events:EndpointReplicationConfig":{"properties":{"state":{"$ref":"#/types/aws-native:events:EndpointReplicationState","description":"The state of event replication."}},"type":"object","required":["state"]},"aws-native:events:EndpointReplicationState":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:events:EndpointRoutingConfig":{"properties":{"failoverConfig":{"$ref":"#/types/aws-native:events:EndpointFailoverConfig","description":"The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered."}},"type":"object","required":["failoverConfig"]},"aws-native:events:EndpointSecondary":{"properties":{"route":{"type":"string","description":"Defines the secondary Region."}},"type":"object","required":["route"]},"aws-native:events:EndpointState":{"description":"The main Region of the endpoint.","type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Creating","value":"CREATING"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"UpdateFailed","value":"UPDATE_FAILED"}]},"aws-native:events:EventBusLogConfigPropertiesIncludeDetail":{"description":"Configures whether or not to include event detail, input transformer details, target properties, and target input in the applicable log messages.","type":"string","enum":[{"name":"Full","value":"FULL"},{"name":"None","value":"NONE"}]},"aws-native:events:EventBusLogConfigPropertiesLevel":{"description":"Configures the log level of the EventBus and determines which log messages are sent to Ingestion Hub for delivery.","type":"string","enum":[{"name":"Info","value":"INFO"},{"name":"Error","value":"ERROR"},{"name":"Trace","value":"TRACE"},{"name":"Off","value":"OFF"}]},"aws-native:events:EventBusPolicyCondition":{"description":"This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization.","properties":{"key":{"type":"string","description":"Specifies the value for the key. Currently, this must be the ID of the organization."},"type":{"type":"string","description":"Specifies the type of condition. Currently the only supported value is StringEquals."},"value":{"type":"string","description":"Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID."}},"type":"object"},"aws-native:events:EventBusTag":{"properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object","required":["key","value"]},"aws-native:events:InvocationConnectivityParametersProperties":{"description":"The private resource the HTTP request will be sent to.","properties":{"resourceParameters":{"$ref":"#/types/aws-native:events:ConnectionResourceParameters","description":"The parameters for EventBridge to use when invoking the resource endpoint."}},"type":"object","required":["resourceParameters"]},"aws-native:events:LogConfigProperties":{"description":"The logging configuration settings for vended logs.","properties":{"includeDetail":{"$ref":"#/types/aws-native:events:EventBusLogConfigPropertiesIncludeDetail","description":"Configures whether or not to include event detail, input transformer details, target properties, and target input in the applicable log messages."},"level":{"$ref":"#/types/aws-native:events:EventBusLogConfigPropertiesLevel","description":"Configures the log level of the EventBus and determines which log messages are sent to Ingestion Hub for delivery."}},"type":"object"},"aws-native:events:RuleAppSyncParameters":{"properties":{"graphQlOperation":{"type":"string","description":"The GraphQL operation; that is, the query, mutation, or subscription to be parsed and executed by the GraphQL service.\n\nFor more information, see [Operations](https://docs.aws.amazon.com/appsync/latest/devguide/graphql-architecture.html#graphql-operations) in the *AWS AppSync User Guide* ."}},"type":"object","required":["graphQlOperation"]},"aws-native:events:RuleAwsVpcConfiguration":{"properties":{"assignPublicIp":{"type":"string","description":"Specifies whether the task's elastic network interface receives a public IP address. You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE` ."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used."},"subnets":{"type":"array","items":{"type":"string"},"description":"Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets."}},"type":"object","required":["subnets"]},"aws-native:events:RuleBatchArrayProperties":{"properties":{"size":{"type":"integer","description":"The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000."}},"type":"object"},"aws-native:events:RuleBatchParameters":{"properties":{"arrayProperties":{"$ref":"#/types/aws-native:events:RuleBatchArrayProperties","description":"The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job."},"jobDefinition":{"type":"string","description":"The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist."},"jobName":{"type":"string","description":"The name to use for this execution of the job, if the target is an AWS Batch job."},"retryStrategy":{"$ref":"#/types/aws-native:events:RuleBatchRetryStrategy","description":"The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition."}},"type":"object","required":["jobDefinition","jobName"]},"aws-native:events:RuleBatchRetryStrategy":{"properties":{"attempts":{"type":"integer","description":"The number of times to attempt to retry, if the job fails. Valid values are 1–10."}},"type":"object"},"aws-native:events:RuleCapacityProviderStrategyItem":{"properties":{"base":{"type":"integer","description":"The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used."},"capacityProvider":{"type":"string","description":"The short name of the capacity provider."},"weight":{"type":"integer","description":"The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied."}},"type":"object","required":["capacityProvider"]},"aws-native:events:RuleDeadLetterConfig":{"properties":{"arn":{"type":"string","description":"The ARN of the SQS queue specified as the target for the dead-letter queue."}},"type":"object"},"aws-native:events:RuleEcsParameters":{"properties":{"capacityProviderStrategy":{"type":"array","items":{"$ref":"#/types/aws-native:events:RuleCapacityProviderStrategyItem"},"description":"The capacity provider strategy to use for the task.\n\nIf a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted. If no `capacityProviderStrategy` or launchType is specified, the `defaultCapacityProviderStrategy` for the cluster is used."},"enableEcsManagedTags":{"type":"boolean","description":"Specifies whether to enable Amazon ECS managed tags for the task. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon Elastic Container Service Developer Guide."},"enableExecuteCommand":{"type":"boolean","description":"Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task."},"group":{"type":"string","description":"Specifies an ECS task group for the task. The maximum length is 255 characters."},"launchType":{"type":"string","description":"Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The `FARGATE` value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see [AWS Fargate on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) in the *Amazon Elastic Container Service Developer Guide* ."},"networkConfiguration":{"$ref":"#/types/aws-native:events:RuleNetworkConfiguration","description":"Use this structure if the Amazon ECS task uses the `awsvpc` network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if `LaunchType` is `FARGATE` because the `awsvpc` mode is required for Fargate tasks.\n\nIf you specify `NetworkConfiguration` when the target ECS task does not use the `awsvpc` network mode, the task fails."},"placementConstraints":{"type":"array","items":{"$ref":"#/types/aws-native:events:RulePlacementConstraint"},"description":"An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime)."},"placementStrategies":{"type":"array","items":{"$ref":"#/types/aws-native:events:RulePlacementStrategy"},"description":"The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task."},"platformVersion":{"type":"string","description":"Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as `1.1.0` .\n\nThis structure is used only if `LaunchType` is `FARGATE` . For more information about valid platform versions, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* ."},"propagateTags":{"type":"string","description":"Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action."},"referenceId":{"type":"string","description":"The reference ID to use for the task."},"tagList":{"type":"array","items":{"$ref":"#/types/aws-native:events:RuleTag"},"description":"The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) in the Amazon ECS API Reference."},"taskCount":{"type":"integer","description":"The number of tasks to create based on `TaskDefinition` . The default is 1."},"taskDefinitionArn":{"type":"string","description":"The ARN of the task definition to use if the event target is an Amazon ECS task."}},"type":"object","required":["taskDefinitionArn"]},"aws-native:events:RuleHttpParameters":{"properties":{"headerParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination."},"pathParameterValues":{"type":"array","items":{"type":"string"},"description":"The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards (\"*\")."},"queryStringParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination."}},"type":"object"},"aws-native:events:RuleInputTransformer":{"properties":{"inputPathsMap":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of JSON paths to be extracted from the event. You can then insert these in the template in `InputTemplate` to produce the output you want to be sent to the target.\n\n`InputPathsMap` is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.\n\nThe keys cannot start with \" AWS .\""},"inputTemplate":{"type":"string","description":"Input template where you specify placeholders that will be filled with the values of the keys from `InputPathsMap` to customize the data sent to the target. Enclose each `InputPathsMaps` value in brackets: \u003c *value* \u003e\n\nIf `InputTemplate` is a JSON object (surrounded by curly braces), the following restrictions apply:\n\n- The placeholder cannot be used as an object key.\n\nThe following example shows the syntax for using `InputPathsMap` and `InputTemplate` .\n\n`\"InputTransformer\":`\n\n`{`\n\n`\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},`\n\n`\"InputTemplate\": \"\u003cinstance\u003e is in state \u003cstatus\u003e\"`\n\n`}`\n\nTo have the `InputTemplate` include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:\n\n`\"InputTransformer\":`\n\n`{`\n\n`\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},`\n\n`\"InputTemplate\": \"\u003cinstance\u003e is in state \\\"\u003cstatus\u003e\\\"\"`\n\n`}`\n\nThe `InputTemplate` can also be valid JSON with varibles in quotes or out, as in the following example:\n\n`\"InputTransformer\":`\n\n`{`\n\n`\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},`\n\n`\"InputTemplate\": '{\"myInstance\": \u003cinstance\u003e,\"myStatus\": \"\u003cinstance\u003e is in state \\\"\u003cstatus\u003e\\\"\"}'`\n\n`}`"}},"type":"object","required":["inputTemplate"]},"aws-native:events:RuleKinesisParameters":{"properties":{"partitionKeyPath":{"type":"string","description":"The JSON path to be extracted from the event and used as the partition key. For more information, see [Amazon Kinesis Streams Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key) in the *Amazon Kinesis Streams Developer Guide* ."}},"type":"object","required":["partitionKeyPath"]},"aws-native:events:RuleNetworkConfiguration":{"properties":{"awsVpcConfiguration":{"$ref":"#/types/aws-native:events:RuleAwsVpcConfiguration","description":"Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the `awsvpc` network mode."}},"type":"object"},"aws-native:events:RulePlacementConstraint":{"properties":{"expression":{"type":"string","description":"A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is `distinctInstance` . To learn more, see [Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide."},"type":{"type":"string","description":"The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates."}},"type":"object"},"aws-native:events:RulePlacementStrategy":{"properties":{"field":{"type":"string","description":"The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used."},"type":{"type":"string","description":"The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task)."}},"type":"object"},"aws-native:events:RuleRedshiftDataParameters":{"properties":{"database":{"type":"string","description":"The name of the database. Required when authenticating using temporary credentials."},"dbUser":{"type":"string","description":"The database user name. Required when authenticating using temporary credentials."},"secretManagerArn":{"type":"string","description":"The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager."},"sql":{"type":"string","description":"The SQL statement text to run."},"sqls":{"type":"array","items":{"type":"string"},"description":"One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back."},"statementName":{"type":"string","description":"The name of the SQL statement. You can name the SQL statement when you create it to identify the query."},"withEvent":{"type":"boolean","description":"Indicates whether to send an event back to EventBridge after the SQL statement runs."}},"type":"object","required":["database"]},"aws-native:events:RuleRetryPolicy":{"properties":{"maximumEventAgeInSeconds":{"type":"integer","description":"The maximum amount of time, in seconds, to continue to make retry attempts."},"maximumRetryAttempts":{"type":"integer","description":"The maximum number of retry attempts to make before the request fails. Retry attempts continue until either the maximum number of attempts is made or until the duration of the `MaximumEventAgeInSeconds` is met."}},"type":"object"},"aws-native:events:RuleRunCommandParameters":{"properties":{"runCommandTargets":{"type":"array","items":{"$ref":"#/types/aws-native:events:RuleRunCommandTarget"},"description":"Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag."}},"type":"object","required":["runCommandTargets"]},"aws-native:events:RuleRunCommandTarget":{"properties":{"key":{"type":"string","description":"Can be either `tag:` *tag-key* or `InstanceIds` ."},"values":{"type":"array","items":{"type":"string"},"description":"If `Key` is `tag:` *tag-key* , `Values` is a list of tag values. If `Key` is `InstanceIds` , `Values` is a list of Amazon EC2 instance IDs."}},"type":"object","required":["key","values"]},"aws-native:events:RuleSageMakerPipelineParameter":{"properties":{"name":{"type":"string","description":"Name of parameter to start execution of a SageMaker AI Model Building Pipeline."},"value":{"type":"string","description":"Value of parameter to start execution of a SageMaker AI Model Building Pipeline."}},"type":"object","required":["name","value"]},"aws-native:events:RuleSageMakerPipelineParameters":{"properties":{"pipelineParameterList":{"type":"array","items":{"$ref":"#/types/aws-native:events:RuleSageMakerPipelineParameter"},"description":"List of Parameter names and values for SageMaker AI Model Building Pipeline execution."}},"type":"object"},"aws-native:events:RuleSqsParameters":{"properties":{"messageGroupId":{"type":"string","description":"The ID of the message group to use as the target."}},"type":"object","required":["messageGroupId"]},"aws-native:events:RuleState":{"description":"The state of the rule.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"},{"name":"EnabledWithAllCloudtrailManagementEvents","value":"ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS"}]},"aws-native:events:RuleTag":{"properties":{"key":{"type":"string","description":"A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."},"value":{"type":"string","description":"The value for the specified tag key."}},"type":"object"},"aws-native:events:RuleTarget":{"properties":{"appSyncParameters":{"$ref":"#/types/aws-native:events:RuleAppSyncParameters","description":"Contains the GraphQL operation to be parsed and executed, if the event target is an AWS AppSync API."},"arn":{"type":"string","description":"The Amazon Resource Name (ARN) of the target."},"batchParameters":{"$ref":"#/types/aws-native:events:RuleBatchParameters","description":"If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see [Jobs](https://docs.aws.amazon.com/batch/latest/userguide/jobs.html) in the *AWS Batch User Guide* ."},"deadLetterConfig":{"$ref":"#/types/aws-native:events:RuleDeadLetterConfig","description":"The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to."},"ecsParameters":{"$ref":"#/types/aws-native:events:RuleEcsParameters","description":"Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see [Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon EC2 Container Service Developer Guide* ."},"httpParameters":{"$ref":"#/types/aws-native:events:RuleHttpParameters","description":"Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.\n\nIf you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence."},"id":{"type":"string","description":"The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string."},"input":{"type":"string","description":"Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format](https://docs.aws.amazon.com/http://www.rfc-editor.org/rfc/rfc7159.txt) ."},"inputPath":{"type":"string","description":"The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You may use JSON dot notation or bracket notation. For more information about JSON paths, see [JSONPath](https://docs.aws.amazon.com/http://goessner.net/articles/JsonPath/) ."},"inputTransformer":{"$ref":"#/types/aws-native:events:RuleInputTransformer","description":"Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target."},"kinesisParameters":{"$ref":"#/types/aws-native:events:RuleKinesisParameters","description":"The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the `eventId` as the partition key."},"redshiftDataParameters":{"$ref":"#/types/aws-native:events:RuleRedshiftDataParameters","description":"Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.\n\nIf you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events."},"retryPolicy":{"$ref":"#/types/aws-native:events:RuleRetryPolicy","description":"The retry policy configuration to use for the dead-letter queue."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target."},"runCommandParameters":{"$ref":"#/types/aws-native:events:RuleRunCommandParameters","description":"Parameters used when you are using the rule to invoke Amazon EC2 Run Command."},"sageMakerPipelineParameters":{"$ref":"#/types/aws-native:events:RuleSageMakerPipelineParameters","description":"Contains the SageMaker AI Model Building Pipeline parameters to start execution of a SageMaker AI Model Building Pipeline.\n\nIf you specify a SageMaker AI Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events."},"sqsParameters":{"$ref":"#/types/aws-native:events:RuleSqsParameters","description":"Contains the message group ID to use when the target is an Amazon SQS fair or FIFO queue.\n\nIf you specify a fair or FIFO queue as a target, the queue must have content-based deduplication enabled."}},"type":"object","required":["arn","id"]},"aws-native:eventschemas:DiscovererTagsEntry":{"properties":{"key":{"type":"string","description":"The key of a key-value pair."},"value":{"type":"string","description":"The value of a key-value pair."}},"type":"object","required":["key","value"]},"aws-native:eventschemas:RegistryTagsEntry":{"properties":{"key":{"type":"string","description":"The key of a key-value pair."},"value":{"type":"string","description":"The value of a key-value pair."}},"type":"object","required":["key","value"]},"aws-native:eventschemas:SchemaTagsEntry":{"properties":{"key":{"type":"string","description":"The key of a key-value pair."},"value":{"type":"string","description":"The value of a key-value pair."}},"type":"object","required":["key","value"]},"aws-native:evidently:ExperimentMetricGoalObject":{"properties":{"desiredChange":{"$ref":"#/types/aws-native:evidently:ExperimentMetricGoalObjectDesiredChange","description":"`INCREASE` means that a variation with a higher number for this metric is performing better.\n\n`DECREASE` means that a variation with a lower number for this metric is performing better."},"entityIdKey":{"type":"string","description":"The JSON path to reference the entity id in the event."},"eventPattern":{"type":"string","description":"Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't."},"metricName":{"type":"string","description":"A name for the metric. It can include up to 255 characters."},"unitLabel":{"type":"string","description":"A label for the units that the metric is measuring."},"valueKey":{"type":"string","description":"The JSON path to reference the numerical metric value in the event."}},"type":"object","required":["desiredChange","entityIdKey","metricName","valueKey"]},"aws-native:evidently:ExperimentMetricGoalObjectDesiredChange":{"description":"`INCREASE` means that a variation with a higher number for this metric is performing better.\n\n`DECREASE` means that a variation with a lower number for this metric is performing better.","type":"string","enum":[{"name":"Increase","value":"INCREASE"},{"name":"Decrease","value":"DECREASE"}]},"aws-native:evidently:ExperimentOnlineAbConfigObject":{"properties":{"controlTreatmentName":{"type":"string","description":"The name of the variation that is to be the default variation that the other variations are compared to."},"treatmentWeights":{"type":"array","items":{"$ref":"#/types/aws-native:evidently:ExperimentTreatmentToWeight"},"description":"A set of key-value pairs. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation."}},"type":"object"},"aws-native:evidently:ExperimentRunningStatusObject":{"properties":{"analysisCompleteTime":{"type":"string","description":"Provide the analysis Completion time for an experiment"},"desiredState":{"type":"string","description":"Provide CANCELLED or COMPLETED desired state when stopping an experiment"},"reason":{"type":"string","description":"Reason is a required input for stopping the experiment"},"status":{"type":"string","description":"Provide START or STOP action to apply on an experiment"}},"type":"object"},"aws-native:evidently:ExperimentTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:evidently:ExperimentTreatmentObject":{"properties":{"description":{"type":"string","description":"The description of the treatment."},"feature":{"type":"string","description":"The name of the feature for this experiment."},"treatmentName":{"type":"string","description":"A name for this treatment. It can include up to 127 characters."},"variation":{"type":"string","description":"The name of the variation to use for this treatment."}},"type":"object","required":["feature","treatmentName","variation"]},"aws-native:evidently:ExperimentTreatmentToWeight":{"properties":{"splitWeight":{"type":"integer","description":"The portion of experiment traffic to allocate to this treatment. Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment."},"treatment":{"type":"string","description":"The name of the treatment."}},"type":"object","required":["splitWeight","treatment"]},"aws-native:evidently:FeatureEntityOverride":{"properties":{"entityId":{"type":"string","description":"The entity ID to be served the variation specified in `Variation` ."},"variation":{"type":"string","description":"The name of the variation to serve to the user session that matches the `EntityId` ."}},"type":"object"},"aws-native:evidently:FeatureEvaluationStrategy":{"description":"Specify `ALL_RULES` to activate the traffic allocation specified by any ongoing launches or experiments. Specify `DEFAULT_VARIATION` to serve the default variation to all users instead.","type":"string","enum":[{"name":"AllRules","value":"ALL_RULES"},{"name":"DefaultVariation","value":"DEFAULT_VARIATION"}]},"aws-native:evidently:FeatureTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:evidently:FeatureVariationObject":{"properties":{"booleanValue":{"type":"boolean","description":"The value assigned to this variation, if the variation type is boolean."},"doubleValue":{"type":"number","description":"The value assigned to this variation, if the variation type is a double."},"longValue":{"type":"number","description":"The value assigned to this variation, if the variation type is a long."},"stringValue":{"type":"string","description":"The value assigned to this variation, if the variation type is a string."},"variationName":{"type":"string","description":"A name for the variation. It can include up to 127 characters."}},"type":"object"},"aws-native:evidently:LaunchExecutionStatusObject":{"properties":{"desiredState":{"type":"string","description":"Provide CANCELLED or COMPLETED as the launch desired state. Defaults to Completed if not provided."},"reason":{"type":"string","description":"Provide a reason for stopping the launch. Defaults to empty if not provided."},"status":{"type":"string","description":"Provide START or STOP action to apply on a launch"}},"type":"object","required":["status"]},"aws-native:evidently:LaunchGroupObject":{"properties":{"description":{"type":"string","description":"A description of the launch group."},"feature":{"type":"string","description":"The feature that this launch is using."},"groupName":{"type":"string","description":"A name for this launch group. It can include up to 127 characters."},"variation":{"type":"string","description":"The feature variation to use for this launch group."}},"type":"object","required":["feature","groupName","variation"]},"aws-native:evidently:LaunchGroupToWeight":{"properties":{"groupName":{"type":"string","description":"The name of the launch group. It can include up to 127 characters."},"splitWeight":{"type":"integer","description":"The portion of launch traffic to allocate to this launch group.\n\nThis is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the launch audience to this launch group."}},"type":"object","required":["groupName","splitWeight"]},"aws-native:evidently:LaunchMetricDefinitionObject":{"properties":{"entityIdKey":{"type":"string","description":"The JSON path to reference the entity id in the event."},"eventPattern":{"type":"string","description":"Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't."},"metricName":{"type":"string","description":"A name for the metric. It can include up to 255 characters."},"unitLabel":{"type":"string","description":"A label for the units that the metric is measuring."},"valueKey":{"type":"string","description":"The JSON path to reference the numerical metric value in the event."}},"type":"object","required":["entityIdKey","metricName","valueKey"]},"aws-native:evidently:LaunchSegmentOverride":{"properties":{"evaluationOrder":{"type":"integer","description":"A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first."},"segment":{"type":"string","description":"The ARN of the segment to use for this override."},"weights":{"type":"array","items":{"$ref":"#/types/aws-native:evidently:LaunchGroupToWeight"},"description":"The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic."}},"type":"object","required":["evaluationOrder","segment","weights"]},"aws-native:evidently:LaunchStepConfig":{"properties":{"groupWeights":{"type":"array","items":{"$ref":"#/types/aws-native:evidently:LaunchGroupToWeight"},"description":"An array of structures that define how much launch traffic to allocate to each launch group during this step of the launch."},"segmentOverrides":{"type":"array","items":{"$ref":"#/types/aws-native:evidently:LaunchSegmentOverride"},"description":"An array of structures that you can use to specify different traffic splits for one or more audience *segments* . A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.\n\nFor more information, see [Use segments to focus your audience](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html) ."},"startTime":{"type":"string","description":"The date and time to start this step of the launch. Use UTC format, `yyyy-MM-ddTHH:mm:ssZ` . For example, `2025-11-25T23:59:59Z`"}},"type":"object","required":["groupWeights","startTime"]},"aws-native:evidently:LaunchTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:evidently:ProjectAppConfigResourceObject":{"properties":{"applicationId":{"type":"string","description":"The ID of the AWS AppConfig application to use for client-side evaluation."},"environmentId":{"type":"string","description":"The ID of the AWS AppConfig environment to use for client-side evaluation."}},"type":"object","required":["applicationId","environmentId"]},"aws-native:evidently:ProjectDataDeliveryObject":{"description":"Destinations for data.","properties":{"logGroup":{"type":"string","description":"If the project stores evaluation events in CloudWatch Logs , this structure stores the log group name."},"s3":{"$ref":"#/types/aws-native:evidently:ProjectS3Destination","description":"If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix."}},"type":"object"},"aws-native:evidently:ProjectS3Destination":{"properties":{"bucketName":{"type":"string","description":"The name of the bucket in which Evidently stores evaluation events."},"prefix":{"type":"string","description":"The bucket prefix in which Evidently stores evaluation events."}},"type":"object","required":["bucketName"]},"aws-native:evidently:ProjectTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:evidently:SegmentTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:evs:ConnectivityInfoProperties":{"description":"The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.","properties":{"privateRouteServerPeerings":{"type":"array","items":{"type":"string"},"description":"The unique IDs for private route server peers."}},"type":"object","required":["privateRouteServerPeerings"]},"aws-native:evs:EnvironmentCheck":{"properties":{"impairedSince":{"type":"string","description":"The time when environment health began to be impaired."},"result":{"$ref":"#/types/aws-native:evs:EnvironmentCheckResult","description":"The check result."},"type":{"$ref":"#/types/aws-native:evs:EnvironmentCheckType","description":"The check type. Amazon EVS performs the following checks.\n\n- `KEY_REUSE` : checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment.\n- `KEY_COVERAGE` : checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys.\n- `REACHABILITY` : checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails.\n- `HOST_COUNT` : Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1.\n\nIf this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts."}},"type":"object","required":["result","type"]},"aws-native:evs:EnvironmentCheckResult":{"type":"string","enum":[{"name":"Passed","value":"PASSED"},{"name":"Failed","value":"FAILED"},{"name":"Unknown","value":"UNKNOWN"}]},"aws-native:evs:EnvironmentCheckType":{"description":"The check type. Amazon EVS performs the following checks.\n\n- `KEY_REUSE` : checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment.\n- `KEY_COVERAGE` : checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys.\n- `REACHABILITY` : checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails.\n- `HOST_COUNT` : Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1.\n\nIf this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts.","type":"string","enum":[{"name":"KeyReuse","value":"KEY_REUSE"},{"name":"KeyCoverage","value":"KEY_COVERAGE"},{"name":"Reachability","value":"REACHABILITY"},{"name":"VcfVersion","value":"VCF_VERSION"},{"name":"HostCount","value":"HOST_COUNT"}]},"aws-native:evs:EnvironmentHostInfoForCreate":{"properties":{"dedicatedHostId":{"type":"string","description":"The unique ID of the Amazon EC2 Dedicated Host."},"hostName":{"type":"string","description":"The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF."},"instanceType":{"$ref":"#/types/aws-native:evs:EnvironmentHostInfoForCreateInstanceType","description":"The EC2 instance type that represents the host."},"keyName":{"type":"string","description":"The name of the SSH key that is used to access the host."},"placementGroupId":{"type":"string","description":"The unique ID of the placement group where the host is placed."}},"type":"object","required":["hostName","instanceType","keyName"]},"aws-native:evs:EnvironmentHostInfoForCreateInstanceType":{"description":"The EC2 instance type that represents the host.","type":"string","enum":[{"name":"I4iMetal","value":"i4i.metal"}]},"aws-native:evs:EnvironmentInitialVlanInfo":{"properties":{"cidr":{"type":"string","description":"The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC."}},"type":"object","required":["cidr"]},"aws-native:evs:EnvironmentSecret":{"properties":{"secretArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the secret."}},"type":"object"},"aws-native:evs:EnvironmentState":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Created","value":"CREATED"},{"name":"Deleting","value":"DELETING"},{"name":"Deleted","value":"DELETED"},{"name":"CreateFailed","value":"CREATE_FAILED"}]},"aws-native:evs:EnvironmentTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:evs:EnvironmentVcfVersion":{"description":"The VCF version of the environment.","type":"string","enum":[{"name":"Vcf521","value":"VCF-5.2.1"},{"name":"Vcf522","value":"VCF-5.2.2"}]},"aws-native:evs:InitialVlansProperties":{"description":"The initial Vlan configuration only required upon creation. Modification after creation will have no effect","properties":{"edgeVTep":{"$ref":"#/types/aws-native:evs:EnvironmentInitialVlanInfo","description":"The edge VTEP VLAN subnet. This VLAN subnet manages traffic flowing between the internal network and external networks, including internet access and other site connections."},"expansionVlan1":{"$ref":"#/types/aws-native:evs:EnvironmentInitialVlanInfo","description":"An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations."},"expansionVlan2":{"$ref":"#/types/aws-native:evs:EnvironmentInitialVlanInfo","description":"An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations."},"hcx":{"$ref":"#/types/aws-native:evs:EnvironmentInitialVlanInfo","description":"The HCX VLAN subnet. This VLAN subnet allows the HCX Interconnnect (IX) and HCX Network Extension (NE) to reach their peers and enable HCX Service Mesh creation.\n\nIf you plan to use a public HCX VLAN subnet, the following requirements must be met:\n\n- Must have a /28 netmask and be allocated from the IPAM public pool. Required for HCX internet access configuration.\n- The HCX public VLAN CIDR block must be added to the VPC as a secondary CIDR block.\n- Must have at least two Elastic IP addresses to be allocated from the public IPAM pool for HCX components."},"hcxNetworkAclId":{"type":"string","description":"A unique ID for a network access control list that the HCX VLAN uses. Required when `isHcxPublic` is set to `true` ."},"isHcxPublic":{"type":"boolean","description":"Determines if the HCX VLAN that Amazon EVS provisions is public or private."},"nsxUpLink":{"$ref":"#/types/aws-native:evs:EnvironmentInitialVlanInfo","description":"The NSX uplink VLAN subnet. This VLAN subnet allows connectivity to the NSX overlay network."},"vMotion":{"$ref":"#/types/aws-native:evs:EnvironmentInitialVlanInfo","description":"The vMotion VLAN subnet. This VLAN subnet carries traffic for vSphere vMotion."},"vSan":{"$ref":"#/types/aws-native:evs:EnvironmentInitialVlanInfo","description":"The vSAN VLAN subnet. This VLAN subnet carries the communication between ESXi hosts to implement a vSAN shared storage pool."},"vTep":{"$ref":"#/types/aws-native:evs:EnvironmentInitialVlanInfo","description":"The VTEP VLAN subnet. This VLAN subnet handles internal network traffic between virtual machines within a VCF instance."},"vmManagement":{"$ref":"#/types/aws-native:evs:EnvironmentInitialVlanInfo","description":"The VM management VLAN subnet. This VLAN subnet carries traffic for vSphere virtual machines."},"vmkManagement":{"$ref":"#/types/aws-native:evs:EnvironmentInitialVlanInfo","description":"The host VMkernel management VLAN subnet. This VLAN subnet carries traffic for managing ESXi hosts and communicating with VMware vCenter Server."}},"type":"object","required":["edgeVTep","expansionVlan1","expansionVlan2","hcx","nsxUpLink","vMotion","vSan","vTep","vmManagement","vmkManagement"]},"aws-native:evs:LicenseInfoProperties":{"description":"The license information for an EVS environment","properties":{"solutionKey":{"type":"string","description":"The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must cover a minimum of 256 cores."},"vsanKey":{"type":"string","description":"The VSAN license key. This license unlocks vSAN features. The vSAN license key must provide at least 110 TiB of vSAN capacity."}},"type":"object","required":["solutionKey","vsanKey"]},"aws-native:evs:ServiceAccessSecurityGroupsProperties":{"description":"The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.","properties":{"securityGroups":{"type":"array","items":{"type":"string"},"description":"The security groups that allow service access."}},"type":"object"},"aws-native:evs:VcfHostnamesProperties":{"description":"The DNS hostnames to be used by the VCF management appliances in your environment.\n\nFor environment creation to be successful, each hostname entry must resolve to a domain name that you've registered in your DNS service of choice and configured in the DHCP option set of your VPC. DNS hostnames cannot be changed after environment creation has started.","properties":{"cloudBuilder":{"type":"string","description":"The hostname for VMware Cloud Builder."},"nsx":{"type":"string","description":"The VMware NSX hostname."},"nsxEdge1":{"type":"string","description":"The hostname for the first NSX Edge node."},"nsxEdge2":{"type":"string","description":"The hostname for the second NSX Edge node."},"nsxManager1":{"type":"string","description":"The hostname for the first VMware NSX Manager virtual machine (VM)."},"nsxManager2":{"type":"string","description":"The hostname for the second VMware NSX Manager virtual machine (VM)."},"nsxManager3":{"type":"string","description":"The hostname for the third VMware NSX Manager virtual machine (VM)."},"sddcManager":{"type":"string","description":"The hostname for SDDC Manager."},"vCenter":{"type":"string","description":"The VMware vCenter hostname."}},"type":"object","required":["cloudBuilder","nsx","nsxEdge1","nsxEdge2","nsxManager1","nsxManager2","nsxManager3","sddcManager","vCenter"]},"aws-native:finspace:EnvironmentFederationMode":{"description":"Federation mode used with the Environment","type":"string","enum":[{"name":"Local","value":"LOCAL"},{"name":"Federated","value":"FEDERATED"}]},"aws-native:finspace:EnvironmentFederationParameters":{"description":"Additional parameters to identify Federation mode","properties":{"applicationCallBackUrl":{"type":"string","description":"SAML metadata URL to link with the Environment"},"attributeMap":{"type":"array","items":{"$ref":"#/types/aws-native:finspace:EnvironmentFederationParametersAttributeMapItemProperties"},"description":"Attribute map for SAML configuration"},"federationProviderName":{"type":"string","description":"Federation provider name to link with the Environment"},"federationUrn":{"type":"string","description":"SAML metadata URL to link with the Environment"},"samlMetadataDocument":{"type":"string","description":"SAML metadata document to link the federation provider to the Environment"},"samlMetadataUrl":{"type":"string","description":"SAML metadata URL to link with the Environment"}},"type":"object"},"aws-native:finspace:EnvironmentFederationParametersAttributeMapItemProperties":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object"},"aws-native:finspace:EnvironmentStatus":{"description":"State of the Environment","type":"string","enum":[{"name":"CreateRequested","value":"CREATE_REQUESTED"},{"name":"Creating","value":"CREATING"},{"name":"Created","value":"CREATED"},{"name":"DeleteRequested","value":"DELETE_REQUESTED"},{"name":"Deleting","value":"DELETING"},{"name":"Deleted","value":"DELETED"},{"name":"FailedCreation","value":"FAILED_CREATION"},{"name":"FailedDeletion","value":"FAILED_DELETION"},{"name":"RetryDeletion","value":"RETRY_DELETION"},{"name":"Suspended","value":"SUSPENDED"}]},"aws-native:finspace:EnvironmentSuperuserParameters":{"description":"Parameters of the first Superuser for the FinSpace Environment","properties":{"emailAddress":{"type":"string","description":"Email address"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"}},"type":"object"},"aws-native:finspace:EnvironmentTag":{"description":"A list of all tags for a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:fis:ExperimentTemplateAction":{"description":"Specifies an action for the experiment template.","properties":{"actionId":{"type":"string","description":"The ID of the action."},"description":{"type":"string","description":"A description for the action."},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"The parameters for the action, if applicable."},"startAfter":{"type":"array","items":{"type":"string"},"description":"The name of the action that must be completed before the current action starts."},"targets":{"type":"object","additionalProperties":{"type":"string"},"description":"One or more targets for the action."}},"type":"object","required":["actionId"]},"aws-native:fis:ExperimentTemplateCloudWatchDashboard":{"properties":{"dashboardIdentifier":{"type":"string","description":"The Amazon Resource Name (ARN) of the CloudWatch dashboard to include in the experiment report."}},"type":"object","required":["dashboardIdentifier"]},"aws-native:fis:ExperimentTemplateExperimentOptions":{"properties":{"accountTargeting":{"$ref":"#/types/aws-native:fis:ExperimentTemplateExperimentOptionsAccountTargeting","description":"The account targeting setting for the experiment template.","replaceOnChanges":true},"emptyTargetResolutionMode":{"$ref":"#/types/aws-native:fis:ExperimentTemplateExperimentOptionsEmptyTargetResolutionMode","description":"The target resolution failure mode for the experiment template."}},"type":"object"},"aws-native:fis:ExperimentTemplateExperimentOptionsAccountTargeting":{"description":"The account targeting setting for the experiment template.","type":"string","enum":[{"name":"MultiAccount","value":"multi-account"},{"name":"SingleAccount","value":"single-account"}]},"aws-native:fis:ExperimentTemplateExperimentOptionsEmptyTargetResolutionMode":{"description":"The target resolution failure mode for the experiment template.","type":"string","enum":[{"name":"Fail","value":"fail"},{"name":"Skip","value":"skip"}]},"aws-native:fis:ExperimentTemplateExperimentReportConfiguration":{"properties":{"dataSources":{"$ref":"#/types/aws-native:fis:ExperimentTemplateExperimentReportConfigurationDataSourcesProperties","description":"The data sources for the experiment report."},"outputs":{"$ref":"#/types/aws-native:fis:ExperimentTemplateExperimentReportConfigurationOutputsProperties","description":"The output destinations of the experiment report."},"postExperimentDuration":{"type":"string","description":"The duration after the experiment end time for the data sources to include in the report."},"preExperimentDuration":{"type":"string","description":"The duration before the experiment start time for the data sources to include in the report."}},"type":"object","required":["outputs"]},"aws-native:fis:ExperimentTemplateExperimentReportConfigurationDataSourcesProperties":{"description":"The data sources for the experiment report.","properties":{"cloudWatchDashboards":{"type":"array","items":{"$ref":"#/types/aws-native:fis:ExperimentTemplateCloudWatchDashboard"}}},"type":"object"},"aws-native:fis:ExperimentTemplateExperimentReportConfigurationOutputsProperties":{"description":"The output destinations of the experiment report.","properties":{"experimentReportS3Configuration":{"$ref":"#/types/aws-native:fis:ExperimentTemplateExperimentReportConfigurationOutputsPropertiesExperimentReportS3ConfigurationProperties"}},"type":"object","required":["experimentReportS3Configuration"]},"aws-native:fis:ExperimentTemplateExperimentReportConfigurationOutputsPropertiesExperimentReportS3ConfigurationProperties":{"properties":{"bucketName":{"type":"string"},"prefix":{"type":"string"}},"type":"object","required":["bucketName"]},"aws-native:fis:ExperimentTemplateLogConfiguration":{"properties":{"cloudWatchLogsConfiguration":{"$ref":"#/types/aws-native:fis:ExperimentTemplateLogConfigurationCloudWatchLogsConfigurationProperties","description":"The configuration for experiment logging to CloudWatch Logs ."},"logSchemaVersion":{"type":"integer","description":"The schema version."},"s3Configuration":{"$ref":"#/types/aws-native:fis:ExperimentTemplateLogConfigurationS3ConfigurationProperties","description":"The configuration for experiment logging to Amazon S3 ."}},"type":"object","required":["logSchemaVersion"]},"aws-native:fis:ExperimentTemplateLogConfigurationCloudWatchLogsConfigurationProperties":{"description":"The configuration for experiment logging to CloudWatch Logs .","properties":{"logGroupArn":{"type":"string"}},"type":"object","required":["logGroupArn"]},"aws-native:fis:ExperimentTemplateLogConfigurationS3ConfigurationProperties":{"description":"The configuration for experiment logging to Amazon S3 .","properties":{"bucketName":{"type":"string"},"prefix":{"type":"string"}},"type":"object","required":["bucketName"]},"aws-native:fis:ExperimentTemplateStopCondition":{"properties":{"source":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["source"]},"aws-native:fis:ExperimentTemplateTarget":{"description":"Specifies a target for an experiment.","properties":{"filters":{"type":"array","items":{"$ref":"#/types/aws-native:fis:ExperimentTemplateTargetFilter"},"description":"The filters to apply to identify target resources using specific attributes."},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"The parameters for the resource type."},"resourceArns":{"type":"array","items":{"type":"string"},"description":"The Amazon Resource Names (ARNs) of the targets."},"resourceTags":{"type":"object","additionalProperties":{"type":"string"},"description":"The tags for the target resources."},"resourceType":{"type":"string","description":"The resource type."},"selectionMode":{"type":"string","description":"Scopes the identified resources to a specific count or percentage."}},"type":"object","required":["resourceType","selectionMode"]},"aws-native:fis:ExperimentTemplateTargetFilter":{"description":"Describes a filter used for the target resource input in an experiment template.","properties":{"path":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"type":"object","required":["path","values"]},"aws-native:fms:PolicyFirewallDeploymentModel":{"description":"Firewall deployment mode.","type":"string","enum":[{"name":"Distributed","value":"DISTRIBUTED"},{"name":"Centralized","value":"CENTRALIZED"}]},"aws-native:fms:PolicyIeMap":{"description":"An FMS includeMap or excludeMap.","properties":{"account":{"type":"array","items":{"type":"string"},"description":"The account list for the map."},"orgunit":{"type":"array","items":{"type":"string"},"description":"The organizational unit list for the map."}},"type":"object"},"aws-native:fms:PolicyNetworkAclCommonPolicy":{"description":"Network ACL common policy.","properties":{"networkAclEntrySet":{"$ref":"#/types/aws-native:fms:PolicyNetworkAclEntrySet","description":"The definition of the first and last rules for the network ACL policy."}},"type":"object","required":["networkAclEntrySet"]},"aws-native:fms:PolicyNetworkAclEntry":{"description":"Network ACL entry.","properties":{"cidrBlock":{"type":"string","description":"CIDR block."},"egress":{"type":"boolean","description":"Whether the entry is an egress entry."},"icmpTypeCode":{"$ref":"#/types/aws-native:fms:PolicyNetworkAclEntryIcmpTypeCodeProperties","description":"ICMP type and code."},"ipv6CidrBlock":{"type":"string","description":"IPv6 CIDR block."},"portRange":{"$ref":"#/types/aws-native:fms:PolicyNetworkAclEntryPortRangeProperties","description":"Port range."},"protocol":{"type":"string","description":"Protocol."},"ruleAction":{"$ref":"#/types/aws-native:fms:PolicyNetworkAclEntryRuleAction","description":"Rule Action."}},"type":"object","required":["egress","protocol","ruleAction"]},"aws-native:fms:PolicyNetworkAclEntryIcmpTypeCodeProperties":{"description":"ICMP type and code.","properties":{"code":{"type":"integer","description":"Code."},"type":{"type":"integer","description":"Type."}},"type":"object","required":["code","type"]},"aws-native:fms:PolicyNetworkAclEntryPortRangeProperties":{"description":"Port range.","properties":{"from":{"type":"integer","description":"From Port."},"to":{"type":"integer","description":"To Port."}},"type":"object","required":["from","to"]},"aws-native:fms:PolicyNetworkAclEntryRuleAction":{"description":"Rule Action.","type":"string","enum":[{"name":"Allow","value":"allow"},{"name":"Deny","value":"deny"}]},"aws-native:fms:PolicyNetworkAclEntrySet":{"description":"Network ACL entry set.","properties":{"firstEntries":{"type":"array","items":{"$ref":"#/types/aws-native:fms:PolicyNetworkAclEntry"},"description":"The rules that you want to run first in the Firewall Manager managed network ACLs.\n\n\u003e Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates. \n\nYou must specify at least one first entry or one last entry in any network ACL policy."},"forceRemediateForFirstEntries":{"type":"boolean","description":"Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.\n\nIf forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see [Remediation for managed network ACLs](https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html#network-acls-remediation) in the *AWS Firewall Manager Developer Guide* ."},"forceRemediateForLastEntries":{"type":"boolean","description":"Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.\n\nIf forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see [Remediation for managed network ACLs](https://docs.aws.amazon.com/waf/latest/developerguide/network-acl-policies.html#network-acls-remediation) in the *AWS Firewall Manager Developer Guide* ."},"lastEntries":{"type":"array","items":{"$ref":"#/types/aws-native:fms:PolicyNetworkAclEntry"},"description":"The rules that you want to run last in the Firewall Manager managed network ACLs.\n\n\u003e Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates. \n\nYou must specify at least one first entry or one last entry in any network ACL policy."}},"type":"object","required":["forceRemediateForFirstEntries","forceRemediateForLastEntries"]},"aws-native:fms:PolicyNetworkFirewallPolicy":{"description":"Network firewall policy.","properties":{"firewallDeploymentModel":{"$ref":"#/types/aws-native:fms:PolicyFirewallDeploymentModel","description":"Defines the deployment model to use for the firewall policy. To use a distributed model, set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html) to `DISTRIBUTED` ."}},"type":"object","required":["firewallDeploymentModel"]},"aws-native:fms:PolicyOption":{"description":"Firewall policy option.","properties":{"networkAclCommonPolicy":{"$ref":"#/types/aws-native:fms:PolicyNetworkAclCommonPolicy","description":"Defines a Firewall Manager network ACL policy."},"networkFirewallPolicy":{"$ref":"#/types/aws-native:fms:PolicyNetworkFirewallPolicy","description":"Defines the deployment model to use for the firewall policy."},"thirdPartyFirewallPolicy":{"$ref":"#/types/aws-native:fms:PolicyThirdPartyFirewallPolicy","description":"Defines the policy options for a third-party firewall policy."}},"type":"object"},"aws-native:fms:PolicyResourceTag":{"description":"A resource tag.","properties":{"key":{"type":"string","description":"The resource tag key."},"value":{"type":"string","description":"The resource tag value."}},"type":"object","required":["key"]},"aws-native:fms:PolicyResourceTagLogicalOperator":{"description":"Specifies whether to combine multiple resource tags with AND, so that a resource must have all tags to be included or excluded, or OR, so that a resource must have at least one tag.\n\nDefault: `AND`","type":"string","enum":[{"name":"And","value":"AND"},{"name":"Or","value":"OR"}]},"aws-native:fms:PolicySecurityServicePolicyData":{"description":"Firewall security service policy data.","properties":{"managedServiceData":{"type":"string","description":"Details about the service that are specific to the service type, in JSON format.\n\n- Example: `DNS_FIREWALL`\n\n`\"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"`\n\n\u003e Valid values for `preProcessRuleGroups` are between 1 and 99. Valid values for `postProcessRuleGroups` are between 9901 and 10000.\n- Example: `NETWORK_FIREWALL` - Centralized deployment model\n\n`\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"awsNetworkFirewallConfig\\\":{\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}},\\\"firewallDeploymentModel\\\":{\\\"centralizedFirewallDeploymentModel\\\":{\\\"centralizedFirewallOrchestrationConfig\\\":{\\\"inspectionVpcIds\\\":[{\\\"resourceId\\\":\\\"vpc-1234\\\",\\\"accountId\\\":\\\"123456789011\\\"}],\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneId\\\":null,\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"allowedIPV4CidrList\\\":[]}}}}\"`\n\nTo use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to `DISTRIBUTED` .\n- Example: `NETWORK_FIREWALL` - Distributed deployment model with automatic Availability Zone configuration\n\n`\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\",\\\"192.168.0.0/28\\\"],\\\"routeManagementAction\\\":\\\"OFF\\\"},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}}\"`\n\nWith automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. To use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to `DISTRIBUTED` .\n- Example: `NETWORK_FIREWALL` - Distributed deployment model with automatic Availability Zone configuration and route management\n\n`\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\",\\\"192.168.0.0/28\\\"],\\\"routeManagementAction\\\":\\\"MONITOR\\\",\\\"routeManagementTargetTypes\\\":[\\\"InternetGateway\\\"]},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\": \\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}}\"`\n\nTo use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to `DISTRIBUTED` .\n- Example: `NETWORK_FIREWALL` - Distributed deployment model with custom Availability Zone configuration\n\n`\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"fragmentcustomactionname\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\", \\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}},{\\\"actionName\\\":\\\"fragmentcustomactionname\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"fragmentmetricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{ \\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]},{\\\"availabilityZoneName\\\":\\\"us-east-1b\\\",\\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\"]}]} },\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":null,\\\"routeManagementAction\\\":\\\"OFF\\\",\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":boolean}}\"`\n\nWith custom Availability Zone configuration, you define which specific Availability Zones to create endpoints in by configuring `firewallCreationConfig` . To configure the Availability Zones in `firewallCreationConfig` , specify either the `availabilityZoneName` or `availabilityZoneId` parameter, not both parameters.\n\nTo use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to `DISTRIBUTED` .\n- Example: `NETWORK_FIREWALL` - Distributed deployment model with custom Availability Zone configuration and route management\n\n`\"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"fragmentcustomactionname\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}},{\\\"actionName\\\":\\\"fragmentcustomactionname\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"fragmentmetricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]},{\\\"availabilityZoneName\\\":\\\"us-east-1b\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":null,\\\"routeManagementAction\\\":\\\"MONITOR\\\",\\\"routeManagementTargetTypes\\\":[\\\"InternetGateway\\\"],\\\"routeManagementConfig\\\":{\\\"allowCrossAZTrafficIfNoEndpoint\\\":true}},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":boolean}}\"`\n\nTo use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) to `DISTRIBUTED` .\n- Example: `THIRD_PARTY_FIREWALL` - Palo Alto Networks Cloud Next-Generation Firewall centralized deployment model\n\n`\"{ \\\"type\\\":\\\"THIRD_PARTY_FIREWALL\\\", \\\"thirdPartyFirewall\\\":\\\"PALO_ALTO_NETWORKS_CLOUD_NGFW\\\", \\\"thirdPartyFirewallConfig\\\":{ \\\"thirdPartyFirewallPolicyList\\\":[\\\"global-1\\\"] },\\\"firewallDeploymentModel\\\":{\\\"centralizedFirewallDeploymentModel\\\":{\\\"centralizedFirewallOrchestrationConfig\\\":{\\\"inspectionVpcIds\\\":[{\\\"resourceId\\\":\\\"vpc-1234\\\",\\\"accountId\\\":\\\"123456789011\\\"}],\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneId\\\":null,\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"allowedIPV4CidrList\\\":[]}}}}\"`\n\nTo use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html) to `CENTRALIZED` .\n- Example: `THIRD_PARTY_FIREWALL` - Palo Alto Networks Cloud Next-Generation Firewall distributed deployment model\n\n`\"{\\\"type\\\":\\\"THIRD_PARTY_FIREWALL\\\",\\\"thirdPartyFirewall\\\":\\\"PALO_ALTO_NETWORKS_CLOUD_NGFW\\\",\\\"thirdPartyFirewallConfig\\\":{\\\"thirdPartyFirewallPolicyList\\\":[\\\"global-1\\\"] },\\\"firewallDeploymentModel\\\":{ \\\"distributedFirewallDeploymentModel\\\":{ \\\"distributedFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{ \\\"availabilityZoneConfigList\\\":[ {\\\"availabilityZoneName\\\":\\\"${AvailabilityZone}\\\" } ] } }, \\\"allowedIPV4CidrList\\\":[ ] } } } }\"`\n\nTo use the distributed deployment model, you must set [FirewallDeploymentModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html) to `DISTRIBUTED` .\n- Specification for `SHIELD_ADVANCED` for Amazon CloudFront distributions\n\n`\"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\", \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"}, \\\"overrideCustomerWebaclClassic\\\":true|false}\"`\n\nFor example: `\"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\", \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"`\n\nThe default value for `automaticResponseStatus` is `IGNORED` . The value for `automaticResponseAction` is only required when `automaticResponseStatus` is set to `ENABLED` . The default value for `overrideCustomerWebaclClassic` is `false` .\n\nFor other resource types that you can protect with a Shield Advanced policy, this `ManagedServiceData` configuration is an empty string.\n- Example: `WAFV2`\n\n`\"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAmazonIpReputationList\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"`\n\nIn the `loggingConfiguration` , you can specify one `logDestinationConfigs` , you can optionally provide up to 20 `redactedFields` , and the `RedactedFieldType` must be one of `URI` , `QUERY_STRING` , `HEADER` , or `METHOD` .\n- Example: `AWS WAF Classic`\n\n`\"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\": [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\": \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"`\n- Example: `WAFV2` - AWS Firewall Manager support for AWS WAF managed rule group versioning\n\n`\"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":true,\\\"version\\\":\\\"Version_2.0\\\",\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesCommonRuleSet\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"`\n\nTo use a specific version of a AWS WAF managed rule group in your Firewall Manager policy, you must set `versionEnabled` to `true` , and set `version` to the version you'd like to use. If you don't set `versionEnabled` to `true` , or if you omit `versionEnabled` , then Firewall Manager uses the default version of the AWS WAF managed rule group.\n- Example: `SECURITY_GROUPS_COMMON`\n\n`\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"`\n- Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns\n\n`\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"`\n- Example: `SECURITY_GROUPS_CONTENT_AUDIT`\n\n`\"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"`\n\nThe security group action for content audit can be `ALLOW` or `DENY` . For `ALLOW` , all in-scope security group rules must be within the allowed range of the policy's security group rules. For `DENY` , all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.\n- Example: `SECURITY_GROUPS_USAGE_AUDIT`\n\n`\"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"`"},"policyOption":{"$ref":"#/types/aws-native:fms:PolicyOption","description":"Contains the settings to configure a network ACL policy, a AWS Network Firewall firewall policy deployment model, or a third-party firewall policy."},"type":{"$ref":"#/types/aws-native:fms:PolicyType","description":"The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting SUPlong ."}},"type":"object","required":["type"]},"aws-native:fms:PolicyTag":{"description":"A policy tag.","properties":{"key":{"type":"string","description":"Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive."},"value":{"type":"string","description":"Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive."}},"type":"object","required":["key","value"]},"aws-native:fms:PolicyThirdPartyFirewallPolicy":{"description":"Third party firewall policy.","properties":{"firewallDeploymentModel":{"$ref":"#/types/aws-native:fms:PolicyFirewallDeploymentModel","description":"Defines the deployment model to use for the third-party firewall policy."}},"type":"object","required":["firewallDeploymentModel"]},"aws-native:fms:PolicyType":{"description":"Firewall policy type.","type":"string","enum":[{"name":"Waf","value":"WAF"},{"name":"Wafv2","value":"WAFV2"},{"name":"ShieldAdvanced","value":"SHIELD_ADVANCED"},{"name":"SecurityGroupsCommon","value":"SECURITY_GROUPS_COMMON"},{"name":"SecurityGroupsContentAudit","value":"SECURITY_GROUPS_CONTENT_AUDIT"},{"name":"SecurityGroupsUsageAudit","value":"SECURITY_GROUPS_USAGE_AUDIT"},{"name":"NetworkFirewall","value":"NETWORK_FIREWALL"},{"name":"ThirdPartyFirewall","value":"THIRD_PARTY_FIREWALL"},{"name":"DnsFirewall","value":"DNS_FIREWALL"},{"name":"ImportNetworkFirewall","value":"IMPORT_NETWORK_FIREWALL"},{"name":"NetworkAclCommon","value":"NETWORK_ACL_COMMON"}]},"aws-native:fms:ResourceSetTag":{"description":"A tag.","properties":{"key":{"type":"string","description":"Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive."},"value":{"type":"string","description":"Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive."}},"type":"object","required":["key","value"]},"aws-native:forecast:DatasetAttributesItemProperties":{"properties":{"attributeName":{"type":"string","description":"Name of the dataset field"},"attributeType":{"$ref":"#/types/aws-native:forecast:DatasetAttributesItemPropertiesAttributeType","description":"Data type of the field"}},"type":"object"},"aws-native:forecast:DatasetAttributesItemPropertiesAttributeType":{"description":"Data type of the field","type":"string","enum":[{"name":"String","value":"string"},{"name":"Integer","value":"integer"},{"name":"Float","value":"float"},{"name":"Timestamp","value":"timestamp"},{"name":"Geolocation","value":"geolocation"}]},"aws-native:forecast:DatasetDomain":{"description":"The domain associated with the dataset","type":"string","enum":[{"name":"Retail","value":"RETAIL"},{"name":"Custom","value":"CUSTOM"},{"name":"InventoryPlanning","value":"INVENTORY_PLANNING"},{"name":"Ec2Capacity","value":"EC2_CAPACITY"},{"name":"WorkForce","value":"WORK_FORCE"},{"name":"WebTraffic","value":"WEB_TRAFFIC"},{"name":"Metrics","value":"METRICS"}]},"aws-native:forecast:DatasetGroupDomain":{"description":"The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.","type":"string","enum":[{"name":"Retail","value":"RETAIL"},{"name":"Custom","value":"CUSTOM"},{"name":"InventoryPlanning","value":"INVENTORY_PLANNING"},{"name":"Ec2Capacity","value":"EC2_CAPACITY"},{"name":"WorkForce","value":"WORK_FORCE"},{"name":"WebTraffic","value":"WEB_TRAFFIC"},{"name":"Metrics","value":"METRICS"}]},"aws-native:forecast:DatasetGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:forecast:DatasetType":{"description":"The dataset type","type":"string","enum":[{"name":"TargetTimeSeries","value":"TARGET_TIME_SERIES"},{"name":"RelatedTimeSeries","value":"RELATED_TIME_SERIES"},{"name":"ItemMetadata","value":"ITEM_METADATA"}]},"aws-native:forecast:EncryptionConfigProperties":{"description":"A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.","properties":{"kmsKeyArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the KMS key."},"roleArn":{"type":"string","description":"The ARN of the IAM role that Amazon Forecast can assume to access the AWS  key.\n\nPassing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an `InvalidInputException` error."}},"type":"object"},"aws-native:forecast:SchemaProperties":{"description":"The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset `Domain` and `DatasetType` that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see [Dataset Domains and Dataset Types](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html) .","properties":{"attributes":{"type":"array","items":{"$ref":"#/types/aws-native:forecast:DatasetAttributesItemProperties"},"description":"An array of attributes specifying the name and type of each field in a dataset."}},"type":"object"},"aws-native:forecast:TagsItemProperties":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:frauddetector:DetectorEntityType":{"properties":{"arn":{"type":"string","description":"The entity type ARN."},"createdTime":{"type":"string","description":"The time when the entity type was created."},"description":{"type":"string","description":"The description."},"inline":{"type":"boolean","description":"Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.\n\nFor example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these Variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your detector but not execute any changes to the variables."},"lastUpdatedTime":{"type":"string","description":"The time when the entity type was last updated."},"name":{"type":"string","description":"The entity type name."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:DetectorTag"},"description":"Tags associated with this entity type."}},"type":"object"},"aws-native:frauddetector:DetectorEventType":{"properties":{"arn":{"type":"string","description":"The ARN of the event type."},"createdTime":{"type":"string","description":"The time when the event type was created."},"description":{"type":"string","description":"The description of the event type."},"entityTypes":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:DetectorEntityType"},"description":"The event type entity types."},"eventVariables":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:DetectorEventVariable"},"description":"The event type event variables."},"inline":{"type":"boolean","description":"Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.\n\nFor example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the Variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your detector but not execute any changes to the variables."},"labels":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:DetectorLabel"},"description":"The event type labels."},"lastUpdatedTime":{"type":"string","description":"The time when the event type was last updated."},"name":{"type":"string","description":"The name for the event type"},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:DetectorTag"},"description":"Tags associated with this event type."}},"type":"object"},"aws-native:frauddetector:DetectorEventVariable":{"properties":{"arn":{"type":"string","description":"The event variable ARN."},"createdTime":{"type":"string","description":"The time when the event variable was created."},"dataSource":{"$ref":"#/types/aws-native:frauddetector:DetectorEventVariableDataSource","description":"The data source of the event variable.\n\nValid values: `EVENT | EXTERNAL_MODEL_SCORE`\n\nWhen defining a variable within a detector, you can only use the `EVENT` value for DataSource when the *Inline* property is set to true. If the *Inline* property is set false, you can use either `EVENT` or `MODEL_SCORE` for DataSource."},"dataType":{"$ref":"#/types/aws-native:frauddetector:DetectorEventVariableDataType","description":"The data type of the event variable.\n\nValid values: `STRING | INTEGER | BOOLEAN | FLOAT`"},"defaultValue":{"type":"string","description":"The default value of the event variable. This is required if you are providing the details of your variables instead of the ARN."},"description":{"type":"string","description":"The description."},"inline":{"type":"boolean","description":"Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.\n\nFor example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your detector but not execute any changes to the variables."},"lastUpdatedTime":{"type":"string","description":"The time when the event variable was last updated."},"name":{"type":"string","description":"The name of the event variable."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:DetectorTag"},"description":"Tags associated with this event variable."},"variableType":{"$ref":"#/types/aws-native:frauddetector:DetectorEventVariableVariableType","description":"The type of event variable. For more information, see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) ."}},"type":"object"},"aws-native:frauddetector:DetectorEventVariableDataSource":{"description":"The data source of the event variable.\n\nValid values: `EVENT | EXTERNAL_MODEL_SCORE`\n\nWhen defining a variable within a detector, you can only use the `EVENT` value for DataSource when the *Inline* property is set to true. If the *Inline* property is set false, you can use either `EVENT` or `MODEL_SCORE` for DataSource.","type":"string","enum":[{"name":"Event","value":"EVENT"}]},"aws-native:frauddetector:DetectorEventVariableDataType":{"description":"The data type of the event variable.\n\nValid values: `STRING | INTEGER | BOOLEAN | FLOAT`","type":"string","enum":[{"name":"String","value":"STRING"},{"name":"Integer","value":"INTEGER"},{"name":"Float","value":"FLOAT"},{"name":"Boolean","value":"BOOLEAN"}]},"aws-native:frauddetector:DetectorEventVariableVariableType":{"description":"The type of event variable. For more information, see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types) .","type":"string","enum":[{"name":"AuthCode","value":"AUTH_CODE"},{"name":"Avs","value":"AVS"},{"name":"BillingAddressL1","value":"BILLING_ADDRESS_L1"},{"name":"BillingAddressL2","value":"BILLING_ADDRESS_L2"},{"name":"BillingCity","value":"BILLING_CITY"},{"name":"BillingCountry","value":"BILLING_COUNTRY"},{"name":"BillingName","value":"BILLING_NAME"},{"name":"BillingPhone","value":"BILLING_PHONE"},{"name":"BillingState","value":"BILLING_STATE"},{"name":"BillingZip","value":"BILLING_ZIP"},{"name":"CardBin","value":"CARD_BIN"},{"name":"Categorical","value":"CATEGORICAL"},{"name":"CurrencyCode","value":"CURRENCY_CODE"},{"name":"EmailAddress","value":"EMAIL_ADDRESS"},{"name":"Fingerprint","value":"FINGERPRINT"},{"name":"FraudLabel","value":"FRAUD_LABEL"},{"name":"FreeFormText","value":"FREE_FORM_TEXT"},{"name":"IpAddress","value":"IP_ADDRESS"},{"name":"Numeric","value":"NUMERIC"},{"name":"OrderId","value":"ORDER_ID"},{"name":"PaymentType","value":"PAYMENT_TYPE"},{"name":"PhoneNumber","value":"PHONE_NUMBER"},{"name":"Price","value":"PRICE"},{"name":"ProductCategory","value":"PRODUCT_CATEGORY"},{"name":"ShippingAddressL1","value":"SHIPPING_ADDRESS_L1"},{"name":"ShippingAddressL2","value":"SHIPPING_ADDRESS_L2"},{"name":"ShippingCity","value":"SHIPPING_CITY"},{"name":"ShippingCountry","value":"SHIPPING_COUNTRY"},{"name":"ShippingName","value":"SHIPPING_NAME"},{"name":"ShippingPhone","value":"SHIPPING_PHONE"},{"name":"ShippingState","value":"SHIPPING_STATE"},{"name":"ShippingZip","value":"SHIPPING_ZIP"},{"name":"Useragent","value":"USERAGENT"}]},"aws-native:frauddetector:DetectorLabel":{"properties":{"arn":{"type":"string","description":"The label ARN."},"createdTime":{"type":"string","description":"The time when the label was created."},"description":{"type":"string","description":"The description."},"inline":{"type":"boolean","description":"Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.\n\nFor example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your detector but not execute any changes to the variables."},"lastUpdatedTime":{"type":"string","description":"The time when the label was last updated."},"name":{"type":"string","description":"The label name."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:DetectorTag"},"description":"Tags associated with this label."}},"type":"object"},"aws-native:frauddetector:DetectorModel":{"description":"A model to associate with a detector.","properties":{"arn":{"type":"string","description":"The ARN of the model."}},"type":"object"},"aws-native:frauddetector:DetectorOutcome":{"properties":{"arn":{"type":"string","description":"The outcome ARN."},"createdTime":{"type":"string","description":"The time when the outcome was created."},"description":{"type":"string","description":"The description."},"inline":{"type":"boolean","description":"Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.\n\nFor example, when creating `AWS::FraudDetector::Detector` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your detector but not execute any changes to the variables."},"lastUpdatedTime":{"type":"string","description":"The time when the outcome was last updated."},"name":{"type":"string","description":"The outcome name."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:DetectorTag"},"description":"Tags associated with this outcome."}},"type":"object"},"aws-native:frauddetector:DetectorRule":{"properties":{"arn":{"type":"string","description":"The rule ARN."},"createdTime":{"type":"string","description":"The time when the event type was created."},"description":{"type":"string","description":"The description."},"detectorId":{"type":"string","description":"The detector for which the rule is associated."},"expression":{"type":"string","description":"The rule expression. A rule expression captures the business logic. For more information, see [Rule language reference](https://docs.aws.amazon.com/frauddetector/latest/ug/rule-language-reference.html) ."},"language":{"$ref":"#/types/aws-native:frauddetector:DetectorRuleLanguage","description":"The rule language.\n\nValid Value: DETECTORPL"},"lastUpdatedTime":{"type":"string","description":"The time when the event type was last updated."},"outcomes":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:DetectorOutcome"},"description":"The rule outcome."},"ruleId":{"type":"string","description":"The rule ID."},"ruleVersion":{"type":"string","description":"The rule version."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:DetectorTag"},"description":"Tags associated with this event type."}},"type":"object"},"aws-native:frauddetector:DetectorRuleExecutionMode":{"description":"The rule execution mode for the rules included in the detector version.\n\nValid values: `FIRST_MATCHED | ALL_MATCHED` Default value: `FIRST_MATCHED`\n\nYou can define and edit the rule mode at the detector version level, when it is in draft status.\n\nIf you specify `FIRST_MATCHED` , Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.\n\nIf you specifiy `ALL_MATCHED` , Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.","type":"string","enum":[{"name":"FirstMatched","value":"FIRST_MATCHED"},{"name":"AllMatched","value":"ALL_MATCHED"}]},"aws-native:frauddetector:DetectorRuleLanguage":{"description":"The rule language.\n\nValid Value: DETECTORPL","type":"string","enum":[{"name":"Detectorpl","value":"DETECTORPL"}]},"aws-native:frauddetector:DetectorTag":{"properties":{"key":{"type":"string","description":"A tag key."},"value":{"type":"string","description":"A value assigned to a tag key."}},"type":"object","required":["key","value"]},"aws-native:frauddetector:DetectorVersionStatus":{"description":"The desired detector version status for the detector","type":"string","enum":[{"name":"Draft","value":"DRAFT"},{"name":"Active","value":"ACTIVE"}]},"aws-native:frauddetector:EntityTypeTag":{"properties":{"key":{"type":"string","description":"A tag key."},"value":{"type":"string","description":"A value assigned to a tag key."}},"type":"object","required":["key","value"]},"aws-native:frauddetector:EventTypeEntityType":{"properties":{"arn":{"type":"string","description":"The entity type ARN."},"createdTime":{"type":"string","description":"The time when the event type was created."},"description":{"type":"string","description":"The description."},"inline":{"type":"boolean","description":"Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.\n\nFor example, when creating `AWS::FraudDetector::EventType` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your event type but not execute any changes to the variables."},"lastUpdatedTime":{"type":"string","description":"The time when the event type was last updated."},"name":{"type":"string","description":"The entity type name.\n\n`^[0-9a-z_-]+$`"},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:EventTypeTag"},"description":"Tags associated with this event type."}},"type":"object"},"aws-native:frauddetector:EventTypeEventVariable":{"properties":{"arn":{"type":"string","description":"The event variable ARN."},"createdTime":{"type":"string","description":"The time when the event type was created."},"dataSource":{"$ref":"#/types/aws-native:frauddetector:EventTypeEventVariableDataSource","description":"The source of the event variable.\n\nValid values: `EVENT | EXTERNAL_MODEL_SCORE`\n\nWhen defining a variable within a event type, you can only use the `EVENT` value for DataSource when the *Inline* property is set to true. If the *Inline* property is set false, you can use either `EVENT` or `MODEL_SCORE` for DataSource."},"dataType":{"$ref":"#/types/aws-native:frauddetector:EventTypeEventVariableDataType","description":"The data type of the event variable. For more information, see [Data types](https://docs.aws.amazon.com/frauddetector/latest/ug/variables.html#data-types) ."},"defaultValue":{"type":"string","description":"The default value of the event variable"},"description":{"type":"string","description":"The description."},"inline":{"type":"boolean","description":"Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.\n\nFor example, when creating `AWS::FraudDetector::EventType` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the Variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your event type but not execute any changes to the variables."},"lastUpdatedTime":{"type":"string","description":"The time when the event type was last updated."},"name":{"type":"string","description":"The name of the event variable."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:EventTypeTag"},"description":"Tags associated with this event type."},"variableType":{"$ref":"#/types/aws-native:frauddetector:EventTypeEventVariableVariableType","description":"The type of event variable. For more information, see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/variables.html#variable-types) ."}},"type":"object"},"aws-native:frauddetector:EventTypeEventVariableDataSource":{"description":"The source of the event variable.\n\nValid values: `EVENT | EXTERNAL_MODEL_SCORE`\n\nWhen defining a variable within a event type, you can only use the `EVENT` value for DataSource when the *Inline* property is set to true. If the *Inline* property is set false, you can use either `EVENT` or `MODEL_SCORE` for DataSource.","type":"string","enum":[{"name":"Event","value":"EVENT"}]},"aws-native:frauddetector:EventTypeEventVariableDataType":{"description":"The data type of the event variable. For more information, see [Data types](https://docs.aws.amazon.com/frauddetector/latest/ug/variables.html#data-types) .","type":"string","enum":[{"name":"String","value":"STRING"},{"name":"Integer","value":"INTEGER"},{"name":"Float","value":"FLOAT"},{"name":"Boolean","value":"BOOLEAN"}]},"aws-native:frauddetector:EventTypeEventVariableVariableType":{"description":"The type of event variable. For more information, see [Variable types](https://docs.aws.amazon.com/frauddetector/latest/ug/variables.html#variable-types) .","type":"string","enum":[{"name":"AuthCode","value":"AUTH_CODE"},{"name":"Avs","value":"AVS"},{"name":"BillingAddressL1","value":"BILLING_ADDRESS_L1"},{"name":"BillingAddressL2","value":"BILLING_ADDRESS_L2"},{"name":"BillingCity","value":"BILLING_CITY"},{"name":"BillingCountry","value":"BILLING_COUNTRY"},{"name":"BillingName","value":"BILLING_NAME"},{"name":"BillingPhone","value":"BILLING_PHONE"},{"name":"BillingState","value":"BILLING_STATE"},{"name":"BillingZip","value":"BILLING_ZIP"},{"name":"CardBin","value":"CARD_BIN"},{"name":"Categorical","value":"CATEGORICAL"},{"name":"CurrencyCode","value":"CURRENCY_CODE"},{"name":"EmailAddress","value":"EMAIL_ADDRESS"},{"name":"Fingerprint","value":"FINGERPRINT"},{"name":"FraudLabel","value":"FRAUD_LABEL"},{"name":"FreeFormText","value":"FREE_FORM_TEXT"},{"name":"IpAddress","value":"IP_ADDRESS"},{"name":"Numeric","value":"NUMERIC"},{"name":"OrderId","value":"ORDER_ID"},{"name":"PaymentType","value":"PAYMENT_TYPE"},{"name":"PhoneNumber","value":"PHONE_NUMBER"},{"name":"Price","value":"PRICE"},{"name":"ProductCategory","value":"PRODUCT_CATEGORY"},{"name":"ShippingAddressL1","value":"SHIPPING_ADDRESS_L1"},{"name":"ShippingAddressL2","value":"SHIPPING_ADDRESS_L2"},{"name":"ShippingCity","value":"SHIPPING_CITY"},{"name":"ShippingCountry","value":"SHIPPING_COUNTRY"},{"name":"ShippingName","value":"SHIPPING_NAME"},{"name":"ShippingPhone","value":"SHIPPING_PHONE"},{"name":"ShippingState","value":"SHIPPING_STATE"},{"name":"ShippingZip","value":"SHIPPING_ZIP"},{"name":"Useragent","value":"USERAGENT"}]},"aws-native:frauddetector:EventTypeLabel":{"properties":{"arn":{"type":"string","description":"The label ARN."},"createdTime":{"type":"string","description":"The time when the event type was created."},"description":{"type":"string","description":"The description."},"inline":{"type":"boolean","description":"Indicates whether the resource is defined within this CloudFormation template and impacts the create, update, and delete behavior of the stack. If the value is `true` , CloudFormation will create/update/delete the resource when creating/updating/deleting the stack. If the value is `false` , CloudFormation will validate that the object exists and then use it within the resource without making changes to the object.\n\nFor example, when creating `AWS::FraudDetector::EventType` you must define at least two variables. You can set `Inline=true` for these variables and CloudFormation will create/update/delete the variables as part of stack operations. However, if you set `Inline=false` , CloudFormation will associate the variables to your EventType but not execute any changes to the variables."},"lastUpdatedTime":{"type":"string","description":"The time when the event type was last updated."},"name":{"type":"string","description":"The label name."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:frauddetector:EventTypeTag"},"description":"Tags associated with this event type."}},"type":"object"},"aws-native:frauddetector:EventTypeTag":{"properties":{"key":{"type":"string","description":"A tag key."},"value":{"type":"string","description":"A value assigned to a tag key."}},"type":"object","required":["key","value"]},"aws-native:frauddetector:LabelTag":{"properties":{"key":{"type":"string","description":"A tag key."},"value":{"type":"string","description":"A value assigned to a tag key."}},"type":"object","required":["key","value"]},"aws-native:frauddetector:ListTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:frauddetector:OutcomeTag":{"properties":{"key":{"type":"string","description":"A tag key."},"value":{"type":"string","description":"A value assigned to a tag key."}},"type":"object","required":["key","value"]},"aws-native:frauddetector:VariableDataSource":{"description":"The source of the data.","type":"string","enum":[{"name":"Event","value":"EVENT"},{"name":"ExternalModelScore","value":"EXTERNAL_MODEL_SCORE"}]},"aws-native:frauddetector:VariableDataType":{"description":"The data type.","type":"string","enum":[{"name":"String","value":"STRING"},{"name":"Integer","value":"INTEGER"},{"name":"Float","value":"FLOAT"},{"name":"Boolean","value":"BOOLEAN"}]},"aws-native:frauddetector:VariableTag":{"properties":{"key":{"type":"string","description":"A tag key."},"value":{"type":"string","description":"A value assigned to a tag key."}},"type":"object","required":["key","value"]},"aws-native:frauddetector:VariableType":{"description":"The variable type. For more information see https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types","type":"string","enum":[{"name":"AuthCode","value":"AUTH_CODE"},{"name":"Avs","value":"AVS"},{"name":"BillingAddressL1","value":"BILLING_ADDRESS_L1"},{"name":"BillingAddressL2","value":"BILLING_ADDRESS_L2"},{"name":"BillingCity","value":"BILLING_CITY"},{"name":"BillingCountry","value":"BILLING_COUNTRY"},{"name":"BillingName","value":"BILLING_NAME"},{"name":"BillingPhone","value":"BILLING_PHONE"},{"name":"BillingState","value":"BILLING_STATE"},{"name":"BillingZip","value":"BILLING_ZIP"},{"name":"CardBin","value":"CARD_BIN"},{"name":"Categorical","value":"CATEGORICAL"},{"name":"CurrencyCode","value":"CURRENCY_CODE"},{"name":"EmailAddress","value":"EMAIL_ADDRESS"},{"name":"Fingerprint","value":"FINGERPRINT"},{"name":"FraudLabel","value":"FRAUD_LABEL"},{"name":"FreeFormText","value":"FREE_FORM_TEXT"},{"name":"IpAddress","value":"IP_ADDRESS"},{"name":"Numeric","value":"NUMERIC"},{"name":"OrderId","value":"ORDER_ID"},{"name":"PaymentType","value":"PAYMENT_TYPE"},{"name":"PhoneNumber","value":"PHONE_NUMBER"},{"name":"Price","value":"PRICE"},{"name":"ProductCategory","value":"PRODUCT_CATEGORY"},{"name":"ShippingAddressL1","value":"SHIPPING_ADDRESS_L1"},{"name":"ShippingAddressL2","value":"SHIPPING_ADDRESS_L2"},{"name":"ShippingCity","value":"SHIPPING_CITY"},{"name":"ShippingCountry","value":"SHIPPING_COUNTRY"},{"name":"ShippingName","value":"SHIPPING_NAME"},{"name":"ShippingPhone","value":"SHIPPING_PHONE"},{"name":"ShippingState","value":"SHIPPING_STATE"},{"name":"ShippingZip","value":"SHIPPING_ZIP"},{"name":"Useragent","value":"USERAGENT"}]},"aws-native:fsx:DataRepositoryAssociationAutoExportPolicy":{"description":"Specifies the type of updated objects (new, changed, deleted) that will be automatically exported from your file system to the linked S3 bucket.","properties":{"events":{"type":"array","items":{"$ref":"#/types/aws-native:fsx:DataRepositoryAssociationEventType"},"description":"The `AutoExportPolicy` can have the following event values:\n\n- `NEW` - New files and directories are automatically exported to the data repository as they are added to the file system.\n- `CHANGED` - Changes to files and directories on the file system are automatically exported to the data repository.\n- `DELETED` - Files and directories are automatically deleted on the data repository when they are deleted on the file system.\n\nYou can define any combination of event types for your `AutoExportPolicy` ."}},"type":"object","required":["events"]},"aws-native:fsx:DataRepositoryAssociationAutoImportPolicy":{"description":"Specifies the type of updated objects (new, changed, deleted) that will be automatically imported from the linked S3 bucket to your file system.","properties":{"events":{"type":"array","items":{"$ref":"#/types/aws-native:fsx:DataRepositoryAssociationEventType"},"description":"The `AutoImportPolicy` can have the following event values:\n\n- `NEW` - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.\n- `CHANGED` - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.\n- `DELETED` - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.\n\nYou can define any combination of event types for your `AutoImportPolicy` ."}},"type":"object","required":["events"]},"aws-native:fsx:DataRepositoryAssociationEventType":{"type":"string","enum":[{"name":"New","value":"NEW"},{"name":"Changed","value":"CHANGED"},{"name":"Deleted","value":"DELETED"}]},"aws-native:fsx:DataRepositoryAssociationS3":{"description":"The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.","properties":{"autoExportPolicy":{"$ref":"#/types/aws-native:fsx:DataRepositoryAssociationAutoExportPolicy","description":"Describes a data repository association's automatic export policy. The `AutoExportPolicy` defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.\n\nThe `AutoExportPolicy` is only supported on Amazon FSx for Lustre file systems with a data repository association."},"autoImportPolicy":{"$ref":"#/types/aws-native:fsx:DataRepositoryAssociationAutoImportPolicy","description":"Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.\n\nThe `AutoImportPolicy` is only supported on Amazon FSx for Lustre file systems with a data repository association."}},"type":"object"},"aws-native:fsx:DataRepositoryAssociationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:fsx:S3AccessPointAttachmentFileSystemGid":{"properties":{"gid":{"type":"number","description":"The GID of the file system user."}},"type":"object","required":["gid"]},"aws-native:fsx:S3AccessPointAttachmentOntapFileSystemIdentity":{"properties":{"type":{"$ref":"#/types/aws-native:fsx:S3AccessPointAttachmentOntapFileSystemIdentityType","description":"Specifies the FSx for ONTAP user identity type, accepts either UNIX or WINDOWS."},"unixUser":{"$ref":"#/types/aws-native:fsx:S3AccessPointAttachmentOntapUnixFileSystemUser","description":"Specifies the properties of the file system UNIX user."},"windowsUser":{"$ref":"#/types/aws-native:fsx:S3AccessPointAttachmentOntapWindowsFileSystemUser","description":"Specifies the properties of the file system Windows user."}},"type":"object","required":["type"]},"aws-native:fsx:S3AccessPointAttachmentOntapFileSystemIdentityType":{"description":"Specifies the FSx for ONTAP user identity type, accepts either UNIX or WINDOWS.","type":"string","enum":[{"name":"Unix","value":"UNIX"},{"name":"Windows","value":"WINDOWS"}]},"aws-native:fsx:S3AccessPointAttachmentOntapUnixFileSystemUser":{"properties":{"name":{"type":"string","description":"The name of the UNIX user."}},"type":"object","required":["name"]},"aws-native:fsx:S3AccessPointAttachmentOntapWindowsFileSystemUser":{"properties":{"name":{"type":"string","description":"The name of the Windows user."}},"type":"object","required":["name"]},"aws-native:fsx:S3AccessPointAttachmentOpenZfsFileSystemIdentity":{"properties":{"posixUser":{"$ref":"#/types/aws-native:fsx:S3AccessPointAttachmentOpenZfsPosixFileSystemUser","description":"Specifies the UID and GIDs of the file system POSIX user."},"type":{"$ref":"#/types/aws-native:fsx:S3AccessPointAttachmentOpenZfsFileSystemIdentityType","description":"Specifies the FSx for OpenZFS user identity type, accepts only POSIX."}},"type":"object","required":["posixUser","type"]},"aws-native:fsx:S3AccessPointAttachmentOpenZfsFileSystemIdentityType":{"description":"Specifies the FSx for OpenZFS user identity type, accepts only POSIX.","type":"string","enum":[{"name":"Posix","value":"POSIX"}]},"aws-native:fsx:S3AccessPointAttachmentOpenZfsPosixFileSystemUser":{"properties":{"gid":{"type":"number","description":"The GID of the file system user."},"secondaryGids":{"type":"array","items":{"$ref":"#/types/aws-native:fsx:S3AccessPointAttachmentFileSystemGid"},"description":"The list of secondary GIDs for the file system user."},"uid":{"type":"number","description":"The UID of the file system user."}},"type":"object","required":["gid","uid"]},"aws-native:fsx:S3AccessPointAttachmentS3AccessPoint":{"properties":{"alias":{"type":"string","description":"The S3 access point's alias."},"policy":{"$ref":"pulumi.json#/Any","description":"The S3 access point's policy."},"resourceArn":{"type":"string","description":"The S3 access point's ARN."},"vpcConfiguration":{"$ref":"#/types/aws-native:fsx:S3AccessPointAttachmentS3AccessPointVpcConfiguration","description":"The S3 access point's virtual private cloud (VPC) configuration."}},"type":"object"},"aws-native:fsx:S3AccessPointAttachmentS3AccessPointOntapConfiguration":{"properties":{"fileSystemIdentity":{"$ref":"#/types/aws-native:fsx:S3AccessPointAttachmentOntapFileSystemIdentity","description":"The file system identity used to authorize file access requests made using the S3 access point."},"volumeId":{"type":"string","description":"The ID of the FSx for ONTAP volume that the S3 access point is attached to."}},"type":"object","required":["fileSystemIdentity","volumeId"]},"aws-native:fsx:S3AccessPointAttachmentS3AccessPointOpenZfsConfiguration":{"properties":{"fileSystemIdentity":{"$ref":"#/types/aws-native:fsx:S3AccessPointAttachmentOpenZfsFileSystemIdentity","description":"The file system identity used to authorize file access requests made using the S3 access point."},"volumeId":{"type":"string","description":"The ID of the FSx for OpenZFS volume that the S3 access point is attached to."}},"type":"object","required":["fileSystemIdentity","volumeId"]},"aws-native:fsx:S3AccessPointAttachmentS3AccessPointVpcConfiguration":{"properties":{"vpcId":{"type":"string","description":"Specifies the virtual private cloud (VPC) for the S3 access point VPC configuration, if one exists."}},"type":"object","required":["vpcId"]},"aws-native:fsx:S3AccessPointAttachmentType":{"description":"The type of Amazon FSx volume that the S3 access point is attached to.","type":"string","enum":[{"name":"Openzfs","value":"OPENZFS"},{"name":"Ontap","value":"ONTAP"}]},"aws-native:gamelift:AliasRoutingStrategy":{"properties":{"fleetId":{"type":"string","description":"A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property."},"message":{"type":"string","description":"The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property."},"type":{"$ref":"#/types/aws-native:gamelift:AliasRoutingStrategyType","description":"Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets."}},"type":"object","required":["type"]},"aws-native:gamelift:AliasRoutingStrategyType":{"description":"Simple routing strategy. The alias resolves to one specific fleet. Use this type when routing to active fleets.","type":"string","enum":[{"name":"Simple","value":"SIMPLE"},{"name":"Terminal","value":"TERMINAL"}]},"aws-native:gamelift:AliasTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length."}},"type":"object","required":["key","value"]},"aws-native:gamelift:BuildOperatingSystem":{"description":"The operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.","type":"string","enum":[{"name":"AmazonLinux","value":"AMAZON_LINUX"},{"name":"AmazonLinux2","value":"AMAZON_LINUX_2"},{"name":"AmazonLinux2023","value":"AMAZON_LINUX_2023"},{"name":"Windows2012","value":"WINDOWS_2012"},{"name":"Windows2016","value":"WINDOWS_2016"},{"name":"Windows2022","value":"WINDOWS_2022"}]},"aws-native:gamelift:BuildStorageLocation":{"properties":{"bucket":{"type":"string","description":"An Amazon S3 bucket identifier. This is the name of the S3 bucket."},"key":{"type":"string","description":"The name of the zip file that contains the build files or script files."},"objectVersion":{"type":"string","description":"The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket."}},"type":"object","required":["bucket","key","roleArn"]},"aws-native:gamelift:BuildTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length."}},"type":"object","required":["key","value"]},"aws-native:gamelift:ContainerFleetBillingType":{"description":"Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.","type":"string","enum":[{"name":"OnDemand","value":"ON_DEMAND"},{"name":"Spot","value":"SPOT"}]},"aws-native:gamelift:ContainerFleetConnectionPortRange":{"description":"Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.","properties":{"fromPort":{"type":"integer","description":"A starting value for a range of allowed port numbers."},"toPort":{"type":"integer","description":"An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort."}},"type":"object","required":["fromPort","toPort"]},"aws-native:gamelift:ContainerFleetDeploymentConfiguration":{"description":"Provides details about how to drain old tasks and replace them with new updated tasks.","properties":{"impairmentStrategy":{"$ref":"#/types/aws-native:gamelift:ContainerFleetDeploymentConfigurationImpairmentStrategy","description":"The strategy to apply in case of impairment; defaults to MAINTAIN."},"minimumHealthyPercentage":{"type":"integer","description":"The minimum percentage of healthy required; defaults to 75."},"protectionStrategy":{"$ref":"#/types/aws-native:gamelift:ContainerFleetDeploymentConfigurationProtectionStrategy","description":"The protection strategy for deployment on the container fleet; defaults to WITH_PROTECTION."}},"type":"object"},"aws-native:gamelift:ContainerFleetDeploymentConfigurationImpairmentStrategy":{"description":"The strategy to apply in case of impairment; defaults to MAINTAIN.","type":"string","enum":[{"name":"Maintain","value":"MAINTAIN"},{"name":"Rollback","value":"ROLLBACK"}]},"aws-native:gamelift:ContainerFleetDeploymentConfigurationProtectionStrategy":{"description":"The protection strategy for deployment on the container fleet; defaults to WITH_PROTECTION.","type":"string","enum":[{"name":"WithProtection","value":"WITH_PROTECTION"},{"name":"IgnoreProtection","value":"IGNORE_PROTECTION"}]},"aws-native:gamelift:ContainerFleetDeploymentDetails":{"description":"Provides information about the last deployment ID and its status.","properties":{"latestDeploymentId":{"type":"string","description":"The ID of the last deployment on the container fleet. This field will be empty if the container fleet does not have a ContainerGroupDefinition attached."}},"type":"object"},"aws-native:gamelift:ContainerFleetGameSessionCreationLimitPolicy":{"description":"A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: \"An individual player can create a maximum number of new game sessions within a specified time period\".\n\nThe policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.","properties":{"newGameSessionsPerCreator":{"type":"integer","description":"The maximum number of game sessions that an individual can create during the policy period."},"policyPeriodInMinutes":{"type":"integer","description":"The time span used in evaluating the resource creation limit policy."}},"type":"object"},"aws-native:gamelift:ContainerFleetIpPermission":{"description":"A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP, for use by the Realtime servers.","properties":{"fromPort":{"type":"integer","description":"A starting value for a range of allowed port numbers."},"ipRange":{"type":"string","description":"A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: \"000.000.000.000/[subnet mask]\" or optionally the shortened version \"0.0.0.0/[subnet mask]\"."},"protocol":{"$ref":"#/types/aws-native:gamelift:ContainerFleetIpPermissionProtocol","description":"The network communication protocol used by the fleet."},"toPort":{"type":"integer","description":"An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort."}},"type":"object","required":["fromPort","ipRange","protocol","toPort"]},"aws-native:gamelift:ContainerFleetIpPermissionProtocol":{"description":"The network communication protocol used by the fleet.","type":"string","enum":[{"name":"Tcp","value":"TCP"},{"name":"Udp","value":"UDP"}]},"aws-native:gamelift:ContainerFleetLocationCapacity":{"description":"Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.","properties":{"desiredEc2Instances":{"type":"integer","description":"Defaults to MinSize if not defined. The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. If any auto-scaling policy is defined for the container fleet, the desired instance will only be applied once during fleet creation and will be ignored in updates to avoid conflicts with auto-scaling. During updates with any auto-scaling policy defined, if current desired instance is lower than the new MinSize, it will be increased to the new MinSize; if current desired instance is larger than the new MaxSize, it will be decreased to the new MaxSize."},"managedCapacityConfiguration":{"$ref":"#/types/aws-native:gamelift:ContainerFleetManagedCapacityConfiguration","description":"Configuration options for Amazon GameLift Servers-managed capacity behavior."},"maxSize":{"type":"integer","description":"The maximum value that is allowed for the fleet's instance count for a location."},"minSize":{"type":"integer","description":"The minimum value allowed for the fleet's instance count for a location."}},"type":"object","required":["maxSize"]},"aws-native:gamelift:ContainerFleetLocationConfiguration":{"description":"A remote location where a multi-location fleet can deploy EC2 instances for game hosting.","properties":{"location":{"type":"string","description":"An AWS Region code, such as `us-west-2` . For a list of supported Regions and Local Zones, see [Amazon GameLift Servers service locations](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html) for managed hosting."},"locationCapacity":{"$ref":"#/types/aws-native:gamelift:ContainerFleetLocationCapacity"},"playerGatewayStatus":{"$ref":"#/types/aws-native:gamelift:ContainerFleetLocationConfigurationPlayerGatewayStatus","description":"The player gateway status for the location."},"stoppedActions":{"type":"array","items":{"$ref":"#/types/aws-native:gamelift:ContainerFleetStoppedActionsItem"}}},"type":"object","required":["location"]},"aws-native:gamelift:ContainerFleetLocationConfigurationPlayerGatewayStatus":{"description":"The player gateway status for the location.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:gamelift:ContainerFleetLogConfiguration":{"description":"A policy the location and provider of logs from the fleet.","properties":{"logDestination":{"$ref":"#/types/aws-native:gamelift:ContainerFleetLogDestination","description":"The type of log collection to use for a fleet.\n\n- `CLOUDWATCH` -- (default value) Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group.\n- `S3` -- Store logs in an Amazon S3 bucket that you define. This bucket must reside in the fleet's home AWS Region.\n- `NONE` -- Don't collect container logs."},"logGroupArn":{"type":"string","description":"If log destination is CLOUDWATCH, logs are sent to the specified log group in Amazon CloudWatch."},"s3BucketName":{"type":"string","description":"The name of the S3 bucket to pull logs from if S3 is the LogDestination"}},"type":"object"},"aws-native:gamelift:ContainerFleetLogDestination":{"description":"Configures the service that provides logs.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Cloudwatch","value":"CLOUDWATCH"},{"name":"S3","value":"S3"}]},"aws-native:gamelift:ContainerFleetManagedCapacityConfiguration":{"description":"Configuration options for Amazon GameLift Servers managed capacity behavior.","properties":{"scaleInAfterInactivityMinutes":{"type":"integer","description":"Length of time, in minutes, that Amazon GameLift Servers will wait before scaling in your MinSize and DesiredInstances to 0 after a period with no game session activity."},"zeroCapacityStrategy":{"$ref":"#/types/aws-native:gamelift:ContainerFleetManagedCapacityConfigurationZeroCapacityStrategy","description":"The strategy Amazon GameLift Servers will use to automatically scale your capacity to and from zero in response to game session activity. Game session activity refers to any active running sessions or game session requests. When set to SCALE_TO_AND_FROM_ZERO, MinSize must not be specified and will be managed automatically. When set to MANUAL, MinSize is required."}},"type":"object","required":["zeroCapacityStrategy"]},"aws-native:gamelift:ContainerFleetManagedCapacityConfigurationZeroCapacityStrategy":{"description":"The strategy Amazon GameLift Servers will use to automatically scale your capacity to and from zero in response to game session activity. Game session activity refers to any active running sessions or game session requests. When set to SCALE_TO_AND_FROM_ZERO, MinSize must not be specified and will be managed automatically. When set to MANUAL, MinSize is required.","type":"string","enum":[{"name":"ScaleToAndFromZero","value":"SCALE_TO_AND_FROM_ZERO"},{"name":"Manual","value":"MANUAL"}]},"aws-native:gamelift:ContainerFleetNewGameSessionProtectionPolicy":{"description":"A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.","type":"string","enum":[{"name":"FullProtection","value":"FullProtection"},{"name":"NoProtection","value":"NoProtection"}]},"aws-native:gamelift:ContainerFleetPlayerGatewayMode":{"description":"The player gateway mode for the container fleet.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"},{"name":"Required","value":"REQUIRED"}]},"aws-native:gamelift:ContainerFleetScalingPolicy":{"description":"Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.","properties":{"comparisonOperator":{"$ref":"#/types/aws-native:gamelift:ContainerFleetScalingPolicyComparisonOperator","description":"Comparison operator to use when measuring a metric against the threshold value."},"evaluationPeriods":{"type":"integer","description":"Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered."},"metricName":{"$ref":"#/types/aws-native:gamelift:ContainerFleetScalingPolicyMetricName","description":"Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment."},"name":{"type":"string","description":"A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique."},"policyType":{"$ref":"#/types/aws-native:gamelift:ContainerFleetScalingPolicyPolicyType","description":"The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment."},"scalingAdjustment":{"type":"integer","description":"Amount of adjustment to make, based on the scaling adjustment type."},"scalingAdjustmentType":{"$ref":"#/types/aws-native:gamelift:ContainerFleetScalingPolicyScalingAdjustmentType","description":"The type of adjustment to make to a fleet's instance count."},"targetConfiguration":{"$ref":"#/types/aws-native:gamelift:ContainerFleetTargetConfiguration","description":"An object that contains settings for a target-based scaling policy."},"threshold":{"type":"number","description":"Metric value used to trigger a scaling event."}},"type":"object","required":["metricName","name"]},"aws-native:gamelift:ContainerFleetScalingPolicyComparisonOperator":{"description":"Comparison operator to use when measuring a metric against the threshold value.","type":"string","enum":[{"name":"GreaterThanOrEqualToThreshold","value":"GreaterThanOrEqualToThreshold"},{"name":"GreaterThanThreshold","value":"GreaterThanThreshold"},{"name":"LessThanThreshold","value":"LessThanThreshold"},{"name":"LessThanOrEqualToThreshold","value":"LessThanOrEqualToThreshold"}]},"aws-native:gamelift:ContainerFleetScalingPolicyMetricName":{"description":"Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.","type":"string","enum":[{"name":"ActivatingGameSessions","value":"ActivatingGameSessions"},{"name":"ActiveGameSessions","value":"ActiveGameSessions"},{"name":"ActiveInstances","value":"ActiveInstances"},{"name":"AvailableGameSessions","value":"AvailableGameSessions"},{"name":"AvailablePlayerSessions","value":"AvailablePlayerSessions"},{"name":"CurrentPlayerSessions","value":"CurrentPlayerSessions"},{"name":"IdleInstances","value":"IdleInstances"},{"name":"PercentAvailableGameSessions","value":"PercentAvailableGameSessions"},{"name":"PercentIdleInstances","value":"PercentIdleInstances"},{"name":"QueueDepth","value":"QueueDepth"},{"name":"WaitTime","value":"WaitTime"},{"name":"ConcurrentActivatableGameSessions","value":"ConcurrentActivatableGameSessions"}]},"aws-native:gamelift:ContainerFleetScalingPolicyPolicyType":{"description":"The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.","type":"string","enum":[{"name":"RuleBased","value":"RuleBased"},{"name":"TargetBased","value":"TargetBased"}]},"aws-native:gamelift:ContainerFleetScalingPolicyScalingAdjustmentType":{"description":"The type of adjustment to make to a fleet's instance count.","type":"string","enum":[{"name":"ChangeInCapacity","value":"ChangeInCapacity"},{"name":"ExactCapacity","value":"ExactCapacity"},{"name":"PercentChangeInCapacity","value":"PercentChangeInCapacity"}]},"aws-native:gamelift:ContainerFleetStatus":{"description":"The current status of the container fleet.","type":"string","enum":[{"name":"Pending","value":"PENDING"},{"name":"Creating","value":"CREATING"},{"name":"Created","value":"CREATED"},{"name":"Activating","value":"ACTIVATING"},{"name":"Active","value":"ACTIVE"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"}]},"aws-native:gamelift:ContainerFleetStoppedActionsItem":{"type":"string","enum":[{"name":"AutoScaling","value":"AUTO_SCALING"}]},"aws-native:gamelift:ContainerFleetTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length."}},"type":"object","required":["key","value"]},"aws-native:gamelift:ContainerFleetTargetConfiguration":{"description":"Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.","properties":{"targetValue":{"type":"number","description":"Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions)."}},"type":"object","required":["targetValue"]},"aws-native:gamelift:ContainerGroupDefinitionContainerDependency":{"description":"A dependency that impacts a container's startup and shutdown.","properties":{"condition":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionContainerDependencyCondition","description":"The type of dependency."},"containerName":{"type":"string","description":"A descriptive label for the container definition. The container being defined depends on this container's condition."}},"type":"object","required":["condition","containerName"]},"aws-native:gamelift:ContainerGroupDefinitionContainerDependencyCondition":{"description":"The type of dependency.","type":"string","enum":[{"name":"Start","value":"START"},{"name":"Complete","value":"COMPLETE"},{"name":"Success","value":"SUCCESS"},{"name":"Healthy","value":"HEALTHY"}]},"aws-native:gamelift:ContainerGroupDefinitionContainerEnvironment":{"description":"An environment variable to set inside a container, in the form of a key-value pair.","properties":{"name":{"type":"string","description":"The environment variable name."},"value":{"type":"string","description":"The environment variable value."}},"type":"object","required":["name","value"]},"aws-native:gamelift:ContainerGroupDefinitionContainerGroupType":{"description":"The scope of the container group","type":"string","enum":[{"name":"GameServer","value":"GAME_SERVER"},{"name":"PerInstance","value":"PER_INSTANCE"}]},"aws-native:gamelift:ContainerGroupDefinitionContainerHealthCheck":{"description":"Specifies how the process manager checks the health of containers.","properties":{"command":{"type":"array","items":{"type":"string"},"description":"A string array representing the command that the container runs to determine if it is healthy."},"interval":{"type":"integer","description":"How often (in seconds) the health is checked."},"retries":{"type":"integer","description":"How many times the process manager will retry the command after a timeout. (The first run of the command does not count as a retry.)"},"startPeriod":{"type":"integer","description":"The optional grace period (in seconds) to give a container time to boostrap before teh health check is declared failed."},"timeout":{"type":"integer","description":"How many seconds the process manager allows the command to run before canceling it."}},"type":"object","required":["command"]},"aws-native:gamelift:ContainerGroupDefinitionContainerMountPoint":{"description":"Defines the mount point configuration within a container.","properties":{"accessLevel":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionContainerMountPointAccessLevel","description":"The access permissions for the mounted path."},"containerPath":{"type":"string","description":"The path inside the container where the mount is accessible."},"instancePath":{"type":"string","description":"The path on the host that will be mounted in the container."}},"type":"object","required":["instancePath"]},"aws-native:gamelift:ContainerGroupDefinitionContainerMountPointAccessLevel":{"description":"The access permissions for the mounted path.","type":"string","enum":[{"name":"ReadOnly","value":"READ_ONLY"},{"name":"ReadAndWrite","value":"READ_AND_WRITE"}]},"aws-native:gamelift:ContainerGroupDefinitionContainerPortRange":{"description":"A set of one or more port numbers that can be opened on the container.","properties":{"fromPort":{"type":"integer","description":"A starting value for the range of allowed port numbers."},"protocol":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionContainerPortRangeProtocol","description":"Defines the protocol of these ports."},"toPort":{"type":"integer","description":"An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort."}},"type":"object","required":["fromPort","protocol","toPort"]},"aws-native:gamelift:ContainerGroupDefinitionContainerPortRangeProtocol":{"description":"Defines the protocol of these ports.","type":"string","enum":[{"name":"Tcp","value":"TCP"},{"name":"Udp","value":"UDP"}]},"aws-native:gamelift:ContainerGroupDefinitionGameServerContainerDefinition":{"description":"Specifies the information required to run game servers with this container group","properties":{"containerName":{"type":"string","description":"A descriptive label for the container definition. Container definition names must be unique with a container group definition."},"dependsOn":{"type":"array","items":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionContainerDependency"},"description":"A list of container dependencies that determines when this container starts up and shuts down. For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers."},"environmentOverride":{"type":"array","items":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionContainerEnvironment"},"description":"The environment variables to pass to a container."},"imageUri":{"type":"string","description":"Specifies the image URI of this container."},"mountPoints":{"type":"array","items":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionContainerMountPoint"},"description":"A list of mount point configurations to be used in a container."},"portConfiguration":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionPortConfiguration","description":"Defines the ports on the container."},"resolvedImageDigest":{"type":"string","description":"The digest of the container image."},"serverSdkVersion":{"type":"string","description":"The version of the server SDK used in this container group"}},"type":"object","required":["containerName","imageUri","serverSdkVersion"]},"aws-native:gamelift:ContainerGroupDefinitionOperatingSystem":{"description":"The operating system of the container group","type":"string","enum":[{"name":"AmazonLinux2023","value":"AMAZON_LINUX_2023"}]},"aws-native:gamelift:ContainerGroupDefinitionPortConfiguration":{"description":"Defines the ports on a container.","properties":{"containerPortRanges":{"type":"array","items":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionContainerPortRange"},"description":"Specifies one or more ranges of ports on a container."}},"type":"object","required":["containerPortRanges"]},"aws-native:gamelift:ContainerGroupDefinitionStatus":{"description":"A string indicating ContainerGroupDefinition status.","type":"string","enum":[{"name":"Ready","value":"READY"},{"name":"Copying","value":"COPYING"},{"name":"Failed","value":"FAILED"}]},"aws-native:gamelift:ContainerGroupDefinitionSupportContainerDefinition":{"description":"Supports the function of the main container group","properties":{"containerName":{"type":"string","description":"A descriptive label for the container definition."},"dependsOn":{"type":"array","items":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionContainerDependency"},"description":"A list of container dependencies that determines when this container starts up and shuts down. For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers."},"environmentOverride":{"type":"array","items":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionContainerEnvironment"},"description":"The environment variables to pass to a container."},"essential":{"type":"boolean","description":"Specifies if the container is essential. If an essential container fails a health check, then all containers in the container group will be restarted. You must specify exactly 1 essential container in a container group."},"healthCheck":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionContainerHealthCheck","description":"Specifies how the health of the containers will be checked."},"imageUri":{"type":"string","description":"Specifies the image URI of this container."},"memoryHardLimitMebibytes":{"type":"integer","description":"The total memory limit of container groups following this definition in MiB"},"mountPoints":{"type":"array","items":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionContainerMountPoint"},"description":"A list of mount point configurations to be used in a container."},"portConfiguration":{"$ref":"#/types/aws-native:gamelift:ContainerGroupDefinitionPortConfiguration","description":"Defines the ports on the container."},"resolvedImageDigest":{"type":"string","description":"The digest of the container image."},"vcpu":{"type":"number","description":"The number of virtual CPUs to give to the support group"}},"type":"object","required":["containerName","imageUri"]},"aws-native:gamelift:ContainerGroupDefinitionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length."}},"type":"object","required":["key","value"]},"aws-native:gamelift:FleetAnywhereConfiguration":{"description":"Configuration for Anywhere fleet.","properties":{"cost":{"type":"string","description":"Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost."}},"type":"object","required":["cost"]},"aws-native:gamelift:FleetApplyCapacity":{"description":"Determines when and how to apply fleet or location capacities. Allowed options are ON_UPDATE (default), ON_CREATE_AND_UPDATE and ON_CREATE_AND_UPDATE_WITH_AUTOSCALING. If you choose ON_CREATE_AND_UPDATE_WITH_AUTOSCALING, MinSize and MaxSize will still be applied on creation and on updates, but DesiredEC2Instances will only be applied once on fleet creation and will be ignored during updates to prevent conflicts with auto-scaling. During updates with ON_CREATE_AND_UPDATE_WITH_AUTOSCALING chosen, if current desired instance is lower than the new MinSize, it will be increased to the new MinSize; if current desired instance is larger than the new MaxSize, it will be decreased to the new MaxSize.","type":"string","enum":[{"name":"OnUpdate","value":"ON_UPDATE"},{"name":"OnCreateAndUpdate","value":"ON_CREATE_AND_UPDATE"},{"name":"OnCreateAndUpdateWithAutoscaling","value":"ON_CREATE_AND_UPDATE_WITH_AUTOSCALING"}]},"aws-native:gamelift:FleetCertificateConfiguration":{"description":"Information about the use of a TLS/SSL certificate for a fleet. TLS certificate generation is enabled at the fleet level, with one certificate generated for the fleet. When this feature is enabled, the certificate can be retrieved using the GameLift Server SDK call GetInstanceCertificate. All instances in a fleet share the same certificate.","properties":{"certificateType":{"$ref":"#/types/aws-native:gamelift:FleetCertificateConfigurationCertificateType","description":"Indicates whether a TLS/SSL certificate is generated for a fleet.\n\nValid values include:\n\n- *GENERATED* - Generate a TLS/SSL certificate for this fleet.\n- *DISABLED* - (default) Do not generate a TLS/SSL certificate for this fleet."}},"type":"object","required":["certificateType"]},"aws-native:gamelift:FleetCertificateConfigurationCertificateType":{"description":"Indicates whether a TLS/SSL certificate is generated for a fleet.\n\nValid values include:\n\n- *GENERATED* - Generate a TLS/SSL certificate for this fleet.\n- *DISABLED* - (default) Do not generate a TLS/SSL certificate for this fleet.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Generated","value":"GENERATED"}]},"aws-native:gamelift:FleetComputeType":{"description":"ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer.","type":"string","enum":[{"name":"Ec2","value":"EC2"},{"name":"Anywhere","value":"ANYWHERE"}]},"aws-native:gamelift:FleetInstanceRoleCredentialsProvider":{"description":"Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service.","type":"string","enum":[{"name":"SharedCredentialFile","value":"SHARED_CREDENTIAL_FILE"}]},"aws-native:gamelift:FleetIpPermission":{"description":"A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP, for use by the Realtime servers.","properties":{"fromPort":{"type":"integer","description":"A starting value for a range of allowed port numbers."},"ipRange":{"type":"string","description":"A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: \"000.000.000.000/[subnet mask]\" or optionally the shortened version \"0.0.0.0/[subnet mask]\"."},"protocol":{"$ref":"#/types/aws-native:gamelift:FleetIpPermissionProtocol","description":"The network communication protocol used by the fleet."},"toPort":{"type":"integer","description":"An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort."}},"type":"object","required":["fromPort","ipRange","protocol","toPort"]},"aws-native:gamelift:FleetIpPermissionProtocol":{"description":"The network communication protocol used by the fleet.","type":"string","enum":[{"name":"Tcp","value":"TCP"},{"name":"Udp","value":"UDP"}]},"aws-native:gamelift:FleetLocationCapacity":{"description":"Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region.","properties":{"desiredEc2Instances":{"type":"integer","description":"Defaults to MinSize if not defined. The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits."},"managedCapacityConfiguration":{"$ref":"#/types/aws-native:gamelift:FleetManagedCapacityConfiguration","description":"Configuration options for Amazon GameLift Servers-managed capacity behavior."},"maxSize":{"type":"integer","description":"The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to \"1\". Once the fleet is active, you can change this value."},"minSize":{"type":"integer","description":"The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to \"0\". After the fleet is active, you can change this value."}},"type":"object","required":["maxSize"]},"aws-native:gamelift:FleetLocationConfiguration":{"description":"A remote location where a multi-location fleet can deploy EC2 instances for game hosting.","properties":{"location":{"type":"string","description":"An AWS Region code, such as `us-west-2` . For a list of supported Regions and Local Zones, see [Amazon GameLift Servers service locations](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html) for managed hosting."},"locationCapacity":{"$ref":"#/types/aws-native:gamelift:FleetLocationCapacity","description":"Current resource capacity settings for managed EC2 fleets and managed container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.\n\n*Returned by:* [DescribeFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) , [DescribeFleetLocationCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html) , [UpdateFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html)"},"playerGatewayStatus":{"$ref":"#/types/aws-native:gamelift:FleetLocationConfigurationPlayerGatewayStatus","description":"The player gateway status for the location."}},"type":"object","required":["location"]},"aws-native:gamelift:FleetLocationConfigurationPlayerGatewayStatus":{"description":"The player gateway status for the location.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:gamelift:FleetManagedCapacityConfiguration":{"description":"Configuration options for Amazon GameLift Servers-managed capacity behavior.","properties":{"scaleInAfterInactivityMinutes":{"type":"integer","description":"Length of time, in minutes, that Amazon GameLift Servers will wait before scaling in your MinSize and DesiredInstances to 0 after a period with no game session activity."},"zeroCapacityStrategy":{"$ref":"#/types/aws-native:gamelift:FleetManagedCapacityConfigurationZeroCapacityStrategy","description":"The strategy Amazon GameLift Servers will use to automatically scale your capacity to and from zero in response to game session activity. Game session activity refers to any active running sessions or game session requests. When set to SCALE_TO_AND_FROM_ZERO, MinSize must not be specified and will be managed automatically. When set to MANUAL, MinSize is required."}},"type":"object","required":["zeroCapacityStrategy"]},"aws-native:gamelift:FleetManagedCapacityConfigurationZeroCapacityStrategy":{"description":"The strategy Amazon GameLift Servers will use to automatically scale your capacity to and from zero in response to game session activity. Game session activity refers to any active running sessions or game session requests. When set to SCALE_TO_AND_FROM_ZERO, MinSize must not be specified and will be managed automatically. When set to MANUAL, MinSize is required.","type":"string","enum":[{"name":"ScaleToAndFromZero","value":"SCALE_TO_AND_FROM_ZERO"},{"name":"Manual","value":"MANUAL"}]},"aws-native:gamelift:FleetNewGameSessionProtectionPolicy":{"description":"A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.","type":"string","enum":[{"name":"FullProtection","value":"FullProtection"},{"name":"NoProtection","value":"NoProtection"}]},"aws-native:gamelift:FleetPlayerGatewayConfiguration":{"description":"Configuration for player gateway.","properties":{"gameServerIpProtocolSupported":{"$ref":"#/types/aws-native:gamelift:FleetPlayerGatewayConfigurationGameServerIpProtocolSupported","description":"The IP protocol supported by the game server."}},"type":"object"},"aws-native:gamelift:FleetPlayerGatewayConfigurationGameServerIpProtocolSupported":{"description":"The IP protocol supported by the game server.","type":"string","enum":[{"name":"IPv4","value":"IPv4"},{"name":"DualStack","value":"DUAL_STACK"}]},"aws-native:gamelift:FleetPlayerGatewayMode":{"description":"The player gateway mode for the fleet.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"},{"name":"Required","value":"REQUIRED"}]},"aws-native:gamelift:FleetResourceCreationLimitPolicy":{"description":"A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: \"An individual player can create a maximum number of new game sessions within a specified time period\".\n\nThe policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.","properties":{"newGameSessionsPerCreator":{"type":"integer","description":"The maximum number of game sessions that an individual can create during the policy period."},"policyPeriodInMinutes":{"type":"integer","description":"The time span used in evaluating the resource creation limit policy."}},"type":"object"},"aws-native:gamelift:FleetRuntimeConfiguration":{"description":"A collection of server process configurations that describe the processes to run on each instance in a fleet. All fleets must have a runtime configuration. Each instance in the fleet maintains server processes as specified in the runtime configuration, launching new ones as existing processes end. Each instance regularly checks for an updated runtime configuration makes adjustments as called for.\n\nThe runtime configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different executables, such as your game server and a metrics tracking program. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each instance in debug mode.\n\nAn Amazon GameLift instance is limited to 50 processes running simultaneously. A runtime configuration must specify fewer than this limit. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration.","properties":{"gameSessionActivationTimeoutSeconds":{"type":"integer","description":"The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED."},"maxConcurrentGameSessionActivations":{"type":"integer","description":"The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time."},"serverProcesses":{"type":"array","items":{"$ref":"#/types/aws-native:gamelift:FleetServerProcess"},"description":"A collection of server process configurations that describe which server processes to run on each instance in a fleet."}},"type":"object"},"aws-native:gamelift:FleetScalingPolicy":{"description":"Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.","properties":{"comparisonOperator":{"$ref":"#/types/aws-native:gamelift:FleetScalingPolicyComparisonOperator","description":"Comparison operator to use when measuring a metric against the threshold value."},"evaluationPeriods":{"type":"integer","description":"Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered."},"location":{"type":"string","description":"The fleet location."},"metricName":{"$ref":"#/types/aws-native:gamelift:FleetScalingPolicyMetricName","description":"Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment."},"name":{"type":"string","description":"A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique."},"policyType":{"$ref":"#/types/aws-native:gamelift:FleetScalingPolicyPolicyType","description":"The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment."},"scalingAdjustment":{"type":"integer","description":"Amount of adjustment to make, based on the scaling adjustment type."},"scalingAdjustmentType":{"$ref":"#/types/aws-native:gamelift:FleetScalingPolicyScalingAdjustmentType","description":"The type of adjustment to make to a fleet's instance count."},"status":{"$ref":"#/types/aws-native:gamelift:FleetScalingPolicyStatus","description":"Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change."},"targetConfiguration":{"$ref":"#/types/aws-native:gamelift:FleetTargetConfiguration","description":"An object that contains settings for a target-based scaling policy."},"threshold":{"type":"number","description":"Metric value used to trigger a scaling event."},"updateStatus":{"$ref":"#/types/aws-native:gamelift:FleetScalingPolicyUpdateStatus","description":"The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location."}},"type":"object","required":["metricName","name"]},"aws-native:gamelift:FleetScalingPolicyComparisonOperator":{"description":"Comparison operator to use when measuring a metric against the threshold value.","type":"string","enum":[{"name":"GreaterThanOrEqualToThreshold","value":"GreaterThanOrEqualToThreshold"},{"name":"GreaterThanThreshold","value":"GreaterThanThreshold"},{"name":"LessThanThreshold","value":"LessThanThreshold"},{"name":"LessThanOrEqualToThreshold","value":"LessThanOrEqualToThreshold"}]},"aws-native:gamelift:FleetScalingPolicyMetricName":{"description":"Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.","type":"string","enum":[{"name":"ActivatingGameSessions","value":"ActivatingGameSessions"},{"name":"ActiveGameSessions","value":"ActiveGameSessions"},{"name":"ActiveInstances","value":"ActiveInstances"},{"name":"AvailableGameSessions","value":"AvailableGameSessions"},{"name":"AvailablePlayerSessions","value":"AvailablePlayerSessions"},{"name":"CurrentPlayerSessions","value":"CurrentPlayerSessions"},{"name":"IdleInstances","value":"IdleInstances"},{"name":"PercentAvailableGameSessions","value":"PercentAvailableGameSessions"},{"name":"PercentIdleInstances","value":"PercentIdleInstances"},{"name":"QueueDepth","value":"QueueDepth"},{"name":"WaitTime","value":"WaitTime"},{"name":"ConcurrentActivatableGameSessions","value":"ConcurrentActivatableGameSessions"}]},"aws-native:gamelift:FleetScalingPolicyPolicyType":{"description":"The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.","type":"string","enum":[{"name":"RuleBased","value":"RuleBased"},{"name":"TargetBased","value":"TargetBased"}]},"aws-native:gamelift:FleetScalingPolicyScalingAdjustmentType":{"description":"The type of adjustment to make to a fleet's instance count.","type":"string","enum":[{"name":"ChangeInCapacity","value":"ChangeInCapacity"},{"name":"ExactCapacity","value":"ExactCapacity"},{"name":"PercentChangeInCapacity","value":"PercentChangeInCapacity"}]},"aws-native:gamelift:FleetScalingPolicyStatus":{"description":"Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.","type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"UpdateRequested","value":"UPDATE_REQUESTED"},{"name":"Updating","value":"UPDATING"},{"name":"DeleteRequested","value":"DELETE_REQUESTED"},{"name":"Deleting","value":"DELETING"},{"name":"Deleted","value":"DELETED"},{"name":"Error","value":"ERROR"}]},"aws-native:gamelift:FleetScalingPolicyUpdateStatus":{"description":"The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.","type":"string","enum":[{"name":"PendingUpdate","value":"PENDING_UPDATE"}]},"aws-native:gamelift:FleetServerProcess":{"description":"A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration.","properties":{"concurrentExecutions":{"type":"integer","description":"The number of server processes that use this configuration to run concurrently on an instance."},"launchPath":{"type":"string","description":"The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:\n\nWindows (for custom game builds only): C:\\game. Example: \"C:\\game\\MyGame\\server.exe\"\n\nLinux: /local/game. Examples: \"/local/game/MyGame/server.exe\" or \"/local/game/MyRealtimeScript.js\""},"parameters":{"type":"string","description":"An optional list of parameters to pass to the server executable or Realtime script on launch."}},"type":"object","required":["concurrentExecutions","launchPath"]},"aws-native:gamelift:FleetTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length."}},"type":"object","required":["key","value"]},"aws-native:gamelift:FleetTargetConfiguration":{"description":"Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.","properties":{"targetValue":{"type":"number","description":"Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions)."}},"type":"object","required":["targetValue"]},"aws-native:gamelift:FleetType":{"description":"Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.","type":"string","enum":[{"name":"OnDemand","value":"ON_DEMAND"},{"name":"Spot","value":"SPOT"}]},"aws-native:gamelift:GameServerGroupAutoScalingPolicy":{"description":"Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.","properties":{"estimatedInstanceWarmup":{"type":"number","description":"Length of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon GameLift Servers FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances."},"targetTrackingConfiguration":{"$ref":"#/types/aws-native:gamelift:GameServerGroupTargetTrackingConfiguration","description":"Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric `PercentUtilizedGameServers` and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value."}},"type":"object","required":["targetTrackingConfiguration"]},"aws-native:gamelift:GameServerGroupBalancingStrategy":{"description":"The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.","type":"string","enum":[{"name":"SpotOnly","value":"SPOT_ONLY"},{"name":"SpotPreferred","value":"SPOT_PREFERRED"},{"name":"OnDemandOnly","value":"ON_DEMAND_ONLY"}]},"aws-native:gamelift:GameServerGroupDeleteOption":{"description":"The type of delete to perform.","type":"string","enum":[{"name":"SafeDelete","value":"SAFE_DELETE"},{"name":"ForceDelete","value":"FORCE_DELETE"},{"name":"Retain","value":"RETAIN"}]},"aws-native:gamelift:GameServerGroupGameServerProtectionPolicy":{"description":"A flag that indicates whether instances in the game server group are protected from early termination.","type":"string","enum":[{"name":"NoProtection","value":"NO_PROTECTION"},{"name":"FullProtection","value":"FULL_PROTECTION"}]},"aws-native:gamelift:GameServerGroupInstanceDefinition":{"description":"An allowed instance type for your game server group.","properties":{"instanceType":{"type":"string"},"weightedCapacity":{"type":"string"}},"type":"object","required":["instanceType"]},"aws-native:gamelift:GameServerGroupLaunchTemplate":{"description":"The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource.","properties":{"launchTemplateId":{"type":"string","description":"A unique identifier for an existing Amazon EC2 launch template."},"launchTemplateName":{"type":"string","description":"A readable identifier for an existing Amazon EC2 launch template."},"version":{"type":"string","description":"The version of the Amazon EC2 launch template to use. If no version is specified, the default version will be used. With Amazon EC2, you can specify a default version for a launch template. If none is set, the default is the first version created."}},"type":"object"},"aws-native:gamelift:GameServerGroupTag":{"properties":{"key":{"type":"string","description":"The key for a developer-defined key:value pair for tagging an AWS resource."},"value":{"type":"string","description":"The value for a developer-defined key:value pair for tagging an AWS resource."}},"type":"object"},"aws-native:gamelift:GameServerGroupTargetTrackingConfiguration":{"description":"Settings for a target-based scaling policy applied to Auto Scaling group.","properties":{"targetValue":{"type":"number","description":"Desired value to use with a game server group target-based scaling policy."}},"type":"object","required":["targetValue"]},"aws-native:gamelift:GameSessionQueueDestination":{"description":"A fleet or alias designated in a game session queue.","properties":{"destinationArn":{"type":"string","description":"The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions."}},"type":"object"},"aws-native:gamelift:GameSessionQueueFilterConfiguration":{"properties":{"allowedLocations":{"type":"array","items":{"type":"string"},"description":"A list of locations to allow game session placement in, in the form of AWS Region codes such as `us-west-2` ."}},"type":"object"},"aws-native:gamelift:GameSessionQueuePlayerLatencyPolicy":{"description":"Sets a latency cap for individual players when placing a game session.","properties":{"maximumIndividualPlayerLatencyMilliseconds":{"type":"integer","description":"The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property."},"policyDurationSeconds":{"type":"integer","description":"The length of time, in seconds, that the policy is enforced while placing a new game session."}},"type":"object"},"aws-native:gamelift:GameSessionQueuePriorityConfiguration":{"properties":{"locationOrder":{"type":"array","items":{"type":"string"},"description":"The prioritization order to use for fleet locations, when the `PriorityOrder` property includes `LOCATION` . Locations can include AWS Region codes (such as `us-west-2` ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see [Amazon GameLift Servers service locations.](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html)"},"priorityOrder":{"type":"array","items":{"$ref":"#/types/aws-native:gamelift:GameSessionQueuePriorityOrderItem"},"description":"A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.\n\n- `LATENCY` -- Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.\n- `COST` -- Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination's location, instance type, and fleet type (Spot or On-Demand).\n- `DESTINATION` -- Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration.\n- `LOCATION` -- Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in `LocationOrder` ."}},"type":"object"},"aws-native:gamelift:GameSessionQueuePriorityOrderItem":{"type":"string","enum":[{"name":"Latency","value":"LATENCY"},{"name":"Cost","value":"COST"},{"name":"Destination","value":"DESTINATION"},{"name":"Location","value":"LOCATION"}]},"aws-native:gamelift:GameSessionQueueTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length."}},"type":"object","required":["key","value"]},"aws-native:gamelift:LocationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length."}},"type":"object","required":["key","value"]},"aws-native:gamelift:MatchmakingConfigurationBackfillMode":{"description":"The method used to backfill game sessions created with this matchmaking configuration.","type":"string","enum":[{"name":"Automatic","value":"AUTOMATIC"},{"name":"Manual","value":"MANUAL"}]},"aws-native:gamelift:MatchmakingConfigurationFlexMatchMode":{"description":"Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.","type":"string","enum":[{"name":"Standalone","value":"STANDALONE"},{"name":"WithQueue","value":"WITH_QUEUE"}]},"aws-native:gamelift:MatchmakingConfigurationGameProperty":{"description":"A key-value pair that contains information about a game session.","properties":{"key":{"type":"string","description":"The game property identifier."},"value":{"type":"string","description":"The game property value."}},"type":"object","required":["key","value"]},"aws-native:gamelift:MatchmakingConfigurationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length."}},"type":"object","required":["key","value"]},"aws-native:gamelift:MatchmakingRuleSetTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length."}},"type":"object","required":["key","value"]},"aws-native:gamelift:ScriptS3Location":{"properties":{"bucket":{"type":"string","description":"An Amazon S3 bucket identifier. This is the name of the S3 bucket."},"key":{"type":"string","description":"The name of the zip file that contains the script files."},"objectVersion":{"type":"string","description":"The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket."}},"type":"object","required":["bucket","key","roleArn"]},"aws-native:gamelift:ScriptTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length."}},"type":"object","required":["key","value"]},"aws-native:gameliftstreams:ApplicationRuntimeEnvironment":{"properties":{"type":{"type":"string","description":"The operating system and other drivers. For Proton, this also includes the Proton compatibility layer."},"version":{"type":"string","description":"Versioned container environment for the application operating system."}},"type":"object","required":["type","version"]},"aws-native:gameliftstreams:StreamGroupDefaultApplication":{"properties":{"arn":{"type":"string","description":"An [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) that uniquely identifies the application resource. Example ARN: `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6` ."},"id":{"type":"string","description":"An ID that uniquely identifies the application resource. Example ID: `a-9ZY8X7Wv6` .","replaceOnChanges":true}},"type":"object"},"aws-native:gameliftstreams:StreamGroupLocationConfiguration":{"properties":{"alwaysOnCapacity":{"type":"integer","description":"This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle."},"locationName":{"type":"string","description":"A location's name. For example, `us-east-1` . For a complete list of locations that Amazon GameLift Streams supports, refer to [Regions, quotas, and limitations](https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html) in the *Amazon GameLift Streams Developer Guide* ."},"maximumCapacity":{"type":"integer"},"onDemandCapacity":{"type":"integer","description":"This shape is deprecated."},"targetIdleCapacity":{"type":"integer"}},"type":"object","required":["locationName"]},"aws-native:globalaccelerator:AcceleratorIpAddressType":{"description":"IP Address type.","type":"string","enum":[{"name":"Ipv4","value":"IPV4"},{"name":"DualStack","value":"DUAL_STACK"}]},"aws-native:globalaccelerator:AcceleratorTag":{"description":"Tag is a key-value pair associated with accelerator.","properties":{"key":{"type":"string","description":"Key of the tag. Value can be 1 to 127 characters."},"value":{"type":"string","description":"Value for the tag. Value can be 1 to 255 characters."}},"type":"object","required":["key","value"]},"aws-native:globalaccelerator:CrossAccountAttachmentResource":{"description":"ARN of resource to share.","properties":{"cidr":{"type":"string","description":"An IP address range, in CIDR format, that is specified as resource. The address must be provisioned and advertised in AWS Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator\n\nFor more information, see [Bring your own IP addresses (BYOIP)](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in the AWS Global Accelerator Developer Guide."},"endpointId":{"type":"string","description":"The endpoint ID for the endpoint that is specified as a AWS resource.\n\nAn endpoint ID for the cross-account feature is the ARN of an AWS resource, such as a Network Load Balancer, that Global Accelerator supports as an endpoint for an accelerator."},"region":{"type":"string","description":"The AWS Region where a shared endpoint resource is located."}},"type":"object"},"aws-native:globalaccelerator:CrossAccountAttachmentTag":{"description":"Tag is a key-value pair associated with Cross Account Attachment.","properties":{"key":{"type":"string","description":"Key of the tag. Value can be 1 to 127 characters."},"value":{"type":"string","description":"Value for the tag. Value can be 1 to 255 characters."}},"type":"object","required":["key","value"]},"aws-native:globalaccelerator:EndpointGroupEndpointConfiguration":{"description":"The configuration for a given endpoint","properties":{"attachmentArn":{"type":"string","description":"Attachment ARN that provides access control to the cross account endpoint. Not required for resources hosted in the same account as the endpoint group."},"clientIpPreservationEnabled":{"type":"boolean","description":"true if client ip should be preserved"},"endpointId":{"type":"string","description":"Id of the endpoint. For Network/Application Load Balancer this value is the ARN.  For EIP, this value is the allocation ID.  For EC2 instances, this is the EC2 instance ID"},"weight":{"type":"integer","description":"The weight for the endpoint."}},"type":"object","required":["endpointId"]},"aws-native:globalaccelerator:EndpointGroupHealthCheckProtocol":{"description":"The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.","type":"string","enum":[{"name":"Tcp","value":"TCP"},{"name":"Http","value":"HTTP"},{"name":"Https","value":"HTTPS"}]},"aws-native:globalaccelerator:EndpointGroupPortOverride":{"description":"listener to endpoint port mapping.","properties":{"endpointPort":{"type":"integer","description":"The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance."},"listenerPort":{"type":"integer","description":"The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on."}},"type":"object","required":["endpointPort","listenerPort"]},"aws-native:globalaccelerator:ListenerClientAffinity":{"description":"Client affinity lets you direct all requests from a user to the same endpoint.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"SourceIp","value":"SOURCE_IP"}]},"aws-native:globalaccelerator:ListenerPortRange":{"description":"A port range to support for connections from  clients to your accelerator.","properties":{"fromPort":{"type":"integer","description":"The first port in the range of ports, inclusive."},"toPort":{"type":"integer","description":"The last port in the range of ports, inclusive."}},"type":"object","required":["fromPort","toPort"]},"aws-native:globalaccelerator:ListenerProtocol":{"description":"The protocol for the listener.","type":"string","enum":[{"name":"Tcp","value":"TCP"},{"name":"Udp","value":"UDP"}]},"aws-native:glue:CrawlerCatalogTarget":{"description":"Specifies an AWS Glue Data Catalog target.","properties":{"connectionName":{"type":"string","description":"The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type."},"databaseName":{"type":"string","description":"The name of the database to be synchronized."},"dlqEventQueueArn":{"type":"string","description":"A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue."},"eventQueueArn":{"type":"string","description":"A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs."},"tables":{"type":"array","items":{"type":"string"},"description":"A list of the tables to be synchronized."}},"type":"object"},"aws-native:glue:CrawlerDeltaTarget":{"description":"Specifies a Delta data store to crawl one or more Delta tables.","properties":{"connectionName":{"type":"string","description":"The name of the connection to use to connect to the Delta table target."},"createNativeDeltaTable":{"type":"boolean","description":"Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly."},"deltaTables":{"type":"array","items":{"type":"string"},"description":"A list of the Amazon S3 paths to the Delta tables."},"writeManifest":{"type":"boolean","description":"Specifies whether to write the manifest files to the Delta table path."}},"type":"object"},"aws-native:glue:CrawlerDynamoDbTarget":{"description":"Specifies an Amazon DynamoDB table to crawl.","properties":{"path":{"type":"string","description":"The name of the DynamoDB table to crawl."},"scanAll":{"type":"boolean","description":"Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table. A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true."},"scanRate":{"type":"number","description":"The percentage of the configured read capacity units to use by the AWS Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.\n\nThe valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode)."}},"type":"object"},"aws-native:glue:CrawlerHudiTarget":{"description":"Specifies Apache Hudi data store targets.","properties":{"connectionName":{"type":"string","description":"The name of the connection to use to connect to the Hudi target."},"exclusions":{"type":"array","items":{"type":"string"},"description":"A list of global patterns used to exclude from the crawl."},"maximumTraversalDepth":{"type":"integer","description":"The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time."},"paths":{"type":"array","items":{"type":"string"},"description":"One or more Amazon S3 paths that contains Hudi metadata folders as s3://bucket/prefix ."}},"type":"object"},"aws-native:glue:CrawlerIcebergTarget":{"description":"Specifies Apache Iceberg data store targets.","properties":{"connectionName":{"type":"string","description":"The name of the connection to use to connect to the Iceberg target."},"exclusions":{"type":"array","items":{"type":"string"},"description":"A list of global patterns used to exclude from the crawl."},"maximumTraversalDepth":{"type":"integer","description":"The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time."},"paths":{"type":"array","items":{"type":"string"},"description":"One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix ."}},"type":"object"},"aws-native:glue:CrawlerJdbcTarget":{"description":"Specifies a JDBC data store to crawl.","properties":{"connectionName":{"type":"string","description":"The name of the connection to use to connect to the JDBC target."},"enableAdditionalMetadata":{"type":"array","items":{"type":"string"},"description":"Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database.\n\nIf you do not need additional metadata, keep the field empty."},"exclusions":{"type":"array","items":{"type":"string"},"description":"A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler."},"path":{"type":"string","description":"The path of the JDBC target."}},"type":"object"},"aws-native:glue:CrawlerLakeFormationConfiguration":{"description":"Specifies AWS Lake Formation configuration settings for the crawler","properties":{"accountId":{"type":"string","description":"Required for cross account crawls. For same account crawls as the target data, this can be left as null."},"useLakeFormationCredentials":{"type":"boolean","description":"Specifies whether to use AWS Lake Formation credentials for the crawler instead of the IAM role credentials."}},"type":"object"},"aws-native:glue:CrawlerMongoDbTarget":{"description":"Specifies an Amazon DocumentDB or MongoDB data store to crawl.","properties":{"connectionName":{"type":"string","description":"The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target."},"path":{"type":"string","description":"The path of the Amazon DocumentDB or MongoDB target (database/collection)."}},"type":"object"},"aws-native:glue:CrawlerRecrawlPolicy":{"description":"When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in AWS Glue in the developer guide.","properties":{"recrawlBehavior":{"type":"string","description":"Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. A value of CRAWL_EVERYTHING specifies crawling the entire dataset again. A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run. A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events."}},"type":"object"},"aws-native:glue:CrawlerS3Target":{"description":"Specifies a data store in Amazon Simple Storage Service (Amazon S3).","properties":{"connectionName":{"type":"string","description":"The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC)."},"dlqEventQueueArn":{"type":"string","description":"A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue."},"eventQueueArn":{"type":"string","description":"A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs."},"exclusions":{"type":"array","items":{"type":"string"},"description":"A list of glob patterns used to exclude from the crawl."},"path":{"type":"string","description":"The path to the Amazon S3 target."},"sampleSize":{"type":"integer","description":"Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249."}},"type":"object"},"aws-native:glue:CrawlerSchedule":{"description":"A scheduling object using a cron statement to schedule an event.","properties":{"scheduleExpression":{"type":"string","description":"A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *)."}},"type":"object"},"aws-native:glue:CrawlerSchemaChangePolicy":{"description":"The policy that specifies update and delete behaviors for the crawler. The policy tells the crawler what to do in the event that it detects a change in a table that already exists in the customer's database at the time of the crawl. The SchemaChangePolicy does not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of the SchemaChangePolicy on a crawler. The SchemaChangePolicy consists of two components, UpdateBehavior and DeleteBehavior.","properties":{"deleteBehavior":{"type":"string","description":"The deletion behavior when the crawler finds a deleted object. A value of LOG specifies that if a table or partition is found to no longer exist, do not delete it, only log that it was found to no longer exist. A value of DELETE_FROM_DATABASE specifies that if a table or partition is found to have been removed, delete it from the database. A value of DEPRECATE_IN_DATABASE specifies that if a table has been found to no longer exist, to add a property to the table that says 'DEPRECATED' and includes a timestamp with the time of deprecation."},"updateBehavior":{"type":"string","description":"The update behavior when the crawler finds a changed schema. A value of LOG specifies that if a table or a partition already exists, and a change is detected, do not update it, only log that a change was detected. Add new tables and new partitions (including on existing tables). A value of UPDATE_IN_DATABASE specifies that if a table or partition already exists, and a change is detected, update it. Add new tables and partitions."}},"type":"object"},"aws-native:glue:CrawlerTargets":{"description":"Specifies data stores to crawl.","properties":{"catalogTargets":{"type":"array","items":{"$ref":"#/types/aws-native:glue:CrawlerCatalogTarget"},"description":"Specifies AWS Glue Data Catalog targets."},"deltaTargets":{"type":"array","items":{"$ref":"#/types/aws-native:glue:CrawlerDeltaTarget"},"description":"Specifies an array of Delta data store targets."},"dynamoDbTargets":{"type":"array","items":{"$ref":"#/types/aws-native:glue:CrawlerDynamoDbTarget"},"description":"Specifies Amazon DynamoDB targets."},"hudiTargets":{"type":"array","items":{"$ref":"#/types/aws-native:glue:CrawlerHudiTarget"},"description":"Specifies Apache Hudi data store targets."},"icebergTargets":{"type":"array","items":{"$ref":"#/types/aws-native:glue:CrawlerIcebergTarget"},"description":"Specifies Apache Iceberg data store targets."},"jdbcTargets":{"type":"array","items":{"$ref":"#/types/aws-native:glue:CrawlerJdbcTarget"},"description":"Specifies JDBC targets."},"mongoDbTargets":{"type":"array","items":{"$ref":"#/types/aws-native:glue:CrawlerMongoDbTarget"},"description":"A list of Mongo DB targets."},"s3Targets":{"type":"array","items":{"$ref":"#/types/aws-native:glue:CrawlerS3Target"},"description":"Specifies Amazon Simple Storage Service (Amazon S3) targets."}},"type":"object"},"aws-native:glue:DatabaseDataLakePrincipal":{"description":"The AWS Lake Formation principal.","properties":{"dataLakePrincipalIdentifier":{"type":"string","description":"An identifier for the AWS Lake Formation principal."}},"type":"object"},"aws-native:glue:DatabaseFederatedDatabase":{"description":"A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog.","properties":{"connectionName":{"type":"string","description":"The name of the connection to the external metastore."},"identifier":{"type":"string","description":"A unique identifier for the federated database."}},"type":"object"},"aws-native:glue:DatabaseIdentifier":{"description":"A structure that describes a target database for resource linking.","properties":{"catalogId":{"type":"string","description":"The ID of the Data Catalog in which the database resides."},"databaseName":{"type":"string","description":"The name of the catalog database."},"region":{"type":"string","description":"Region of the target database."}},"type":"object"},"aws-native:glue:DatabaseInput":{"description":"The structure used to create or update a database.","properties":{"createTableDefaultPermissions":{"type":"array","items":{"$ref":"#/types/aws-native:glue:DatabasePrincipalPrivileges"},"description":"Creates a set of default permissions on the table for principals. Used by AWS Lake Formation. Not used in the normal course of AWS Glue operations."},"description":{"type":"string","description":"A description of the database."},"federatedDatabase":{"$ref":"#/types/aws-native:glue:DatabaseFederatedDatabase","description":"A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog."},"locationUri":{"type":"string","description":"The location of the database (for example, an HDFS path)."},"name":{"type":"string","description":"The name of the database. For hive compatibility, this is folded to lowercase when it is stored."},"parameters":{"$ref":"pulumi.json#/Any","description":"These key-value pairs define parameters and properties of the database."},"targetDatabase":{"$ref":"#/types/aws-native:glue:DatabaseIdentifier","description":"A DatabaseIdentifier structure that describes a target database for resource linking."}},"type":"object"},"aws-native:glue:DatabasePrincipalPrivileges":{"description":"The permissions granted to a principal.","properties":{"permissions":{"type":"array","items":{"type":"string"},"description":"The permissions that are granted to the principal."},"principal":{"$ref":"#/types/aws-native:glue:DatabaseDataLakePrincipal","description":"The principal who is granted permissions."}},"type":"object"},"aws-native:glue:IntegrationConfig":{"description":"The configuration settings for the integration.","properties":{"continuousSync":{"type":"boolean","description":"Enables continuous synchronization for on-demand data extractions."},"refreshInterval":{"type":"string","description":"Specifies the frequency at which CDC (Change Data Capture) pulls or incremental loads should occur.","replaceOnChanges":true},"sourceProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"A collection of key-value pairs that specify additional properties for the integration source. These properties provide configuration options that can be used to customize the behavior of the ODB source during data integration operations."}},"type":"object"},"aws-native:glue:IntegrationResourcePropertyTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key"]},"aws-native:glue:IntegrationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key"]},"aws-native:glue:JobCommand":{"properties":{"name":{"type":"string","description":"The name of the job command"},"pythonVersion":{"type":"string","description":"The Python version being used to execute a Python shell job."},"runtime":{"type":"string","description":"Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment"},"scriptLocation":{"type":"string","description":"Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a job"}},"type":"object"},"aws-native:glue:JobConnectionsList":{"properties":{"connections":{"type":"array","items":{"type":"string"},"description":"A list of connections used by the job."}},"type":"object"},"aws-native:glue:JobExecutionProperty":{"properties":{"maxConcurrentRuns":{"type":"number","description":"The maximum number of concurrent runs allowed for the job."}},"type":"object"},"aws-native:glue:JobNotificationProperty":{"properties":{"notifyDelayAfter":{"type":"integer","description":"It is the number of minutes to wait before sending a job run delay notification after a job run starts"}},"type":"object"},"aws-native:glue:JobWorkerType":{"description":"TThe type of predefined worker that is allocated when a job runs.","type":"string","enum":[{"name":"Standard","value":"Standard"},{"name":"G1x","value":"G.1X"},{"name":"G2x","value":"G.2X"},{"name":"G025x","value":"G.025X"},{"name":"G4x","value":"G.4X"},{"name":"G8x","value":"G.8X"},{"name":"Z2x","value":"Z.2X"},{"name":"G12x","value":"G.12X"},{"name":"G16x","value":"G.16X"},{"name":"R1x","value":"R.1X"},{"name":"R2x","value":"R.2X"},{"name":"R4x","value":"R.4X"},{"name":"R8x","value":"R.8X"}]},"aws-native:glue:RegistryTag":{"properties":{"key":{"type":"string","description":"A key to identify the tag."},"value":{"type":"string","description":"Corresponding tag value for the key."}},"type":"object","required":["key","value"]},"aws-native:glue:SchemaCompatibility":{"description":"Compatibility setting for the schema.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Disabled","value":"DISABLED"},{"name":"Backward","value":"BACKWARD"},{"name":"BackwardAll","value":"BACKWARD_ALL"},{"name":"Forward","value":"FORWARD"},{"name":"ForwardAll","value":"FORWARD_ALL"},{"name":"Full","value":"FULL"},{"name":"FullAll","value":"FULL_ALL"}]},"aws-native:glue:SchemaDataFormat":{"description":"Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'","type":"string","enum":[{"name":"Avro","value":"AVRO"},{"name":"Json","value":"JSON"},{"name":"Protobuf","value":"PROTOBUF"}]},"aws-native:glue:SchemaRegistry":{"description":"Identifier for the registry which the schema is part of.","properties":{"arn":{"type":"string","description":"Amazon Resource Name for the Registry."},"name":{"type":"string","description":"Name of the registry in which the schema will be created."}},"type":"object"},"aws-native:glue:SchemaTag":{"properties":{"key":{"type":"string","description":"A key to identify the tag."},"value":{"type":"string","description":"Corresponding tag value for the key."}},"type":"object","required":["key","value"]},"aws-native:glue:SchemaVersion":{"description":"Specify checkpoint version for update. This is only required to update the Compatibility.","properties":{"isLatest":{"type":"boolean","description":"Indicates if the latest version needs to be updated."},"versionNumber":{"type":"integer","description":"Indicates the version number in the schema to update."}},"type":"object"},"aws-native:glue:SchemaVersionSchema":{"description":"Identifier for the schema where the schema version will be created.","properties":{"registryName":{"type":"string","description":"Name of the registry to identify where the Schema is located."},"schemaArn":{"type":"string","description":"Amazon Resource Name for the Schema. This attribute can be used to uniquely represent the Schema."},"schemaName":{"type":"string","description":"Name of the schema. This parameter requires RegistryName to be provided."}},"type":"object"},"aws-native:glue:SourceProcessingPropertiesProperties":{"description":"The resource properties associated with the integration source.","properties":{"roleArn":{"type":"string","description":"The IAM role to access the Glue connection."}},"type":"object","required":["roleArn"]},"aws-native:glue:TargetProcessingPropertiesProperties":{"description":"The resource properties associated with the integration target.","properties":{"connectionName":{"type":"string","description":"The Glue network connection to configure the Glue job running in the customer VPC."},"eventBusArn":{"type":"string","description":"The ARN of an Eventbridge event bus to receive the integration status notification."},"kmsArn":{"type":"string","description":"The ARN of the KMS key used for encryption."},"roleArn":{"type":"string","description":"The IAM role to access the Glue database."}},"type":"object","required":["roleArn"]},"aws-native:glue:TriggerAction":{"description":"The actions initiated by this trigger.","properties":{"arguments":{"$ref":"pulumi.json#/Any","description":"The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself."},"crawlerName":{"type":"string","description":"The name of the crawler to be used with this action."},"jobName":{"type":"string","description":"The name of a job to be executed."},"notificationProperty":{"$ref":"#/types/aws-native:glue:TriggerNotificationProperty","description":"Specifies configuration properties of a job run notification."},"securityConfiguration":{"type":"string","description":"The name of the SecurityConfiguration structure to be used with this action."},"timeout":{"type":"integer","description":"The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job."}},"type":"object"},"aws-native:glue:TriggerCondition":{"description":"Defines a condition under which a trigger fires.","properties":{"crawlState":{"type":"string","description":"The state of the crawler to which this condition applies."},"crawlerName":{"type":"string","description":"The name of the crawler to which this condition applies."},"jobName":{"type":"string","description":"The name of the job whose JobRuns this condition applies to, and on which this trigger waits."},"logicalOperator":{"type":"string","description":"A logical operator."},"state":{"type":"string","description":"The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT, and FAILED."}},"type":"object"},"aws-native:glue:TriggerEventBatchingCondition":{"description":"Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.","properties":{"batchSize":{"type":"integer","description":"Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires."},"batchWindow":{"type":"integer","description":"Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received."}},"type":"object","required":["batchSize"]},"aws-native:glue:TriggerNotificationProperty":{"description":"Specifies configuration properties of a job run notification.","properties":{"notifyDelayAfter":{"type":"integer","description":"After a job run starts, the number of minutes to wait before sending a job run delay notification"}},"type":"object"},"aws-native:glue:TriggerPredicate":{"description":"The predicate of this trigger, which defines when it will fire.","properties":{"conditions":{"type":"array","items":{"$ref":"#/types/aws-native:glue:TriggerCondition"},"description":"A list of the conditions that determine when the trigger will fire."},"logical":{"type":"string","description":"An optional field if only one condition is listed. If multiple conditions are listed, then this field is required."}},"type":"object"},"aws-native:glue:UsageProfileConfigurationObject":{"properties":{"allowedValues":{"type":"array","items":{"type":"string"}},"defaultValue":{"type":"string"},"maxValue":{"type":"string"},"minValue":{"type":"string"}},"type":"object"},"aws-native:glue:UsageProfileProfileConfiguration":{"properties":{"jobConfiguration":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:glue:UsageProfileConfigurationObject"}},"sessionConfiguration":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:glue:UsageProfileConfigurationObject"}}},"type":"object"},"aws-native:glue:UsageProfileTag":{"properties":{"key":{"type":"string","description":"A key to identify the tag."},"value":{"type":"string","description":"Corresponding tag value for the key."}},"type":"object","required":["key","value"]},"aws-native:grafana:WorkspaceAccountAccessType":{"description":"These enums represent valid account access types. Specifically these enums determine whether the workspace can access AWS resources in the AWS account only, or whether it can also access resources in other accounts in the same organization. If the value CURRENT_ACCOUNT is used, a workspace role ARN must be provided. If the value is ORGANIZATION, a list of organizational units must be provided.","type":"string","enum":[{"name":"CurrentAccount","value":"CURRENT_ACCOUNT"},{"name":"Organization","value":"ORGANIZATION"}]},"aws-native:grafana:WorkspaceAssertionAttributes":{"description":"Maps Grafana friendly names to the IdPs SAML attributes.","properties":{"email":{"type":"string","description":"Name of the attribute within the SAML assert to use as the users email in Grafana."},"groups":{"type":"string","description":"Name of the attribute within the SAML assert to use as the users groups in Grafana."},"login":{"type":"string","description":"Name of the attribute within the SAML assert to use as the users login handle in Grafana."},"name":{"type":"string","description":"Name of the attribute within the SAML assert to use as the users name in Grafana."},"org":{"type":"string","description":"Name of the attribute within the SAML assert to use as the users organizations in Grafana."},"role":{"type":"string","description":"Name of the attribute within the SAML assert to use as the users roles in Grafana."}},"type":"object"},"aws-native:grafana:WorkspaceAuthenticationProviderTypes":{"description":"Valid workspace authentication providers.","type":"string","enum":[{"name":"AwsSso","value":"AWS_SSO"},{"name":"Saml","value":"SAML"}]},"aws-native:grafana:WorkspaceDataSourceType":{"description":"These enums represent valid AWS data sources that can be queried via the Grafana workspace. These data sources are primarily used to help customers visualize which data sources have been added to a service managed workspace IAM role.","type":"string","enum":[{"name":"AmazonOpensearchService","value":"AMAZON_OPENSEARCH_SERVICE"},{"name":"Cloudwatch","value":"CLOUDWATCH"},{"name":"Prometheus","value":"PROMETHEUS"},{"name":"Xray","value":"XRAY"},{"name":"Timestream","value":"TIMESTREAM"},{"name":"Sitewise","value":"SITEWISE"},{"name":"Athena","value":"ATHENA"},{"name":"Redshift","value":"REDSHIFT"}]},"aws-native:grafana:WorkspaceIdpMetadata":{"description":"IdP Metadata used to configure SAML authentication in Grafana.","properties":{"url":{"type":"string","description":"URL that vends the IdPs metadata."},"xml":{"type":"string","description":"XML blob of the IdPs metadata."}},"type":"object"},"aws-native:grafana:WorkspaceNetworkAccessControl":{"description":"The configuration settings for Network Access Control.","properties":{"prefixListIds":{"type":"array","items":{"type":"string"},"description":"The list of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration then no IP addresses will be allowed to access the workspace."},"vpceIds":{"type":"array","items":{"type":"string"},"description":"The list of Amazon VPC endpoint IDs for the workspace. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here will be allowed to access the workspace."}},"type":"object"},"aws-native:grafana:WorkspaceNotificationDestinationType":{"description":"These enums represent valid AWS notification destinations that the Grafana workspace has permission to use. These notification destinations are primarily used to help customers visualize which destinations have been added to a service managed IAM role.","type":"string","enum":[{"name":"Sns","value":"SNS"}]},"aws-native:grafana:WorkspacePermissionType":{"description":"These enums represent valid permission types to use when creating or configuring a Grafana workspace. The SERVICE_MANAGED permission type means the Managed Grafana service will create a workspace IAM role on your behalf. The CUSTOMER_MANAGED permission type means that the customer is expected to provide an IAM role that the Grafana workspace can use to query data sources.","type":"string","enum":[{"name":"CustomerManaged","value":"CUSTOMER_MANAGED"},{"name":"ServiceManaged","value":"SERVICE_MANAGED"}]},"aws-native:grafana:WorkspaceRoleValues":{"description":"Maps SAML roles to the Grafana Editor and Admin roles.","properties":{"admin":{"type":"array","items":{"type":"string"},"description":"List of SAML roles which will be mapped into the Grafana Admin role."},"editor":{"type":"array","items":{"type":"string"},"description":"List of SAML roles which will be mapped into the Grafana Editor role."}},"type":"object"},"aws-native:grafana:WorkspaceSamlConfiguration":{"description":"SAML configuration data associated with an AMG workspace.","properties":{"allowedOrganizations":{"type":"array","items":{"type":"string"},"description":"List of SAML organizations allowed to access Grafana."},"assertionAttributes":{"$ref":"#/types/aws-native:grafana:WorkspaceAssertionAttributes","description":"A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace."},"idpMetadata":{"$ref":"#/types/aws-native:grafana:WorkspaceIdpMetadata","description":"A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace."},"loginValidityDuration":{"type":"number","description":"The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate."},"roleValues":{"$ref":"#/types/aws-native:grafana:WorkspaceRoleValues","description":"A structure containing arrays that map group names in the SAML assertion to the Grafana `Admin` and `Editor` roles in the workspace."}},"type":"object","required":["idpMetadata"]},"aws-native:grafana:WorkspaceSamlConfigurationStatus":{"description":"Valid SAML configuration statuses.","type":"string","enum":[{"name":"Configured","value":"CONFIGURED"},{"name":"NotConfigured","value":"NOT_CONFIGURED"}]},"aws-native:grafana:WorkspaceStatus":{"description":"These enums represent the status of a workspace.","type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Creating","value":"CREATING"},{"name":"Deleting","value":"DELETING"},{"name":"Failed","value":"FAILED"},{"name":"Updating","value":"UPDATING"},{"name":"Upgrading","value":"UPGRADING"},{"name":"VersionUpdating","value":"VERSION_UPDATING"},{"name":"DeletionFailed","value":"DELETION_FAILED"},{"name":"CreationFailed","value":"CREATION_FAILED"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"UpgradeFailed","value":"UPGRADE_FAILED"},{"name":"LicenseRemovalFailed","value":"LICENSE_REMOVAL_FAILED"},{"name":"VersionUpdateFailed","value":"VERSION_UPDATE_FAILED"}]},"aws-native:grafana:WorkspaceVpcConfiguration":{"description":"The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.","properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect."}},"type":"object","required":["securityGroupIds","subnetIds"]},"aws-native:greengrassv2:ComponentVersionComponentDependencyRequirement":{"properties":{"dependencyType":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionComponentDependencyRequirementDependencyType"},"versionRequirement":{"type":"string"}},"type":"object"},"aws-native:greengrassv2:ComponentVersionComponentDependencyRequirementDependencyType":{"type":"string","enum":[{"name":"Soft","value":"SOFT"},{"name":"Hard","value":"HARD"}]},"aws-native:greengrassv2:ComponentVersionComponentPlatform":{"properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"},"description":"A dictionary of attributes for the platform. The AWS IoT Greengrass Core software defines the `os` and `platform` by default. You can specify additional platform attributes for a core device when you deploy the AWS IoT Greengrass nucleus component. For more information, see the [AWS IoT Greengrass nucleus component](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) in the *AWS IoT Greengrass V2 Developer Guide* ."},"name":{"type":"string","description":"The friendly name of the platform. This name helps you identify the platform.\n\nIf you omit this parameter, AWS IoT Greengrass creates a friendly name from the `os` and `architecture` of the platform."}},"type":"object"},"aws-native:greengrassv2:ComponentVersionLambdaContainerParams":{"properties":{"devices":{"type":"array","items":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionLambdaDeviceMount"},"description":"The list of system devices that the container can access."},"memorySizeInKb":{"type":"integer","description":"The memory size of the container, expressed in kilobytes.\n\nDefault: `16384` (16 MB)"},"mountRoSysfs":{"type":"boolean","description":"Whether or not the container can read information from the device's `/sys` folder.\n\nDefault: `false`"},"volumes":{"type":"array","items":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionLambdaVolumeMount"},"description":"The list of volumes that the container can access."}},"type":"object"},"aws-native:greengrassv2:ComponentVersionLambdaDeviceMount":{"properties":{"addGroupOwner":{"type":"boolean","description":"Whether or not to add the component's system user as an owner of the device.\n\nDefault: `false`"},"path":{"type":"string","description":"The mount path for the device in the file system."},"permission":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionLambdaFilesystemPermission","description":"The permission to access the device: read/only ( `ro` ) or read/write ( `rw` ).\n\nDefault: `ro`"}},"type":"object"},"aws-native:greengrassv2:ComponentVersionLambdaEventSource":{"properties":{"topic":{"type":"string","description":"The topic to which to subscribe to receive event messages."},"type":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionLambdaEventSourceType","description":"The type of event source. Choose from the following options:\n\n- `PUB_SUB` – Subscribe to local publish/subscribe messages. This event source type doesn't support MQTT wildcards ( `+` and `#` ) in the event source topic.\n- `IOT_CORE` – Subscribe to AWS IoT Core MQTT messages. This event source type supports MQTT wildcards ( `+` and `#` ) in the event source topic."}},"type":"object"},"aws-native:greengrassv2:ComponentVersionLambdaEventSourceType":{"description":"The type of event source. Choose from the following options:\n\n- `PUB_SUB` – Subscribe to local publish/subscribe messages. This event source type doesn't support MQTT wildcards ( `+` and `#` ) in the event source topic.\n- `IOT_CORE` – Subscribe to AWS IoT Core MQTT messages. This event source type supports MQTT wildcards ( `+` and `#` ) in the event source topic.","type":"string","enum":[{"name":"PubSub","value":"PUB_SUB"},{"name":"IotCore","value":"IOT_CORE"}]},"aws-native:greengrassv2:ComponentVersionLambdaExecutionParameters":{"properties":{"environmentVariables":{"type":"object","additionalProperties":{"type":"string"},"description":"The map of environment variables that are available to the Lambda function when it runs."},"eventSources":{"type":"array","items":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionLambdaEventSource"},"description":"The list of event sources to which to subscribe to receive work messages. The Lambda function runs when it receives a message from an event source. You can subscribe this function to local publish/subscribe messages and AWS IoT Core MQTT messages."},"execArgs":{"type":"array","items":{"type":"string"},"description":"The list of arguments to pass to the Lambda function when it runs."},"inputPayloadEncodingType":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionLambdaExecutionParametersInputPayloadEncodingType","description":"The encoding type that the Lambda function supports.\n\nDefault: `json`"},"linuxProcessParams":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionLambdaLinuxProcessParams","description":"The parameters for the Linux process that contains the Lambda function."},"maxIdleTimeInSeconds":{"type":"integer","description":"The maximum amount of time in seconds that a non-pinned Lambda function can idle before the AWS IoT Greengrass Core software stops its process."},"maxInstancesCount":{"type":"integer","description":"The maximum number of instances that a non-pinned Lambda function can run at the same time."},"maxQueueSize":{"type":"integer","description":"The maximum size of the message queue for the Lambda function component. The AWS IoT Greengrass core device stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to consume each message."},"pinned":{"type":"boolean","description":"Whether or not the Lambda function is pinned, or long-lived.\n\n- A pinned Lambda function starts when the AWS IoT Greengrass Core starts and keeps running in its own container.\n- A non-pinned Lambda function starts only when it receives a work item and exists after it idles for `maxIdleTimeInSeconds` . If the function has multiple work items, the AWS IoT Greengrass Core software creates multiple instances of the function.\n\nDefault: `true`"},"statusTimeoutInSeconds":{"type":"integer","description":"The interval in seconds at which a pinned (also known as long-lived) Lambda function component sends status updates to the Lambda manager component."},"timeoutInSeconds":{"type":"integer","description":"The maximum amount of time in seconds that the Lambda function can process a work item."}},"type":"object"},"aws-native:greengrassv2:ComponentVersionLambdaExecutionParametersInputPayloadEncodingType":{"description":"The encoding type that the Lambda function supports.\n\nDefault: `json`","type":"string","enum":[{"name":"Json","value":"json"},{"name":"Binary","value":"binary"}]},"aws-native:greengrassv2:ComponentVersionLambdaFilesystemPermission":{"type":"string","enum":[{"name":"Ro","value":"ro"},{"name":"Rw","value":"rw"}]},"aws-native:greengrassv2:ComponentVersionLambdaFunctionRecipeSource":{"properties":{"componentDependencies":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionComponentDependencyRequirement"},"description":"The component versions on which this Lambda function component depends."},"componentLambdaParameters":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionLambdaExecutionParameters","description":"The system and runtime parameters for the Lambda function as it runs on the AWS IoT Greengrass core device."},"componentName":{"type":"string","description":"The name of the component.\n\nDefaults to the name of the Lambda function."},"componentPlatforms":{"type":"array","items":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionComponentPlatform"},"description":"The platforms that the component version supports."},"componentVersion":{"type":"string","description":"The version of the component.\n\nDefaults to the version of the Lambda function as a semantic version. For example, if your function version is `3` , the component version becomes `3.0.0` ."},"lambdaArn":{"type":"string","description":"The ARN of the Lambda function. The ARN must include the version of the function to import. You can't use version aliases like `$LATEST` ."}},"type":"object"},"aws-native:greengrassv2:ComponentVersionLambdaLinuxProcessParams":{"properties":{"containerParams":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionLambdaContainerParams","description":"The parameters for the container in which the Lambda function runs."},"isolationMode":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionLambdaLinuxProcessParamsIsolationMode","description":"The isolation mode for the process that contains the Lambda function. The process can run in an isolated runtime environment inside the AWS IoT Greengrass container, or as a regular process outside any container.\n\nDefault: `GreengrassContainer`"}},"type":"object"},"aws-native:greengrassv2:ComponentVersionLambdaLinuxProcessParamsIsolationMode":{"description":"The isolation mode for the process that contains the Lambda function. The process can run in an isolated runtime environment inside the AWS IoT Greengrass container, or as a regular process outside any container.\n\nDefault: `GreengrassContainer`","type":"string","enum":[{"name":"GreengrassContainer","value":"GreengrassContainer"},{"name":"NoContainer","value":"NoContainer"}]},"aws-native:greengrassv2:ComponentVersionLambdaVolumeMount":{"properties":{"addGroupOwner":{"type":"boolean","description":"Whether or not to add the AWS IoT Greengrass user group as an owner of the volume.\n\nDefault: `false`"},"destinationPath":{"type":"string","description":"The path to the logical volume in the file system."},"permission":{"$ref":"#/types/aws-native:greengrassv2:ComponentVersionLambdaFilesystemPermission","description":"The permission to access the volume: read/only ( `ro` ) or read/write ( `rw` ).\n\nDefault: `ro`"},"sourcePath":{"type":"string","description":"The path to the physical volume in the file system."}},"type":"object"},"aws-native:greengrassv2:DeploymentComponentConfigurationUpdate":{"properties":{"merge":{"type":"string"},"reset":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:greengrassv2:DeploymentComponentDeploymentSpecification":{"properties":{"componentVersion":{"type":"string"},"configurationUpdate":{"$ref":"#/types/aws-native:greengrassv2:DeploymentComponentConfigurationUpdate"},"runWith":{"$ref":"#/types/aws-native:greengrassv2:DeploymentComponentRunWith"}},"type":"object"},"aws-native:greengrassv2:DeploymentComponentRunWith":{"properties":{"posixUser":{"type":"string"},"systemResourceLimits":{"$ref":"#/types/aws-native:greengrassv2:DeploymentSystemResourceLimits"},"windowsUser":{"type":"string"}},"type":"object"},"aws-native:greengrassv2:DeploymentComponentUpdatePolicy":{"properties":{"action":{"$ref":"#/types/aws-native:greengrassv2:DeploymentComponentUpdatePolicyAction","description":"Whether or not to notify components and wait for components to become safe to update. Choose from the following options:\n\n- `NOTIFY_COMPONENTS` – The deployment notifies each component before it stops and updates that component. Components can use the [SubscribeToComponentUpdates](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates) IPC operation to receive these notifications. Then, components can respond with the [DeferComponentUpdate](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate) IPC operation. For more information, see the [Create deployments](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer Guide* .\n- `SKIP_NOTIFY_COMPONENTS` – The deployment doesn't notify components or wait for them to be safe to update.\n\nDefault: `NOTIFY_COMPONENTS`"},"timeoutInSeconds":{"type":"integer","description":"The amount of time in seconds that each component on a device has to report that it's safe to update. If the component waits for longer than this timeout, then the deployment proceeds on the device.\n\nDefault: `60`"}},"type":"object"},"aws-native:greengrassv2:DeploymentComponentUpdatePolicyAction":{"description":"Whether or not to notify components and wait for components to become safe to update. Choose from the following options:\n\n- `NOTIFY_COMPONENTS` – The deployment notifies each component before it stops and updates that component. Components can use the [SubscribeToComponentUpdates](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates) IPC operation to receive these notifications. Then, components can respond with the [DeferComponentUpdate](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate) IPC operation. For more information, see the [Create deployments](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer Guide* .\n- `SKIP_NOTIFY_COMPONENTS` – The deployment doesn't notify components or wait for them to be safe to update.\n\nDefault: `NOTIFY_COMPONENTS`","type":"string","enum":[{"name":"NotifyComponents","value":"NOTIFY_COMPONENTS"},{"name":"SkipNotifyComponents","value":"SKIP_NOTIFY_COMPONENTS"}]},"aws-native:greengrassv2:DeploymentConfigurationValidationPolicy":{"properties":{"timeoutInSeconds":{"type":"integer","description":"The amount of time in seconds that a component can validate its configuration updates. If the validation time exceeds this timeout, then the deployment proceeds for the device.\n\nDefault: `30`"}},"type":"object"},"aws-native:greengrassv2:DeploymentIoTJobAbortConfig":{"properties":{"criteriaList":{"type":"array","items":{"$ref":"#/types/aws-native:greengrassv2:DeploymentIoTJobAbortCriteria"},"description":"The list of criteria that define when and how to cancel the configuration deployment."}},"type":"object","required":["criteriaList"]},"aws-native:greengrassv2:DeploymentIoTJobAbortCriteria":{"properties":{"action":{"$ref":"#/types/aws-native:greengrassv2:DeploymentIoTJobAbortCriteriaAction","description":"The action to perform when the criteria are met."},"failureType":{"$ref":"#/types/aws-native:greengrassv2:DeploymentIoTJobAbortCriteriaFailureType","description":"The type of job deployment failure that can cancel a job."},"minNumberOfExecutedThings":{"type":"integer","description":"The minimum number of things that receive the configuration before the job can cancel."},"thresholdPercentage":{"type":"number","description":"The minimum percentage of `failureType` failures that occur before the job can cancel.\n\nThis parameter supports up to two digits after the decimal (for example, you can specify `10.9` or `10.99` , but not `10.999` )."}},"type":"object","required":["action","failureType","minNumberOfExecutedThings","thresholdPercentage"]},"aws-native:greengrassv2:DeploymentIoTJobAbortCriteriaAction":{"description":"The action to perform when the criteria are met.","type":"string","enum":[{"name":"Cancel","value":"CANCEL"}]},"aws-native:greengrassv2:DeploymentIoTJobAbortCriteriaFailureType":{"description":"The type of job deployment failure that can cancel a job.","type":"string","enum":[{"name":"Failed","value":"FAILED"},{"name":"Rejected","value":"REJECTED"},{"name":"TimedOut","value":"TIMED_OUT"},{"name":"All","value":"ALL"}]},"aws-native:greengrassv2:DeploymentIoTJobConfiguration":{"properties":{"abortConfig":{"$ref":"#/types/aws-native:greengrassv2:DeploymentIoTJobAbortConfig","description":"The stop configuration for the job. This configuration defines when and how to stop a job rollout."},"jobExecutionsRolloutConfig":{"$ref":"#/types/aws-native:greengrassv2:DeploymentIoTJobExecutionsRolloutConfig","description":"The rollout configuration for the job. This configuration defines the rate at which the job rolls out to the fleet of target devices."},"timeoutConfig":{"$ref":"#/types/aws-native:greengrassv2:DeploymentIoTJobTimeoutConfig","description":"The timeout configuration for the job. This configuration defines the amount of time each device has to complete the job."}},"type":"object"},"aws-native:greengrassv2:DeploymentIoTJobExecutionsRolloutConfig":{"properties":{"exponentialRate":{"$ref":"#/types/aws-native:greengrassv2:DeploymentIoTJobExponentialRolloutRate","description":"The exponential rate to increase the job rollout rate."},"maximumPerMinute":{"type":"integer","description":"The maximum number of devices that receive a pending job notification, per minute."}},"type":"object"},"aws-native:greengrassv2:DeploymentIoTJobExponentialRolloutRate":{"properties":{"baseRatePerMinute":{"type":"integer","description":"The minimum number of devices that receive a pending job notification, per minute, when the job starts. This parameter defines the initial rollout rate of the job."},"incrementFactor":{"type":"number","description":"The exponential factor to increase the rollout rate for the job.\n\nThis parameter supports up to one digit after the decimal (for example, you can specify `1.5` , but not `1.55` )."},"rateIncreaseCriteria":{"$ref":"#/types/aws-native:greengrassv2:DeploymentIoTJobRateIncreaseCriteria","description":"The criteria to increase the rollout rate for the job."}},"type":"object","required":["baseRatePerMinute","incrementFactor","rateIncreaseCriteria"]},"aws-native:greengrassv2:DeploymentIoTJobRateIncreaseCriteria":{"type":"object"},"aws-native:greengrassv2:DeploymentIoTJobTimeoutConfig":{"properties":{"inProgressTimeoutInMinutes":{"type":"integer","description":"The amount of time, in minutes, that devices have to complete the job. The timer starts when the job status is set to `IN_PROGRESS` . If the job status doesn't change to a terminal state before the time expires, then the job status is set to `TIMED_OUT` .\n\nThe timeout interval must be between 1 minute and 7 days (10080 minutes)."}},"type":"object"},"aws-native:greengrassv2:DeploymentPolicies":{"properties":{"componentUpdatePolicy":{"$ref":"#/types/aws-native:greengrassv2:DeploymentComponentUpdatePolicy","description":"The component update policy for the configuration deployment. This policy defines when it's safe to deploy the configuration to devices."},"configurationValidationPolicy":{"$ref":"#/types/aws-native:greengrassv2:DeploymentConfigurationValidationPolicy","description":"The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates."},"failureHandlingPolicy":{"$ref":"#/types/aws-native:greengrassv2:DeploymentPoliciesFailureHandlingPolicy","description":"The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.\n\nDefault: `ROLLBACK`"}},"type":"object"},"aws-native:greengrassv2:DeploymentPoliciesFailureHandlingPolicy":{"description":"The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.\n\nDefault: `ROLLBACK`","type":"string","enum":[{"name":"Rollback","value":"ROLLBACK"},{"name":"DoNothing","value":"DO_NOTHING"}]},"aws-native:greengrassv2:DeploymentSystemResourceLimits":{"properties":{"cpus":{"type":"number"},"memory":{"type":"integer"}},"type":"object"},"aws-native:groundstation:ConfigAntennaDownlinkConfig":{"properties":{"spectrumConfig":{"$ref":"#/types/aws-native:groundstation:ConfigSpectrumConfig","description":"Defines the spectrum configuration."}},"type":"object"},"aws-native:groundstation:ConfigAntennaDownlinkDemodDecodeConfig":{"properties":{"decodeConfig":{"$ref":"#/types/aws-native:groundstation:ConfigDecodeConfig","description":"Defines how the RF signal will be decoded."},"demodulationConfig":{"$ref":"#/types/aws-native:groundstation:ConfigDemodulationConfig","description":"Defines how the RF signal will be demodulated."},"spectrumConfig":{"$ref":"#/types/aws-native:groundstation:ConfigSpectrumConfig","description":"Defines the spectrum configuration."}},"type":"object"},"aws-native:groundstation:ConfigAntennaUplinkConfig":{"properties":{"spectrumConfig":{"$ref":"#/types/aws-native:groundstation:ConfigUplinkSpectrumConfig","description":"Defines the spectrum configuration."},"targetEirp":{"$ref":"#/types/aws-native:groundstation:ConfigEirp","description":"The equivalent isotropically radiated power (EIRP) to use for uplink transmissions. Valid values are between 20.0 to 50.0 dBW."},"transmitDisabled":{"type":"boolean","description":"Whether or not uplink transmit is disabled."}},"type":"object"},"aws-native:groundstation:ConfigBandwidthUnits":{"type":"string","enum":[{"name":"GHz","value":"GHz"},{"name":"MHz","value":"MHz"},{"name":"KHz","value":"kHz"}]},"aws-native:groundstation:ConfigData":{"properties":{"antennaDownlinkConfig":{"$ref":"#/types/aws-native:groundstation:ConfigAntennaDownlinkConfig","description":"Provides information for an antenna downlink config object. Antenna downlink config objects are used to provide parameters for downlinks where no demodulation or decoding is performed by Ground Station (RF over IP downlinks)."},"antennaDownlinkDemodDecodeConfig":{"$ref":"#/types/aws-native:groundstation:ConfigAntennaDownlinkDemodDecodeConfig","description":"Provides information for a downlink demod decode config object. Downlink demod decode config objects are used to provide parameters for downlinks where the Ground Station service will demodulate and decode the downlinked data."},"antennaUplinkConfig":{"$ref":"#/types/aws-native:groundstation:ConfigAntennaUplinkConfig","description":"Provides information for an uplink config object. Uplink config objects are used to provide parameters for uplink contacts."},"dataflowEndpointConfig":{"$ref":"#/types/aws-native:groundstation:ConfigDataflowEndpointConfig","description":"Provides information for a dataflow endpoint config object. Dataflow endpoint config objects are used to provide parameters about which IP endpoint(s) to use during a contact. Dataflow endpoints are where Ground Station sends data during a downlink contact and where Ground Station receives data to send to the satellite during an uplink contact."},"s3RecordingConfig":{"$ref":"#/types/aws-native:groundstation:ConfigS3RecordingConfig","description":"Provides information for an S3 recording config object. S3 recording config objects are used to provide parameters for S3 recording during downlink contacts."},"telemetrySinkConfig":{"$ref":"#/types/aws-native:groundstation:ConfigTelemetrySinkConfig"},"trackingConfig":{"$ref":"#/types/aws-native:groundstation:ConfigTrackingConfig","description":"Provides information for a tracking config object. Tracking config objects are used to provide parameters about how to track the satellite through the sky during a contact."},"uplinkEchoConfig":{"$ref":"#/types/aws-native:groundstation:ConfigUplinkEchoConfig","description":"Provides information for an uplink echo config object. Uplink echo config objects are used to provide parameters for uplink echo during uplink contacts."}},"type":"object"},"aws-native:groundstation:ConfigDataflowEndpointConfig":{"properties":{"dataflowEndpointName":{"type":"string","description":"The name of the dataflow endpoint to use during contacts."},"dataflowEndpointRegion":{"type":"string","description":"The region of the dataflow endpoint to use during contacts. When omitted, Ground Station will use the region of the contact."}},"type":"object"},"aws-native:groundstation:ConfigDecodeConfig":{"properties":{"unvalidatedJson":{"type":"string","description":"The decoding settings are in JSON format and define a set of steps to perform to decode the data."}},"type":"object"},"aws-native:groundstation:ConfigDemodulationConfig":{"properties":{"unvalidatedJson":{"type":"string","description":"The demodulation settings are in JSON format and define parameters for demodulation, for example which modulation scheme (e.g. PSK, QPSK, etc.) and matched filter to use."}},"type":"object"},"aws-native:groundstation:ConfigEirp":{"properties":{"units":{"$ref":"#/types/aws-native:groundstation:ConfigEirpUnits","description":"The units of the EIRP."},"value":{"type":"number","description":"The value of the EIRP. Valid values are between 20.0 to 50.0 dBW."}},"type":"object"},"aws-native:groundstation:ConfigEirpUnits":{"type":"string","enum":[{"name":"Dbw","value":"dBW"}]},"aws-native:groundstation:ConfigFrequency":{"properties":{"units":{"$ref":"#/types/aws-native:groundstation:ConfigFrequencyUnits","description":"The units of the frequency."},"value":{"type":"number","description":"The value of the frequency. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink."}},"type":"object"},"aws-native:groundstation:ConfigFrequencyBandwidth":{"properties":{"units":{"$ref":"#/types/aws-native:groundstation:ConfigBandwidthUnits","description":"The units of the bandwidth."},"value":{"type":"number","description":"The value of the bandwidth. AWS Ground Station currently has the following bandwidth limitations: \n\n- For `AntennaDownlinkDemodDecodeconfig` , valid values are between 125 kHz to 650 MHz.\n- For `AntennaDownlinkconfig` , valid values are between 10 kHz to 54 MHz.\n- For `AntennaUplinkConfig` , valid values are between 10 kHz to 54 MHz."}},"type":"object"},"aws-native:groundstation:ConfigFrequencyUnits":{"type":"string","enum":[{"name":"GHz","value":"GHz"},{"name":"MHz","value":"MHz"},{"name":"KHz","value":"kHz"}]},"aws-native:groundstation:ConfigKinesisDataStreamData":{"properties":{"kinesisDataStreamArn":{"type":"string"},"kinesisRoleArn":{"type":"string"}},"type":"object","required":["kinesisDataStreamArn","kinesisRoleArn"]},"aws-native:groundstation:ConfigPolarization":{"type":"string","enum":[{"name":"LeftHand","value":"LEFT_HAND"},{"name":"RightHand","value":"RIGHT_HAND"},{"name":"None","value":"NONE"}]},"aws-native:groundstation:ConfigS3RecordingConfig":{"properties":{"bucketArn":{"type":"string","description":"S3 Bucket where the data is written. The name of the S3 Bucket provided must begin with `aws-groundstation` ."},"prefix":{"type":"string","description":"The prefix of the S3 data object. If you choose to use any optional keys for substitution, these values will be replaced with the corresponding information from your contact details. For example, a prefix of `{satellite_id}/{year}/{month}/{day}/` will replaced with `fake_satellite_id/2021/01/10/`\n\n*Optional keys for substitution* : `{satellite_id}` | `{config-name}` | `{config-id}` | `{year}` | `{month}` | `{day}`"},"roleArn":{"type":"string","description":"Defines the ARN of the role assumed for putting archives to S3."}},"type":"object"},"aws-native:groundstation:ConfigSpectrumConfig":{"properties":{"bandwidth":{"$ref":"#/types/aws-native:groundstation:ConfigFrequencyBandwidth","description":"The bandwidth of the spectrum. AWS Ground Station currently has the following bandwidth limitations: \n\n- For `AntennaDownlinkDemodDecodeconfig` , valid values are between 125 kHz to 650 MHz.\n- For `AntennaDownlinkconfig` , valid values are between 10 kHz to 54 MHz.\n- For `AntennaUplinkConfig` , valid values are between 10 kHz to 54 MHz."},"centerFrequency":{"$ref":"#/types/aws-native:groundstation:ConfigFrequency","description":"The center frequency of the spectrum. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink."},"polarization":{"$ref":"#/types/aws-native:groundstation:ConfigPolarization","description":"The polarization of the spectrum. Valid values are `\"RIGHT_HAND\"` and `\"LEFT_HAND\"` . Capturing both `\"RIGHT_HAND\"` and `\"LEFT_HAND\"` polarization requires two separate configs."}},"type":"object"},"aws-native:groundstation:ConfigTag":{"properties":{"key":{"type":"string","description":"Name of the object key."},"value":{"type":"string","description":"Value of the tag."}},"type":"object"},"aws-native:groundstation:ConfigTelemetrySinkConfig":{"properties":{"telemetrySinkData":{"$ref":"#/types/aws-native:groundstation:ConfigTelemetrySinkData"},"telemetrySinkType":{"$ref":"#/types/aws-native:groundstation:ConfigTelemetrySinkType"}},"type":"object","required":["telemetrySinkData","telemetrySinkType"]},"aws-native:groundstation:ConfigTelemetrySinkData":{"properties":{"kinesisDataStreamData":{"$ref":"#/types/aws-native:groundstation:ConfigKinesisDataStreamData"}},"type":"object"},"aws-native:groundstation:ConfigTelemetrySinkType":{"type":"string","enum":[{"name":"KinesisDataStream","value":"KINESIS_DATA_STREAM"}]},"aws-native:groundstation:ConfigTrackingConfig":{"properties":{"autotrack":{"$ref":"#/types/aws-native:groundstation:ConfigTrackingConfigAutotrack","description":"Specifies whether or not to use autotrack. `REMOVED` specifies that program track should only be used during the contact. `PREFERRED` specifies that autotracking is preferred during the contact but fallback to program track if the signal is lost. `REQUIRED` specifies that autotracking is required during the contact and not to use program track if the signal is lost."}},"type":"object"},"aws-native:groundstation:ConfigTrackingConfigAutotrack":{"description":"Specifies whether or not to use autotrack. `REMOVED` specifies that program track should only be used during the contact. `PREFERRED` specifies that autotracking is preferred during the contact but fallback to program track if the signal is lost. `REQUIRED` specifies that autotracking is required during the contact and not to use program track if the signal is lost.","type":"string","enum":[{"name":"Required","value":"REQUIRED"},{"name":"Preferred","value":"PREFERRED"},{"name":"Removed","value":"REMOVED"}]},"aws-native:groundstation:ConfigUplinkEchoConfig":{"properties":{"antennaUplinkConfigArn":{"type":"string","description":"Defines the ARN of the uplink config to echo back to a dataflow endpoint."},"enabled":{"type":"boolean","description":"Whether or not uplink echo is enabled."}},"type":"object"},"aws-native:groundstation:ConfigUplinkSpectrumConfig":{"properties":{"centerFrequency":{"$ref":"#/types/aws-native:groundstation:ConfigFrequency","description":"The center frequency of the spectrum. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink."},"polarization":{"$ref":"#/types/aws-native:groundstation:ConfigPolarization","description":"The polarization of the spectrum. Valid values are `\"RIGHT_HAND\"` and `\"LEFT_HAND\"` ."}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupAgentStatus":{"description":"The status of AgentEndpoint.","type":"string","enum":[{"name":"Success","value":"SUCCESS"},{"name":"Failed","value":"FAILED"},{"name":"Active","value":"ACTIVE"},{"name":"Inactive","value":"INACTIVE"}]},"aws-native:groundstation:DataflowEndpointGroupAuditResults":{"description":"The results of the audit.","type":"string","enum":[{"name":"Healthy","value":"HEALTHY"},{"name":"Unhealthy","value":"UNHEALTHY"}]},"aws-native:groundstation:DataflowEndpointGroupAwsGroundStationAgentEndpoint":{"description":"Information about AwsGroundStationAgentEndpoint.","properties":{"agentStatus":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupAgentStatus","description":"The status of AgentEndpoint."},"auditResults":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupAuditResults","description":"The results of the audit."},"egressAddress":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupConnectionDetails","description":"The egress address of AgentEndpoint."},"ingressAddress":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupRangedConnectionDetails","description":"The ingress address of AgentEndpoint."},"name":{"type":"string","description":"Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint."}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupConnectionDetails":{"description":"Egress address of AgentEndpoint with an optional mtu.","properties":{"mtu":{"type":"integer","description":"Maximum transmission unit (MTU) size in bytes of a dataflow endpoint."},"socketAddress":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupSocketAddress","description":"A socket address."}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupDataflowEndpoint":{"properties":{"address":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupSocketAddress","description":"The address and port of an endpoint."},"mtu":{"type":"integer","description":"Maximum transmission unit (MTU) size in bytes of a dataflow endpoint. Valid values are between 1400 and 1500. A default value of 1500 is used if not set."},"name":{"type":"string","description":"The endpoint name.\n\nWhen listing available contacts for a satellite, Ground Station searches for a dataflow endpoint whose name matches the value specified by the dataflow endpoint config of the selected mission profile. If no matching dataflow endpoints are found then Ground Station will not display any available contacts for the satellite."}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupEndpointDetails":{"properties":{"awsGroundStationAgentEndpoint":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupAwsGroundStationAgentEndpoint","description":"An agent endpoint."},"endpoint":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupDataflowEndpoint","description":"Information about the endpoint such as name and the endpoint address."},"securityDetails":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupSecurityDetails","description":"The role ARN, and IDs for security groups and subnets."}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupIntegerRange":{"description":"An integer range that has a minimum and maximum value.","properties":{"maximum":{"type":"integer","description":"A maximum value."},"minimum":{"type":"integer","description":"A minimum value."}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupRangedConnectionDetails":{"description":"Ingress address of AgentEndpoint with a port range and an optional mtu.","properties":{"mtu":{"type":"integer","description":"Maximum transmission unit (MTU) size in bytes of a dataflow endpoint."},"socketAddress":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupRangedSocketAddress","description":"A ranged socket address."}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupRangedSocketAddress":{"description":"A socket address with a port range.","properties":{"name":{"type":"string","description":"IPv4 socket address."},"portRange":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupIntegerRange","description":"Port range of a socket address."}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupSecurityDetails":{"properties":{"roleArn":{"type":"string","description":"The ARN of a role which Ground Station has permission to assume, such as `arn:aws:iam::1234567890:role/DataDeliveryServiceRole` .\n\nGround Station will assume this role and create an ENI in your VPC on the specified subnet upon creation of a dataflow endpoint group. This ENI is used as the ingress/egress point for data streamed during a satellite contact."},"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The security group Ids of the security role, such as `sg-1234567890abcdef0` ."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The subnet Ids of the security details, such as `subnet-12345678` ."}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupSocketAddress":{"properties":{"name":{"type":"string","description":"The name of the endpoint, such as `Endpoint 1` ."},"port":{"type":"integer","description":"The port of the endpoint, such as `55888` ."}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupTag":{"properties":{"key":{"type":"string","description":"Name of the object key."},"value":{"type":"string","description":"Value of the tag."}},"type":"object","required":["key","value"]},"aws-native:groundstation:DataflowEndpointGroupV2AgentStatus":{"description":"The status of AgentEndpoint.","type":"string","enum":[{"name":"Success","value":"SUCCESS"},{"name":"Failed","value":"FAILED"},{"name":"Active","value":"ACTIVE"},{"name":"Inactive","value":"INACTIVE"}]},"aws-native:groundstation:DataflowEndpointGroupV2AuditResults":{"description":"The results of the audit.","type":"string","enum":[{"name":"Healthy","value":"HEALTHY"},{"name":"Unhealthy","value":"UNHEALTHY"}]},"aws-native:groundstation:DataflowEndpointGroupV2ConnectionDetails":{"description":"Socket address of an uplink or downlink agent endpoint with an optional mtu.","properties":{"mtu":{"type":"integer","description":"Maximum transmission unit (MTU) size in bytes of a dataflow endpoint."},"socketAddress":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2SocketAddress","description":"A socket address."}},"type":"object","required":["socketAddress"]},"aws-native:groundstation:DataflowEndpointGroupV2CreateEndpointDetails":{"properties":{"downlinkAwsGroundStationAgentEndpoint":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2DownlinkAwsGroundStationAgentEndpoint","description":"Definition for a downlink agent endpoint"},"uplinkAwsGroundStationAgentEndpoint":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2UplinkAwsGroundStationAgentEndpoint","description":"Definition for an uplink agent endpoint"}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupV2DownlinkAwsGroundStationAgentEndpoint":{"description":"Information about DownlinkAwsGroundStationAgentEndpoint used for create","properties":{"dataflowDetails":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2DownlinkDataflowDetails","description":"Dataflow details for the downlink endpoint"},"name":{"type":"string","description":"Downlink dataflow endpoint name"}},"type":"object","required":["dataflowDetails","name"]},"aws-native:groundstation:DataflowEndpointGroupV2DownlinkAwsGroundStationAgentEndpointDetails":{"description":"Information about DownlinkAwsGroundStationAgentEndpoint","properties":{"agentStatus":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2AgentStatus","description":"Status of the agent associated with the downlink dataflow endpoint"},"auditResults":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2AuditResults","description":"Health audit results for the downlink dataflow endpoint"},"dataflowDetails":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2DownlinkDataflowDetails","description":"Dataflow details for the downlink endpoint"},"name":{"type":"string","description":"Downlink dataflow endpoint name"}},"type":"object","required":["dataflowDetails","name"]},"aws-native:groundstation:DataflowEndpointGroupV2DownlinkConnectionDetails":{"description":"Connection details for downlink, from ground station to agent, and customer to agent","properties":{"agentIpAndPortAddress":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2RangedConnectionDetails","description":"Agent IP and port address for the downlink connection."},"egressAddressAndPort":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2ConnectionDetails","description":"Egress address and port for the downlink connection."}},"type":"object","required":["agentIpAndPortAddress","egressAddressAndPort"]},"aws-native:groundstation:DataflowEndpointGroupV2DownlinkDataflowDetails":{"description":"Dataflow details for downlink","properties":{"agentConnectionDetails":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2DownlinkConnectionDetails","description":"Downlink connection details for customer to Agent and Agent to Ground Station"}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupV2EndpointDetails":{"properties":{"downlinkAwsGroundStationAgentEndpoint":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2DownlinkAwsGroundStationAgentEndpointDetails","description":"Definition for a downlink agent endpoint"},"uplinkAwsGroundStationAgentEndpoint":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2UplinkAwsGroundStationAgentEndpointDetails","description":"Definition for an uplink agent endpoint"}},"type":"object"},"aws-native:groundstation:DataflowEndpointGroupV2IntegerRange":{"description":"An integer range that has a minimum and maximum value.","properties":{"maximum":{"type":"integer","description":"A maximum value."},"minimum":{"type":"integer","description":"A minimum value."}},"type":"object","required":["maximum","minimum"]},"aws-native:groundstation:DataflowEndpointGroupV2RangedConnectionDetails":{"description":"Socket address of an uplink or downlink agent endpoint with a port range and an optional mtu.","properties":{"mtu":{"type":"integer","description":"Maximum transmission unit (MTU) size in bytes of a dataflow endpoint."},"socketAddress":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2RangedSocketAddress","description":"A ranged socket address."}},"type":"object","required":["socketAddress"]},"aws-native:groundstation:DataflowEndpointGroupV2RangedSocketAddress":{"description":"A socket address with a port range.","properties":{"name":{"type":"string","description":"IPv4 socket address."},"portRange":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2IntegerRange","description":"Port range of a socket address."}},"type":"object","required":["name","portRange"]},"aws-native:groundstation:DataflowEndpointGroupV2SocketAddress":{"properties":{"name":{"type":"string","description":"IPv4 socket address."},"port":{"type":"integer","description":"Port of a socket address."}},"type":"object","required":["name","port"]},"aws-native:groundstation:DataflowEndpointGroupV2Tag":{"properties":{"key":{"type":"string","description":"Name of the object key."},"value":{"type":"string","description":"Value of the tag."}},"type":"object","required":["key","value"]},"aws-native:groundstation:DataflowEndpointGroupV2UplinkAwsGroundStationAgentEndpoint":{"description":"Information about UplinkAwsGroundStationAgentEndpoint used for create","properties":{"dataflowDetails":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2UplinkDataflowDetails","description":"Dataflow details for the uplink endpoint"},"name":{"type":"string","description":"Uplink dataflow endpoint name"}},"type":"object","required":["dataflowDetails","name"]},"aws-native:groundstation:DataflowEndpointGroupV2UplinkAwsGroundStationAgentEndpointDetails":{"description":"Information about UplinkAwsGroundStationAgentEndpoint","properties":{"agentStatus":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2AgentStatus","description":"Status of the agent associated with the uplink dataflow endpoint"},"auditResults":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2AuditResults","description":"Health audit results for the uplink dataflow endpoint"},"dataflowDetails":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2UplinkDataflowDetails","description":"Dataflow details for the uplink endpoint"},"name":{"type":"string","description":"Uplink dataflow endpoint name"}},"type":"object","required":["dataflowDetails","name"]},"aws-native:groundstation:DataflowEndpointGroupV2UplinkConnectionDetails":{"description":"Connection details for uplink, from ground station to agent, and customer to agent","properties":{"agentIpAndPortAddress":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2RangedConnectionDetails","description":"Agent IP and port address for the uplink connection."},"ingressAddressAndPort":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2ConnectionDetails","description":"Ingress address and port for the uplink connection."}},"type":"object","required":["agentIpAndPortAddress","ingressAddressAndPort"]},"aws-native:groundstation:DataflowEndpointGroupV2UplinkDataflowDetails":{"description":"Dataflow details for uplink","properties":{"agentConnectionDetails":{"$ref":"#/types/aws-native:groundstation:DataflowEndpointGroupV2UplinkConnectionDetails","description":"Uplink connection details for customer to Agent and Agent to Ground Station"}},"type":"object"},"aws-native:groundstation:MissionProfileDataflowEdge":{"properties":{"destination":{"type":"string","description":"The ARN of the destination for this dataflow edge. For example, specify the ARN of a dataflow endpoint config for a downlink edge or an antenna uplink config for an uplink edge."},"source":{"type":"string","description":"The ARN of the source for this dataflow edge. For example, specify the ARN of an antenna downlink config for a downlink edge or a dataflow endpoint config for an uplink edge."}},"type":"object"},"aws-native:groundstation:MissionProfileStreamsKmsKey":{"properties":{"kmsAliasArn":{"type":"string","description":"KMS Alias Arn."},"kmsAliasName":{"type":"string","description":"KMS Alias Name."},"kmsKeyArn":{"type":"string","description":"KMS Key Arn."}},"type":"object"},"aws-native:groundstation:MissionProfileTag":{"properties":{"key":{"type":"string","description":"Name of the object key."},"value":{"type":"string","description":"Value of the tag."}},"type":"object","required":["key","value"]},"aws-native:guardduty:DetectorCfnDataSourceConfigurations":{"properties":{"kubernetes":{"$ref":"#/types/aws-native:guardduty:DetectorCfnKubernetesConfiguration","description":"Describes which Kubernetes data sources are enabled for a detector."},"malwareProtection":{"$ref":"#/types/aws-native:guardduty:DetectorCfnMalwareProtectionConfiguration","description":"Describes whether Malware Protection will be enabled as a data source."},"s3Logs":{"$ref":"#/types/aws-native:guardduty:DetectorCfns3LogsConfiguration","description":"Describes whether S3 data event logs are enabled as a data source."}},"type":"object"},"aws-native:guardduty:DetectorCfnFeatureAdditionalConfiguration":{"properties":{"name":{"type":"string","description":"Name of the additional configuration."},"status":{"type":"string","description":"Status of the additional configuration."}},"type":"object"},"aws-native:guardduty:DetectorCfnFeatureConfiguration":{"properties":{"additionalConfiguration":{"type":"array","items":{"$ref":"#/types/aws-native:guardduty:DetectorCfnFeatureAdditionalConfiguration"},"description":"Information about the additional configuration of a feature in your account."},"name":{"type":"string","description":"Name of the feature. For a list of allowed values, see [DetectorFeatureConfiguration](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DetectorFeatureConfiguration.html#guardduty-Type-DetectorFeatureConfiguration-name) in the *GuardDuty API Reference* ."},"status":{"$ref":"#/types/aws-native:guardduty:DetectorCfnFeatureConfigurationStatus","description":"Status of the feature configuration."}},"type":"object","required":["name","status"]},"aws-native:guardduty:DetectorCfnFeatureConfigurationStatus":{"description":"Status of the feature configuration.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:guardduty:DetectorCfnKubernetesAuditLogsConfiguration":{"properties":{"enable":{"type":"boolean","description":"Describes whether Kubernetes audit logs are enabled as a data source for the detector."}},"type":"object","required":["enable"]},"aws-native:guardduty:DetectorCfnKubernetesConfiguration":{"properties":{"auditLogs":{"$ref":"#/types/aws-native:guardduty:DetectorCfnKubernetesAuditLogsConfiguration","description":"Describes whether Kubernetes audit logs are enabled as a data source for the detector."}},"type":"object","required":["auditLogs"]},"aws-native:guardduty:DetectorCfnMalwareProtectionConfiguration":{"properties":{"scanEc2InstanceWithFindings":{"$ref":"#/types/aws-native:guardduty:DetectorCfnScanEc2InstanceWithFindingsConfiguration","description":"Describes the configuration of Malware Protection for EC2 instances with findings."}},"type":"object"},"aws-native:guardduty:DetectorCfnScanEc2InstanceWithFindingsConfiguration":{"properties":{"ebsVolumes":{"type":"boolean","description":"Describes the configuration for scanning EBS volumes as data source."}},"type":"object"},"aws-native:guardduty:DetectorCfns3LogsConfiguration":{"properties":{"enable":{"type":"boolean","description":"The status of S3 data event logs as a data source."}},"type":"object","required":["enable"]},"aws-native:guardduty:DetectorTagItem":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:guardduty:FilterCondition":{"properties":{"eq":{"type":"array","items":{"type":"string"}},"equals":{"type":"array","items":{"type":"string"}},"greaterThan":{"type":"integer"},"greaterThanOrEqual":{"type":"integer"},"gt":{"type":"integer"},"gte":{"type":"integer"},"lessThan":{"type":"integer"},"lessThanOrEqual":{"type":"integer"},"lt":{"type":"integer"},"lte":{"type":"integer"},"neq":{"type":"array","items":{"type":"string"}},"notEquals":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:guardduty:FilterFindingCriteria":{"properties":{"criterion":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:guardduty:FilterCondition"},"description":"Represents a map of finding properties that match specified conditions and values when querying findings.\n\nFor information about JSON criterion mapping to their console equivalent, see [Finding criteria](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_filter-findings.html#filter_criteria) . The following are the available criterion:\n\n- accountId\n- id\n- region\n- severity\n\nTo filter on the basis of severity, the API and AWS CLI use the following input list for the `FindingCriteria` condition:\n\n- *Low* : `[\"1\", \"2\", \"3\"]`\n- *Medium* : `[\"4\", \"5\", \"6\"]`\n- *High* : `[\"7\", \"8\", \"9\"]`\n\nFor more information, see [Severity levels for GuardDuty findings](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html#guardduty_findings-severity) in the *Amazon GuardDuty User Guide* .\n- type\n- updatedAt\n\nType: ISO 8601 string format: `YYYY-MM-DDTHH:MM:SS.SSSZ` or `YYYY-MM-DDTHH:MM:SSZ` depending on whether the value contains milliseconds.\n- resource.accessKeyDetails.accessKeyId\n- resource.accessKeyDetails.principalId\n- resource.accessKeyDetails.userName\n- resource.accessKeyDetails.userType\n- resource.instanceDetails.iamInstanceProfile.id\n- resource.instanceDetails.imageId\n- resource.instanceDetails.instanceId\n- resource.instanceDetails.tags.key\n- resource.instanceDetails.tags.value\n- resource.instanceDetails.networkInterfaces.ipv6Addresses\n- resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress\n- resource.instanceDetails.networkInterfaces.publicDnsName\n- resource.instanceDetails.networkInterfaces.publicIp\n- resource.instanceDetails.networkInterfaces.securityGroups.groupId\n- resource.instanceDetails.networkInterfaces.securityGroups.groupName\n- resource.instanceDetails.networkInterfaces.subnetId\n- resource.instanceDetails.networkInterfaces.vpcId\n- resource.instanceDetails.outpostArn\n- resource.resourceType\n- resource.s3BucketDetails.publicAccess.effectivePermissions\n- resource.s3BucketDetails.name\n- resource.s3BucketDetails.tags.key\n- resource.s3BucketDetails.tags.value\n- resource.s3BucketDetails.type\n- service.action.actionType\n- service.action.awsApiCallAction.api\n- service.action.awsApiCallAction.callerType\n- service.action.awsApiCallAction.errorCode\n- service.action.awsApiCallAction.remoteIpDetails.city.cityName\n- service.action.awsApiCallAction.remoteIpDetails.country.countryName\n- service.action.awsApiCallAction.remoteIpDetails.ipAddressV4\n- service.action.awsApiCallAction.remoteIpDetails.ipAddressV6\n- service.action.awsApiCallAction.remoteIpDetails.organization.asn\n- service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg\n- service.action.awsApiCallAction.serviceName\n- service.action.dnsRequestAction.domain\n- service.action.dnsRequestAction.domainWithSuffix\n- service.action.networkConnectionAction.blocked\n- service.action.networkConnectionAction.connectionDirection\n- service.action.networkConnectionAction.localPortDetails.port\n- service.action.networkConnectionAction.protocol\n- service.action.networkConnectionAction.remoteIpDetails.city.cityName\n- service.action.networkConnectionAction.remoteIpDetails.country.countryName\n- service.action.networkConnectionAction.remoteIpDetails.ipAddressV4\n- service.action.networkConnectionAction.remoteIpDetails.ipAddressV6\n- service.action.networkConnectionAction.remoteIpDetails.organization.asn\n- service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg\n- service.action.networkConnectionAction.remotePortDetails.port\n- service.action.awsApiCallAction.remoteAccountDetails.affiliated\n- service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4\n- service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6\n- service.action.kubernetesApiCallAction.namespace\n- service.action.kubernetesApiCallAction.remoteIpDetails.organization.asn\n- service.action.kubernetesApiCallAction.requestUri\n- service.action.kubernetesApiCallAction.statusCode\n- service.action.networkConnectionAction.localIpDetails.ipAddressV4\n- service.action.networkConnectionAction.localIpDetails.ipAddressV6\n- service.action.networkConnectionAction.protocol\n- service.action.awsApiCallAction.serviceName\n- service.action.awsApiCallAction.remoteAccountDetails.accountId\n- service.additionalInfo.threatListName\n- service.resourceRole\n- resource.eksClusterDetails.name\n- resource.kubernetesDetails.kubernetesWorkloadDetails.name\n- resource.kubernetesDetails.kubernetesWorkloadDetails.namespace\n- resource.kubernetesDetails.kubernetesUserDetails.username\n- resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image\n- resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix\n- service.ebsVolumeScanDetails.scanId\n- service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name\n- service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity\n- service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash\n- service.malwareScanDetails.threats.name\n- resource.ecsClusterDetails.name\n- resource.ecsClusterDetails.taskDetails.containers.image\n- resource.ecsClusterDetails.taskDetails.definitionArn\n- resource.containerDetails.image\n- resource.rdsDbInstanceDetails.dbInstanceIdentifier\n- resource.rdsDbInstanceDetails.dbClusterIdentifier\n- resource.rdsDbInstanceDetails.engine\n- resource.rdsDbUserDetails.user\n- resource.rdsDbInstanceDetails.tags.key\n- resource.rdsDbInstanceDetails.tags.value\n- service.runtimeDetails.process.executableSha256\n- service.runtimeDetails.process.name\n- service.runtimeDetails.process.name\n- resource.lambdaDetails.functionName\n- resource.lambdaDetails.functionArn\n- resource.lambdaDetails.tags.key\n- resource.lambdaDetails.tags.value"}},"type":"object"},"aws-native:guardduty:FilterTagItem":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:guardduty:IpSetTagItem":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:guardduty:MalwareProtectionPlanCfnActions":{"properties":{"tagging":{"$ref":"#/types/aws-native:guardduty:MalwareProtectionPlanCfnTagging","description":"Contains information about tagging status of the Malware Protection plan resource."}},"type":"object"},"aws-native:guardduty:MalwareProtectionPlanCfnProtectedResource":{"properties":{"s3Bucket":{"$ref":"#/types/aws-native:guardduty:MalwareProtectionPlanCfnProtectedResourceS3BucketProperties","description":"Information about the protected S3 bucket resource."}},"type":"object","required":["s3Bucket"]},"aws-native:guardduty:MalwareProtectionPlanCfnProtectedResourceS3BucketProperties":{"description":"Information about the protected S3 bucket resource.","properties":{"bucketName":{"type":"string","description":"Name of the S3 bucket."},"objectPrefixes":{"type":"array","items":{"type":"string"},"description":"Information about the specified object prefixes. The S3 object will be scanned only if it belongs to any of the specified object prefixes."}},"type":"object"},"aws-native:guardduty:MalwareProtectionPlanCfnStatusReasons":{"properties":{"code":{"type":"string","description":"The status code of the Malware Protection plan."},"message":{"type":"string","description":"Issue message that specifies the reason."}},"type":"object"},"aws-native:guardduty:MalwareProtectionPlanCfnTagging":{"properties":{"status":{"type":"string","description":"Indicates whether or not you chose GuardDuty to add a predefined tag to the scanned S3 object."}},"type":"object"},"aws-native:guardduty:MalwareProtectionPlanTagItem":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:guardduty:PublishingDestinationCfnDestinationProperties":{"properties":{"destinationArn":{"type":"string","description":"The ARN of the resource to publish to."},"kmsKeyArn":{"type":"string","description":"The ARN of the KMS key to use for encryption."}},"type":"object"},"aws-native:guardduty:PublishingDestinationTagItem":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:guardduty:ThreatEntitySetStatus":{"description":"The status of your `ThreatEntitySet` . For information about valid status values, see [Understanding list statuses](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload-lists.html#guardduty-entity-list-statuses) in the *Amazon GuardDuty User Guide* .","type":"string","enum":[{"name":"Inactive","value":"INACTIVE"},{"name":"Activating","value":"ACTIVATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deactivating","value":"DEACTIVATING"},{"name":"Error","value":"ERROR"},{"name":"DeletePending","value":"DELETE_PENDING"},{"name":"Deleted","value":"DELETED"}]},"aws-native:guardduty:ThreatEntitySetTagItem":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value. This is optional."}},"type":"object","required":["key","value"]},"aws-native:guardduty:ThreatIntelSetTagItem":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value."}},"type":"object","required":["key","value"]},"aws-native:guardduty:TrustedEntitySetStatus":{"description":"The status of your `TrustedEntitySet` . For information about valid status values, see [Understanding list statuses](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload-lists.html#guardduty-entity-list-statuses) in the *Amazon GuardDuty User Guide* .","type":"string","enum":[{"name":"Inactive","value":"INACTIVE"},{"name":"Activating","value":"ACTIVATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deactivating","value":"DEACTIVATING"},{"name":"Error","value":"ERROR"},{"name":"DeletePending","value":"DELETE_PENDING"},{"name":"Deleted","value":"DELETED"}]},"aws-native:guardduty:TrustedEntitySetTagItem":{"properties":{"key":{"type":"string","description":"The tag key."},"value":{"type":"string","description":"The tag value. This is optional."}},"type":"object","required":["key","value"]},"aws-native:healthimaging:DatastoreStatus":{"description":"A string to denote the Datastore's state.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Deleted","value":"DELETED"}]},"aws-native:healthlake:FhirDatastoreCreatedAt":{"description":"The time that a Data Store was created.","properties":{"nanos":{"type":"integer","description":"Nanoseconds."},"seconds":{"type":"string","description":"Seconds since epoch."}},"type":"object","required":["nanos","seconds"]},"aws-native:healthlake:FhirDatastoreDatastoreStatus":{"description":"The status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Deleted","value":"DELETED"}]},"aws-native:healthlake:FhirDatastoreDatastoreTypeVersion":{"description":"The FHIR version. Only R4 version data is supported.","type":"string","enum":[{"name":"R4","value":"R4"}]},"aws-native:healthlake:FhirDatastoreIdentityProviderConfiguration":{"description":"The identity provider configuration for the datastore","properties":{"authorizationStrategy":{"$ref":"#/types/aws-native:healthlake:FhirDatastoreIdentityProviderConfigurationAuthorizationStrategy","description":"Type of Authorization Strategy. The two types of supported Authorization strategies are SMART_ON_FHIR_V1 and AWS_AUTH."},"fineGrainedAuthorizationEnabled":{"type":"boolean","description":"Flag to indicate if fine-grained authorization will be enabled for the datastore"},"idpLambdaArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Lambda function that will be used to decode the access token created by the authorization server."},"metadata":{"type":"string","description":"The JSON metadata elements for identity provider configuration."}},"type":"object","required":["authorizationStrategy"]},"aws-native:healthlake:FhirDatastoreIdentityProviderConfigurationAuthorizationStrategy":{"description":"Type of Authorization Strategy. The two types of supported Authorization strategies are SMART_ON_FHIR_V1 and AWS_AUTH.","type":"string","enum":[{"name":"SmartOnFhirV1","value":"SMART_ON_FHIR_V1"},{"name":"AwsAuth","value":"AWS_AUTH"},{"name":"SmartOnFhir","value":"SMART_ON_FHIR"}]},"aws-native:healthlake:FhirDatastoreKmsEncryptionConfig":{"description":"The customer-managed-key (CMK) used when creating a Data Store. If a customer owned key is not specified, an AWS owned key will be used for encryption.","properties":{"cmkType":{"$ref":"#/types/aws-native:healthlake:FhirDatastoreKmsEncryptionConfigCmkType","description":"The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs."},"kmsKeyId":{"type":"string","description":"The KMS encryption key id/alias used to encrypt the Data Store contents at rest."}},"type":"object","required":["cmkType"]},"aws-native:healthlake:FhirDatastoreKmsEncryptionConfigCmkType":{"description":"The type of customer-managed-key (CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.","type":"string","enum":[{"name":"CustomerManagedKmsKey","value":"CUSTOMER_MANAGED_KMS_KEY"},{"name":"AwsOwnedKmsKey","value":"AWS_OWNED_KMS_KEY"}]},"aws-native:healthlake:FhirDatastorePreloadDataConfig":{"description":"The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.","properties":{"preloadDataType":{"$ref":"#/types/aws-native:healthlake:FhirDatastorePreloadDataConfigPreloadDataType","description":"The type of preloaded data. Only Synthea preloaded data is supported."}},"type":"object","required":["preloadDataType"]},"aws-native:healthlake:FhirDatastorePreloadDataConfigPreloadDataType":{"description":"The type of preloaded data. Only Synthea preloaded data is supported.","type":"string","enum":[{"name":"Synthea","value":"SYNTHEA"}]},"aws-native:healthlake:FhirDatastoreSseConfiguration":{"description":"The server-side encryption key configuration for a customer provided encryption key.","properties":{"kmsEncryptionConfig":{"$ref":"#/types/aws-native:healthlake:FhirDatastoreKmsEncryptionConfig","description":"The server-side encryption key configuration for a customer provided encryption key."}},"type":"object","required":["kmsEncryptionConfig"]},"aws-native:healthlake:FhirDatastoreTag":{"description":"A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.","properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:iam:GroupPolicy":{"description":"Contains information about an attached policy.\n An attached policy is a managed policy that has been attached to a user, group, or role.\n For more information about managed policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.","properties":{"policyDocument":{"$ref":"pulumi.json#/Any","description":"The policy document."},"policyName":{"type":"string","description":"The friendly name (not ARN) identifying the policy."}},"type":"object","required":["policyDocument","policyName"]},"aws-native:iam:OidcProviderTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:iam:RolePolicy":{"description":"Contains information about an attached policy.\n An attached policy is a managed policy that has been attached to a user, group, or role.\n For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.","properties":{"policyDocument":{"$ref":"pulumi.json#/Any","description":"The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json)."},"policyName":{"type":"string","description":"The friendly name (not ARN) identifying the policy."}},"type":"object","required":["policyDocument","policyName"]},"aws-native:iam:RoleTag":{"description":"A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.","properties":{"key":{"type":"string","description":"The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices."},"value":{"type":"string","description":"The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values."}},"type":"object","required":["key","value"]},"aws-native:iam:SamlProviderAssertionEncryptionMode":{"description":"The encryption setting for the SAML provider","type":"string","enum":[{"name":"Allowed","value":"Allowed"},{"name":"Required","value":"Required"}]},"aws-native:iam:SamlProviderSamlPrivateKey":{"description":"The private key metadata for the SAML provider","properties":{"keyId":{"type":"string","description":"The unique identifier for the SAML private key."},"timestamp":{"type":"string","description":"The date and time, in \u003ca href=\\\"http://www.iso.org/iso/iso8601\\\"\u003eISO 8601 date-time \u003c/a\u003e format, when the private key was uploaded."}},"type":"object","required":["keyId","timestamp"]},"aws-native:iam:SamlProviderTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:iam:ServerCertificateTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:iam:UserLoginProfile":{"description":"Creates a password for the specified user, giving the user the ability to access AWS services through the console. For more information about managing passwords, see [Managing Passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.","properties":{"password":{"type":"string","description":"The user's password."},"passwordResetRequired":{"type":"boolean","description":"Specifies whether the user is required to set a new password on next sign-in."}},"type":"object","required":["password"]},"aws-native:iam:UserPolicy":{"description":"Contains information about an attached policy.\n An attached policy is a managed policy that has been attached to a user, group, or role.\n For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.","properties":{"policyDocument":{"$ref":"pulumi.json#/Any","description":"The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json)."},"policyName":{"type":"string","description":"The friendly name (not ARN) identifying the policy."}},"type":"object","required":["policyDocument","policyName"]},"aws-native:iam:UserTag":{"description":"A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.","properties":{"key":{"type":"string","description":"The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices."},"value":{"type":"string","description":"The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values."}},"type":"object","required":["key","value"]},"aws-native:iam:VirtualMfaDeviceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:identitystore:GroupMembershipMemberId":{"description":"An object containing the identifier of a group member.","properties":{"userId":{"type":"string","description":"The identifier for a user in the identity store."}},"type":"object","required":["userId"]},"aws-native:imagebuilder:ComponentLatestVersion":{"description":"The latest version references of the component.","properties":{"arn":{"type":"string","description":"The latest version ARN of the created component."},"major":{"type":"string","description":"The latest version ARN of the created component, with the same major version."},"minor":{"type":"string","description":"The latest version ARN of the created component, with the same minor version."},"patch":{"type":"string","description":"The latest version ARN of the created component, with the same patch version."}},"type":"object"},"aws-native:imagebuilder:ComponentPlatform":{"description":"The platform of the component.","type":"string","enum":[{"name":"Windows","value":"Windows"},{"name":"Linux","value":"Linux"},{"name":"MacOs","value":"macOS"}]},"aws-native:imagebuilder:ComponentType":{"description":"The type of the component denotes whether the component is used to build the image or only to test it. ","type":"string","enum":[{"name":"Build","value":"BUILD"},{"name":"Test","value":"TEST"}]},"aws-native:imagebuilder:ContainerRecipeComponentConfiguration":{"description":"Configuration details of the component.","properties":{"componentArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the component."},"parameters":{"type":"array","items":{"$ref":"#/types/aws-native:imagebuilder:ContainerRecipeComponentParameter"},"description":"A group of parameter settings that are used to configure the component for a specific recipe."}},"type":"object"},"aws-native:imagebuilder:ContainerRecipeComponentParameter":{"description":"Contains a key/value pair that sets the named component parameter.","properties":{"name":{"type":"string","description":"The name of the component parameter to set."},"value":{"type":"array","items":{"type":"string"},"description":"Sets the value for the named component parameter."}},"type":"object","required":["name","value"]},"aws-native:imagebuilder:ContainerRecipeContainerType":{"description":"Specifies the type of container, such as Docker.","type":"string","enum":[{"name":"Docker","value":"DOCKER"}]},"aws-native:imagebuilder:ContainerRecipeEbsInstanceBlockDeviceSpecification":{"description":"Amazon EBS-specific block device mapping specifications. ","properties":{"deleteOnTermination":{"type":"boolean","description":"Use to configure delete on termination of the associated device."},"encrypted":{"type":"boolean","description":"Use to configure device encryption."},"iops":{"type":"integer","description":"Use to configure device IOPS."},"kmsKeyId":{"type":"string","description":"Use to configure the KMS key to use when encrypting the device."},"snapshotId":{"type":"string","description":"The snapshot that defines the device contents."},"throughput":{"type":"integer","description":"For GP3 volumes only - The throughput in MiB/s that the volume supports."},"volumeSize":{"type":"integer","description":"Use to override the device's volume size."},"volumeType":{"$ref":"#/types/aws-native:imagebuilder:ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeType","description":"Use to override the device's volume type."}},"type":"object"},"aws-native:imagebuilder:ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeType":{"description":"Use to override the device's volume type.","type":"string","enum":[{"name":"Standard","value":"standard"},{"name":"Io1","value":"io1"},{"name":"Io2","value":"io2"},{"name":"Gp2","value":"gp2"},{"name":"Gp3","value":"gp3"},{"name":"Sc1","value":"sc1"},{"name":"St1","value":"st1"}]},"aws-native:imagebuilder:ContainerRecipeInstanceBlockDeviceMapping":{"description":"Defines block device mappings for the instance used to configure your image. ","properties":{"deviceName":{"type":"string","description":"The device to which these mappings apply."},"ebs":{"$ref":"#/types/aws-native:imagebuilder:ContainerRecipeEbsInstanceBlockDeviceSpecification","description":"Use to manage Amazon EBS-specific configuration for this mapping."},"noDevice":{"type":"string","description":"Use to remove a mapping from the parent image."},"virtualName":{"type":"string","description":"Use to manage instance ephemeral devices."}},"type":"object"},"aws-native:imagebuilder:ContainerRecipeInstanceConfiguration":{"description":"A group of options that can be used to configure an instance for building and testing container images.","properties":{"blockDeviceMappings":{"type":"array","items":{"$ref":"#/types/aws-native:imagebuilder:ContainerRecipeInstanceBlockDeviceMapping"},"description":"Defines the block devices to attach for building an instance from this Image Builder AMI."},"image":{"type":"string","description":"The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image."}},"type":"object"},"aws-native:imagebuilder:ContainerRecipeLatestVersion":{"description":"The latest version references of the container recipe.","properties":{"arn":{"type":"string","description":"The latest version ARN of the created container recipe."},"major":{"type":"string","description":"The latest version ARN of the created container recipe, with the same major version."},"minor":{"type":"string","description":"The latest version ARN of the created container recipe, with the same minor version."},"patch":{"type":"string","description":"The latest version ARN of the created container recipe, with the same patch version."}},"type":"object"},"aws-native:imagebuilder:ContainerRecipePlatformOverride":{"description":"Specifies the operating system platform when you use a custom source image.","type":"string","enum":[{"name":"Windows","value":"Windows"},{"name":"Linux","value":"Linux"}]},"aws-native:imagebuilder:ContainerRecipeTargetContainerRepository":{"description":"The container repository where the output container image is stored.","properties":{"repositoryName":{"type":"string","description":"The name of the container repository where the output container image is stored. This name is prefixed by the repository location."},"service":{"$ref":"#/types/aws-native:imagebuilder:ContainerRecipeTargetContainerRepositoryService","description":"Specifies the service in which this image was registered."}},"type":"object"},"aws-native:imagebuilder:ContainerRecipeTargetContainerRepositoryService":{"description":"Specifies the service in which this image was registered.","type":"string","enum":[{"name":"Ecr","value":"ECR"}]},"aws-native:imagebuilder:DistributionConfigurationAmiDistributionConfiguration":{"description":"The specific AMI settings (for example, launch permissions, AMI tags).","properties":{"amiTags":{"type":"object","additionalProperties":{"type":"string"},"description":"The tags to apply to AMIs distributed to this Region."},"description":{"type":"string","description":"The description of the AMI distribution configuration."},"kmsKeyId":{"type":"string","description":"The KMS key identifier used to encrypt the distributed image."},"launchPermissionConfiguration":{"$ref":"#/types/aws-native:imagebuilder:DistributionConfigurationLaunchPermissionConfiguration","description":"Launch permissions can be used to configure which AWS account s can use the AMI to launch instances."},"name":{"type":"string","description":"The name of the AMI distribution configuration."},"targetAccountIds":{"type":"array","items":{"type":"string"},"description":"The ID of accounts to which you want to distribute an image."}},"type":"object"},"aws-native:imagebuilder:DistributionConfigurationContainerDistributionConfiguration":{"description":"Container distribution settings for encryption, licensing, and sharing in a specific Region.","properties":{"containerTags":{"type":"array","items":{"type":"string"},"description":"Tags that are attached to the container distribution configuration."},"description":{"type":"string","description":"The description of the container distribution configuration."},"targetRepository":{"$ref":"#/types/aws-native:imagebuilder:DistributionConfigurationTargetContainerRepository","description":"The destination repository for the container distribution configuration."}},"type":"object"},"aws-native:imagebuilder:DistributionConfigurationDistribution":{"description":"The distributions of the distribution configuration.","properties":{"amiDistributionConfiguration":{"$ref":"#/types/aws-native:imagebuilder:DistributionConfigurationAmiDistributionConfiguration","description":"The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below."},"containerDistributionConfiguration":{"$ref":"#/types/aws-native:imagebuilder:DistributionConfigurationContainerDistributionConfiguration","description":"Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below."},"fastLaunchConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:imagebuilder:DistributionConfigurationFastLaunchConfiguration"},"description":"The Windows faster-launching configurations to use for AMI distribution."},"launchTemplateConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:imagebuilder:DistributionConfigurationLaunchTemplateConfiguration"},"description":"A group of launchTemplateConfiguration settings that apply to image distribution."},"licenseConfigurationArns":{"type":"array","items":{"type":"string"},"description":"The License Manager Configuration to associate with the AMI in the specified Region."},"region":{"type":"string","description":"region"},"ssmParameterConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:imagebuilder:DistributionConfigurationSsmParameterConfiguration"},"description":"The SSM parameter configurations to use for AMI distribution."}},"type":"object","required":["region"]},"aws-native:imagebuilder:DistributionConfigurationFastLaunchConfiguration":{"description":"The Windows faster-launching configuration to use for AMI distribution.","properties":{"accountId":{"type":"string","description":"The owner account ID for the fast-launch enabled Windows AMI."},"enabled":{"type":"boolean","description":"A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it."},"launchTemplate":{"$ref":"#/types/aws-native:imagebuilder:DistributionConfigurationFastLaunchLaunchTemplateSpecification","description":"The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots."},"maxParallelLaunches":{"type":"integer","description":"The maximum number of parallel instances that are launched for creating resources."},"snapshotConfiguration":{"$ref":"#/types/aws-native:imagebuilder:DistributionConfigurationFastLaunchSnapshotConfiguration","description":"Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled."}},"type":"object"},"aws-native:imagebuilder:DistributionConfigurationFastLaunchLaunchTemplateSpecification":{"description":"The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.","properties":{"launchTemplateId":{"type":"string","description":"The ID of the launch template to use for faster launching for a Windows AMI."},"launchTemplateName":{"type":"string","description":"The name of the launch template to use for faster launching for a Windows AMI."},"launchTemplateVersion":{"type":"string","description":"The version of the launch template to use for faster launching for a Windows AMI."}},"type":"object"},"aws-native:imagebuilder:DistributionConfigurationFastLaunchSnapshotConfiguration":{"description":"Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.","properties":{"targetResourceCount":{"type":"integer","description":"The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI."}},"type":"object"},"aws-native:imagebuilder:DistributionConfigurationLaunchPermissionConfiguration":{"description":"Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.","properties":{"organizationArns":{"type":"array","items":{"type":"string"},"description":"The ARN for an Amazon Web Services Organization that you want to share your AMI with."},"organizationalUnitArns":{"type":"array","items":{"type":"string"},"description":"The ARN for an Organizations organizational unit (OU) that you want to share your AMI with."},"userGroups":{"type":"array","items":{"type":"string"},"description":"The name of the group."},"userIds":{"type":"array","items":{"type":"string"},"description":"The AWS account ID."}},"type":"object"},"aws-native:imagebuilder:DistributionConfigurationLaunchTemplateConfiguration":{"description":"launchTemplateConfiguration settings that apply to image distribution.","properties":{"accountId":{"type":"string","description":"The account ID that this configuration applies to."},"launchTemplateId":{"type":"string","description":"Identifies the EC2 launch template to use."},"setDefaultVersion":{"type":"boolean","description":"Set the specified EC2 launch template as the default launch template for the specified account."}},"type":"object"},"aws-native:imagebuilder:DistributionConfigurationSsmParameterConfiguration":{"description":"The SSM parameter configuration for AMI distribution.","properties":{"amiAccountId":{"type":"string","description":"The account ID for the AMI to update the parameter with."},"dataType":{"$ref":"#/types/aws-native:imagebuilder:DistributionConfigurationSsmParameterConfigurationDataType","description":"The data type of the SSM parameter."},"parameterName":{"type":"string","description":"The name of the SSM parameter."}},"type":"object","required":["parameterName"]},"aws-native:imagebuilder:DistributionConfigurationSsmParameterConfigurationDataType":{"description":"The data type of the SSM parameter.","type":"string","enum":[{"name":"Text","value":"text"},{"name":"Awsec2image","value":"aws:ec2:image"}]},"aws-native:imagebuilder:DistributionConfigurationTargetContainerRepository":{"description":"The destination repository for the container image.","properties":{"repositoryName":{"type":"string","description":"The repository name of target container repository."},"service":{"$ref":"#/types/aws-native:imagebuilder:DistributionConfigurationTargetContainerRepositoryService","description":"The service of target container repository."}},"type":"object"},"aws-native:imagebuilder:DistributionConfigurationTargetContainerRepositoryService":{"description":"The service of target container repository.","type":"string","enum":[{"name":"Ecr","value":"ECR"}]},"aws-native:imagebuilder:ImageDeletionSettings":{"description":"The deletion settings of the image, indicating whether to delete the underlying resources in addition to the image.","properties":{"executionRole":{"type":"string","description":"The execution role to use for deleting the image, as well as underlying resources."}},"type":"object","required":["executionRole"]},"aws-native:imagebuilder:ImageEcrConfiguration":{"description":"Settings for Image Builder to configure the ECR repository and output container images that are scanned.","properties":{"containerTags":{"type":"array","items":{"type":"string"},"description":"Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images."},"repositoryName":{"type":"string","description":"The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images."}},"type":"object"},"aws-native:imagebuilder:ImageLatestVersion":{"description":"The latest version references of the image.","properties":{"arn":{"type":"string","description":"The latest version ARN of the created image."},"major":{"type":"string","description":"The latest version ARN of the created image, with the same major version."},"minor":{"type":"string","description":"The latest version ARN of the created image, with the same minor version."},"patch":{"type":"string","description":"The latest version ARN of the created image, with the same patch version."}},"type":"object"},"aws-native:imagebuilder:ImageLoggingConfiguration":{"description":"The logging configuration settings for the image.","properties":{"logGroupName":{"type":"string","description":"The name of the log group for image build logs."}},"type":"object"},"aws-native:imagebuilder:ImagePipelineAutoDisablePolicy":{"description":"The auto-disable policy configuration for the image pipeline.","properties":{"failureCount":{"type":"integer","description":"The number of consecutive failures after which the pipeline should be automatically disabled."}},"type":"object","required":["failureCount"]},"aws-native:imagebuilder:ImagePipelineEcrConfiguration":{"description":"Settings for Image Builder to configure the ECR repository and output container images that are scanned.","properties":{"containerTags":{"type":"array","items":{"type":"string"},"description":"Tags for Image Builder to apply the output container image that is scanned. Tags can help you identify and manage your scanned images."},"repositoryName":{"type":"string","description":"The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don't provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository to use for vulnerability scans for your output container images."}},"type":"object"},"aws-native:imagebuilder:ImagePipelineExecutionSettings":{"description":"The settings for starting an image pipeline execution.","properties":{"deploymentId":{"type":"string","description":"The deployment ID of the pipeline, used to trigger new image pipeline executions."},"onUpdate":{"type":"boolean","description":"Whether to trigger the image pipeline when the pipeline is updated. False by default."}},"type":"object"},"aws-native:imagebuilder:ImagePipelineImageScanningConfiguration":{"description":"Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.","properties":{"ecrConfiguration":{"$ref":"#/types/aws-native:imagebuilder:ImagePipelineEcrConfiguration","description":"Contains ECR settings for vulnerability scans."},"imageScanningEnabled":{"type":"boolean","description":"This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image."}},"type":"object"},"aws-native:imagebuilder:ImagePipelineImageTestsConfiguration":{"description":"Image tests configuration.","properties":{"imageTestsEnabled":{"type":"boolean","description":"Defines if tests should be executed when building this image."},"timeoutMinutes":{"type":"integer","description":"The maximum time in minutes that tests are permitted to run."}},"type":"object"},"aws-native:imagebuilder:ImagePipelinePipelineLoggingConfiguration":{"description":"The logging configuration settings for the image pipeline.","properties":{"imageLogGroupName":{"type":"string","description":"The name of the log group for image build logs."},"pipelineLogGroupName":{"type":"string","description":"The name of the log group for pipeline execution logs."}},"type":"object"},"aws-native:imagebuilder:ImagePipelineSchedule":{"description":"The schedule of the image pipeline.","properties":{"autoDisablePolicy":{"$ref":"#/types/aws-native:imagebuilder:ImagePipelineAutoDisablePolicy","description":"The auto-disable policy for the image pipeline."},"pipelineExecutionStartCondition":{"$ref":"#/types/aws-native:imagebuilder:ImagePipelineSchedulePipelineExecutionStartCondition","description":"The condition configures when the pipeline should trigger a new image build."},"scheduleExpression":{"type":"string","description":"The expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition."}},"type":"object"},"aws-native:imagebuilder:ImagePipelineSchedulePipelineExecutionStartCondition":{"description":"The condition configures when the pipeline should trigger a new image build.","type":"string","enum":[{"name":"ExpressionMatchOnly","value":"EXPRESSION_MATCH_ONLY"},{"name":"ExpressionMatchAndDependencyUpdatesAvailable","value":"EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"}]},"aws-native:imagebuilder:ImagePipelineStatus":{"description":"The status of the image pipeline.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:imagebuilder:ImagePipelineWorkflowConfiguration":{"description":"The workflow configuration of the image","properties":{"onFailure":{"$ref":"#/types/aws-native:imagebuilder:ImagePipelineWorkflowConfigurationOnFailure","description":"Define execution decision in case of workflow failure"},"parallelGroup":{"type":"string","description":"The parallel group name"},"parameters":{"type":"array","items":{"$ref":"#/types/aws-native:imagebuilder:ImagePipelineWorkflowParameter"},"description":"The parameters associated with the workflow"},"workflowArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the workflow"}},"type":"object"},"aws-native:imagebuilder:ImagePipelineWorkflowConfigurationOnFailure":{"description":"Define execution decision in case of workflow failure","type":"string","enum":[{"name":"Continue","value":"CONTINUE"},{"name":"Abort","value":"ABORT"}]},"aws-native:imagebuilder:ImagePipelineWorkflowParameter":{"description":"A parameter associated with the workflow","properties":{"name":{"type":"string","description":"The name of the workflow parameter to set."},"value":{"type":"array","items":{"type":"string"},"description":"Sets the value for the named workflow parameter."}},"type":"object"},"aws-native:imagebuilder:ImageRecipeAdditionalInstanceConfiguration":{"description":"Specify additional settings and launch scripts for your build instances.","properties":{"systemsManagerAgent":{"$ref":"#/types/aws-native:imagebuilder:ImageRecipeSystemsManagerAgent","description":"Contains settings for the SSM agent on your build instance."},"userDataOverride":{"type":"string","description":"Use this property to provide commands or a command script to run when you launch your build instance."}},"type":"object"},"aws-native:imagebuilder:ImageRecipeComponentConfiguration":{"description":"Configuration details of the component.","properties":{"componentArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the component."},"parameters":{"type":"array","items":{"$ref":"#/types/aws-native:imagebuilder:ImageRecipeComponentParameter"},"description":"A group of parameter settings that are used to configure the component for a specific recipe."}},"type":"object"},"aws-native:imagebuilder:ImageRecipeComponentParameter":{"description":"Contains a key/value pair that sets the named component parameter.","properties":{"name":{"type":"string","description":"The name of the component parameter to set."},"value":{"type":"array","items":{"type":"string"},"description":"Sets the value for the named component parameter."}},"type":"object","required":["name","value"]},"aws-native:imagebuilder:ImageRecipeEbsInstanceBlockDeviceSpecification":{"description":"Amazon EBS-specific block device mapping specifications. ","properties":{"deleteOnTermination":{"type":"boolean","description":"Use to configure delete on termination of the associated device."},"encrypted":{"type":"boolean","description":"Use to configure device encryption."},"iops":{"type":"integer","description":"Use to configure device IOPS."},"kmsKeyId":{"type":"string","description":"Use to configure the KMS key to use when encrypting the device."},"snapshotId":{"type":"string","description":"The snapshot that defines the device contents."},"throughput":{"type":"integer","description":"For GP3 volumes only - The throughput in MiB/s that the volume supports."},"volumeSize":{"type":"integer","description":"Use to override the device's volume size."},"volumeType":{"$ref":"#/types/aws-native:imagebuilder:ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeType","description":"Use to override the device's volume type."}},"type":"object"},"aws-native:imagebuilder:ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeType":{"description":"Use to override the device's volume type.","type":"string","enum":[{"name":"Standard","value":"standard"},{"name":"Io1","value":"io1"},{"name":"Io2","value":"io2"},{"name":"Gp2","value":"gp2"},{"name":"Gp3","value":"gp3"},{"name":"Sc1","value":"sc1"},{"name":"St1","value":"st1"}]},"aws-native:imagebuilder:ImageRecipeInstanceBlockDeviceMapping":{"description":"Defines block device mappings for the instance used to configure your image. ","properties":{"deviceName":{"type":"string","description":"The device to which these mappings apply."},"ebs":{"$ref":"#/types/aws-native:imagebuilder:ImageRecipeEbsInstanceBlockDeviceSpecification","description":"Use to manage Amazon EBS-specific configuration for this mapping."},"noDevice":{"type":"string","description":"Use to remove a mapping from the parent image."},"virtualName":{"type":"string","description":"Use to manage instance ephemeral devices."}},"type":"object"},"aws-native:imagebuilder:ImageRecipeLatestVersion":{"description":"The latest version references of the image recipe.","properties":{"arn":{"type":"string","description":"The latest version ARN of the created image recipe."},"major":{"type":"string","description":"The latest version ARN of the created image recipe, with the same major version."},"minor":{"type":"string","description":"The latest version ARN of the created image recipe, with the same minor version."},"patch":{"type":"string","description":"The latest version ARN of the created image recipe, with the same patch version."}},"type":"object"},"aws-native:imagebuilder:ImageRecipeSystemsManagerAgent":{"description":"Contains settings for the SSM agent on your build instance.","properties":{"uninstallAfterBuild":{"type":"boolean","description":"Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false."}},"type":"object"},"aws-native:imagebuilder:ImageScanningConfiguration":{"description":"Contains settings for Image Builder image resource and container image scans.","properties":{"ecrConfiguration":{"$ref":"#/types/aws-native:imagebuilder:ImageEcrConfiguration","description":"Contains ECR settings for vulnerability scans."},"imageScanningEnabled":{"type":"boolean","description":"This sets whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image."}},"type":"object"},"aws-native:imagebuilder:ImageTestsConfiguration":{"description":"The image tests configuration used when creating this image.","properties":{"imageTestsEnabled":{"type":"boolean","description":"ImageTestsEnabled"},"timeoutMinutes":{"type":"integer","description":"TimeoutMinutes"}},"type":"object"},"aws-native:imagebuilder:ImageWorkflowConfiguration":{"description":"The workflow configuration of the image","properties":{"onFailure":{"$ref":"#/types/aws-native:imagebuilder:ImageWorkflowConfigurationOnFailure","description":"Define execution decision in case of workflow failure"},"parallelGroup":{"type":"string","description":"The parallel group name"},"parameters":{"type":"array","items":{"$ref":"#/types/aws-native:imagebuilder:ImageWorkflowParameter"},"description":"The parameters associated with the workflow"},"workflowArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the workflow"}},"type":"object"},"aws-native:imagebuilder:ImageWorkflowConfigurationOnFailure":{"description":"Define execution decision in case of workflow failure","type":"string","enum":[{"name":"Continue","value":"CONTINUE"},{"name":"Abort","value":"ABORT"}]},"aws-native:imagebuilder:ImageWorkflowParameter":{"description":"A parameter associated with the workflow","properties":{"name":{"type":"string","description":"The name of the workflow parameter to set."},"value":{"type":"array","items":{"type":"string"},"description":"Sets the value for the named workflow parameter."}},"type":"object"},"aws-native:imagebuilder:InfrastructureConfigurationInstanceMetadataOptions":{"description":"The instance metadata option settings for the infrastructure configuration.","properties":{"httpPutResponseHopLimit":{"type":"integer","description":"Limit the number of hops that an instance metadata request can traverse to reach its destination."},"httpTokens":{"$ref":"#/types/aws-native:imagebuilder:InfrastructureConfigurationInstanceMetadataOptionsHttpTokens","description":"Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows: "}},"type":"object"},"aws-native:imagebuilder:InfrastructureConfigurationInstanceMetadataOptionsHttpTokens":{"description":"Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows: ","type":"string","enum":[{"name":"Required","value":"required"},{"name":"Optional","value":"optional"}]},"aws-native:imagebuilder:InfrastructureConfigurationLogging":{"description":"The logging configuration of the infrastructure configuration.","properties":{"s3Logs":{"$ref":"#/types/aws-native:imagebuilder:InfrastructureConfigurationS3Logs","description":"The Amazon S3 logging configuration."}},"type":"object"},"aws-native:imagebuilder:InfrastructureConfigurationPlacement":{"description":"The placement options","properties":{"availabilityZone":{"type":"string","description":"AvailabilityZone"},"hostId":{"type":"string","description":"HostId"},"hostResourceGroupArn":{"type":"string","description":"HostResourceGroupArn"},"tenancy":{"$ref":"#/types/aws-native:imagebuilder:InfrastructureConfigurationPlacementTenancy","description":"Tenancy"}},"type":"object"},"aws-native:imagebuilder:InfrastructureConfigurationPlacementTenancy":{"description":"Tenancy","type":"string","enum":[{"name":"Default","value":"default"},{"name":"Dedicated","value":"dedicated"},{"name":"Host","value":"host"}]},"aws-native:imagebuilder:InfrastructureConfigurationS3Logs":{"description":"The S3 path in which to store the logs.","properties":{"s3BucketName":{"type":"string","description":"S3BucketName"},"s3KeyPrefix":{"type":"string","description":"S3KeyPrefix"}},"type":"object"},"aws-native:imagebuilder:LifecyclePolicyAction":{"description":"The action of the policy detail.","properties":{"includeResources":{"$ref":"#/types/aws-native:imagebuilder:LifecyclePolicyIncludeResources","description":"Specifies the resources that the lifecycle policy applies to."},"type":{"$ref":"#/types/aws-native:imagebuilder:LifecyclePolicyActionType","description":"The action type of the policy detail."}},"type":"object","required":["type"]},"aws-native:imagebuilder:LifecyclePolicyActionType":{"description":"The action type of the policy detail.","type":"string","enum":[{"name":"Delete","value":"DELETE"},{"name":"Deprecate","value":"DEPRECATE"},{"name":"Disable","value":"DISABLE"}]},"aws-native:imagebuilder:LifecyclePolicyAmiExclusionRules":{"description":"The AMI exclusion rules for the policy detail.","properties":{"isPublic":{"type":"boolean","description":"Use to apply lifecycle policy actions on whether the AMI is public."},"lastLaunched":{"$ref":"#/types/aws-native:imagebuilder:LifecyclePolicyLastLaunched","description":"Use to apply lifecycle policy actions on AMIs launched before a certain time."},"regions":{"type":"array","items":{"type":"string"},"description":"Use to apply lifecycle policy actions on AMIs distributed to a set of regions."},"sharedAccounts":{"type":"array","items":{"type":"string"},"description":"Use to apply lifecycle policy actions on AMIs shared with a set of regions."},"tagMap":{"type":"object","additionalProperties":{"type":"string"},"description":"The AMIs to select by tag."}},"type":"object"},"aws-native:imagebuilder:LifecyclePolicyExclusionRules":{"description":"The exclusion rules to apply of the policy detail.","properties":{"amis":{"$ref":"#/types/aws-native:imagebuilder:LifecyclePolicyAmiExclusionRules","description":"Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action."},"tagMap":{"type":"object","additionalProperties":{"type":"string"},"description":"The Image Builder tags to filter on."}},"type":"object"},"aws-native:imagebuilder:LifecyclePolicyFilter":{"description":"The filters to apply of the policy detail.","properties":{"retainAtLeast":{"type":"integer","description":"The minimum number of Image Builder resources to retain."},"type":{"$ref":"#/types/aws-native:imagebuilder:LifecyclePolicyFilterType","description":"The filter type."},"unit":{"$ref":"#/types/aws-native:imagebuilder:LifecyclePolicyTimeUnit","description":"The value's time unit."},"value":{"type":"integer","description":"The filter value."}},"type":"object","required":["type","value"]},"aws-native:imagebuilder:LifecyclePolicyFilterType":{"description":"The filter type.","type":"string","enum":[{"name":"Age","value":"AGE"},{"name":"Count","value":"COUNT"}]},"aws-native:imagebuilder:LifecyclePolicyIncludeResources":{"description":"The included resources of the policy detail.","properties":{"amis":{"type":"boolean","description":"Use to configure lifecycle actions on AMIs."},"containers":{"type":"boolean","description":"Use to configure lifecycle actions on containers."},"snapshots":{"type":"boolean","description":"Use to configure lifecycle actions on snapshots."}},"type":"object"},"aws-native:imagebuilder:LifecyclePolicyLastLaunched":{"description":"The last launched time of a resource.","properties":{"unit":{"$ref":"#/types/aws-native:imagebuilder:LifecyclePolicyTimeUnit","description":"The value's time unit."},"value":{"type":"integer","description":"The last launched value."}},"type":"object","required":["unit","value"]},"aws-native:imagebuilder:LifecyclePolicyPolicyDetail":{"description":"The policy detail of the lifecycle policy.","properties":{"action":{"$ref":"#/types/aws-native:imagebuilder:LifecyclePolicyAction","description":"Configuration details for the policy action."},"exclusionRules":{"$ref":"#/types/aws-native:imagebuilder:LifecyclePolicyExclusionRules","description":"Additional rules to specify resources that should be exempt from policy actions."},"filter":{"$ref":"#/types/aws-native:imagebuilder:LifecyclePolicyFilter","description":"Specifies the resources that the lifecycle policy applies to."}},"type":"object","required":["action","filter"]},"aws-native:imagebuilder:LifecyclePolicyRecipeSelection":{"description":"The recipe to apply the lifecycle policy for.","properties":{"name":{"type":"string","description":"The recipe name."},"semanticVersion":{"type":"string","description":"The recipe version."}},"type":"object","required":["name","semanticVersion"]},"aws-native:imagebuilder:LifecyclePolicyResourceSelection":{"description":"The resource selection for the lifecycle policy.","properties":{"recipes":{"type":"array","items":{"$ref":"#/types/aws-native:imagebuilder:LifecyclePolicyRecipeSelection"},"description":"The recipes to select."},"tagMap":{"type":"object","additionalProperties":{"type":"string"},"description":"The Image Builder resources to select by tag."}},"type":"object"},"aws-native:imagebuilder:LifecyclePolicyResourceType":{"description":"The resource type of the lifecycle policy.","type":"string","enum":[{"name":"AmiImage","value":"AMI_IMAGE"},{"name":"ContainerImage","value":"CONTAINER_IMAGE"}]},"aws-native:imagebuilder:LifecyclePolicyStatus":{"description":"The status of the lifecycle policy.","type":"string","enum":[{"name":"Disabled","value":"DISABLED"},{"name":"Enabled","value":"ENABLED"}]},"aws-native:imagebuilder:LifecyclePolicyTimeUnit":{"description":"A time unit.","type":"string","enum":[{"name":"Days","value":"DAYS"},{"name":"Weeks","value":"WEEKS"},{"name":"Months","value":"MONTHS"},{"name":"Years","value":"YEARS"}]},"aws-native:imagebuilder:WorkflowLatestVersion":{"description":"The latest version references of the workflow.","properties":{"arn":{"type":"string","description":"The latest version ARN of the created workflow."},"major":{"type":"string","description":"The latest version ARN of the created workflow, with the same major version."},"minor":{"type":"string","description":"The latest version ARN of the created workflow, with the same minor version."},"patch":{"type":"string","description":"The latest version ARN of the created workflow, with the same patch version."}},"type":"object"},"aws-native:imagebuilder:WorkflowType":{"description":"The type of the workflow denotes whether the workflow is used to build, test, or distribute.","type":"string","enum":[{"name":"Build","value":"BUILD"},{"name":"Test","value":"TEST"},{"name":"Distribution","value":"DISTRIBUTION"}]},"aws-native:index/Region:Region":{"description":"A Region represents any valid Amazon region that may be targeted with deployments.","type":"string","enum":[{"name":"AfSouth1","description":"Africa (Cape Town)","value":"af-south-1"},{"name":"ApEast1","description":"Asia Pacific (Hong Kong)","value":"ap-east-1"},{"name":"ApEast2","description":"Asia Pacific (Taipei)","value":"ap-east-2"},{"name":"ApNortheast1","description":"Asia Pacific (Tokyo)","value":"ap-northeast-1"},{"name":"ApNortheast2","description":"Asia Pacific (Seoul)","value":"ap-northeast-2"},{"name":"ApNortheast3","description":"Asia Pacific (Osaka)","value":"ap-northeast-3"},{"name":"ApSouth1","description":"Asia Pacific (Mumbai)","value":"ap-south-1"},{"name":"ApSouth2","description":"Asia Pacific (Hyderabad)","value":"ap-south-2"},{"name":"ApSoutheast1","description":"Asia Pacific (Singapore)","value":"ap-southeast-1"},{"name":"ApSoutheast2","description":"Asia Pacific (Sydney)","value":"ap-southeast-2"},{"name":"ApSoutheast3","description":"Asia Pacific (Jakarta)","value":"ap-southeast-3"},{"name":"ApSoutheast4","description":"Asia Pacific (Melbourne)","value":"ap-southeast-4"},{"name":"ApSoutheast5","description":"Asia Pacific (Malaysia)","value":"ap-southeast-5"},{"name":"ApSoutheast6","description":"Asia Pacific (New Zealand)","value":"ap-southeast-6"},{"name":"ApSoutheast7","description":"Asia Pacific (Thailand)","value":"ap-southeast-7"},{"name":"CaCentral1","description":"Canada (Central)","value":"ca-central-1"},{"name":"CaWest1","description":"Canada West (Calgary)","value":"ca-west-1"},{"name":"CnNorth1","description":"China (Beijing)","value":"cn-north-1"},{"name":"CnNorthwest1","description":"China (Ningxia)","value":"cn-northwest-1"},{"name":"EuCentral1","description":"Europe (Frankfurt)","value":"eu-central-1"},{"name":"EuCentral2","description":"Europe (Zurich)","value":"eu-central-2"},{"name":"EuIsoeWest1","description":"EU ISOE West","value":"eu-isoe-west-1"},{"name":"EuNorth1","description":"Europe (Stockholm)","value":"eu-north-1"},{"name":"EuSouth1","description":"Europe (Milan)","value":"eu-south-1"},{"name":"EuSouth2","description":"Europe (Spain)","value":"eu-south-2"},{"name":"EuWest1","description":"Europe (Ireland)","value":"eu-west-1"},{"name":"EuWest2","description":"Europe (London)","value":"eu-west-2"},{"name":"EuWest3","description":"Europe (Paris)","value":"eu-west-3"},{"name":"EuscDeEast1","description":"AWS European Sovereign Cloud (Germany)","value":"eusc-de-east-1"},{"name":"IlCentral1","description":"Israel (Tel Aviv)","value":"il-central-1"},{"name":"MeCentral1","description":"Middle East (UAE)","value":"me-central-1"},{"name":"MeSouth1","description":"Middle East (Bahrain)","value":"me-south-1"},{"name":"MxCentral1","description":"Mexico (Central)","value":"mx-central-1"},{"name":"SaEast1","description":"South America (Sao Paulo)","value":"sa-east-1"},{"name":"UsEast1","description":"US East (N. Virginia)","value":"us-east-1"},{"name":"UsEast2","description":"US East (Ohio)","value":"us-east-2"},{"name":"UsGovEast1","description":"AWS GovCloud (US-East)","value":"us-gov-east-1"},{"name":"UsGovWest1","description":"AWS GovCloud (US-West)","value":"us-gov-west-1"},{"name":"UsIsoEast1","description":"US ISO East","value":"us-iso-east-1"},{"name":"UsIsoWest1","description":"US ISO WEST","value":"us-iso-west-1"},{"name":"UsIsobEast1","description":"US ISOB East (Ohio)","value":"us-isob-east-1"},{"name":"UsIsobWest1","description":"US ISOB West","value":"us-isob-west-1"},{"name":"UsIsofEast1","description":"US ISOF EAST","value":"us-isof-east-1"},{"name":"UsIsofSouth1","description":"US ISOF SOUTH","value":"us-isof-south-1"},{"name":"UsWest1","description":"US West (N. California)","value":"us-west-1"},{"name":"UsWest2","description":"US West (Oregon)","value":"us-west-2"}]},"aws-native:index:AutoNaming":{"description":"Auto-naming specification for the resource.","properties":{"maxLength":{"type":"integer","description":"The maximum length of the name."},"minLength":{"type":"integer","description":"The minimum length of the name."},"propertyName":{"type":"string","description":"The name of the property in the Cloud Control payload that is used to set the name of the resource."}},"type":"object"},"aws-native:index:CreateOnlyTag":{"description":"A set of tags to apply to the resource.","properties":{"key":{"type":"string","description":"The key name of the tag","replaceOnChanges":true},"value":{"type":"string","description":"The value of the tag","replaceOnChanges":true}},"type":"object","required":["key","value"]},"aws-native:index:ProviderAssumeRole":{"description":"The configuration for a Provider to assume a role.","properties":{"durationSeconds":{"type":"integer","description":"Number of seconds to restrict the assume role session duration.","language":{"python":{"mapCase":false}}},"externalId":{"type":"string","description":"External identifier to use when assuming the role.","language":{"python":{"mapCase":false}}},"policy":{"type":"string","description":"IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.","language":{"python":{"mapCase":false}}},"policyArns":{"type":"array","items":{"type":"string"},"description":"Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the role.","language":{"python":{"mapCase":false}}},"roleArn":{"type":"string","description":"Amazon Resource Name (ARN) of the IAM Role to assume.","language":{"python":{"mapCase":false}}},"sessionName":{"type":"string","description":"Session name to use when assuming the role.","language":{"python":{"mapCase":false}}},"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of assume role session tags.","language":{"python":{"mapCase":false}}},"transitiveTagKeys":{"type":"array","items":{"type":"string"},"description":"A list of keys for session tags that you want to set as transitive. If you set a tag key as transitive, the corresponding key and value passes to subsequent sessions in a role chain.","language":{"python":{"mapCase":false}}}},"type":"object"},"aws-native:index:ProviderAutoNaming":{"description":"The configuration for automatically naming resources.","properties":{"autoTrim":{"type":"boolean","description":"Automatically trim the auto-generated name to meet the maximum length constraint.","language":{"python":{"mapCase":false}}},"randomSuffixMinLength":{"type":"integer","description":"The minimum length of the random suffix to append to the auto-generated name.","default":1,"language":{"python":{"mapCase":false}}}},"type":"object"},"aws-native:index:ProviderDefaultTags":{"description":"The configuration with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys.","properties":{"tags":{"type":"object","additionalProperties":{"type":"string"},"description":"A group of tags to set across all resources.","language":{"python":{"mapCase":false}}}},"type":"object"},"aws-native:index:ProviderEndpoint":{"description":"The configuration for for customizing service endpoints.","properties":{"cloudcontrol":{"type":"string","description":"Override the default endpoint for AWS CloudControl","language":{"python":{"mapCase":false}}},"cloudformation":{"type":"string","description":"Override the default endpoint for AWS CloudFormation","language":{"python":{"mapCase":false}}},"ec2":{"type":"string","description":"Override the default endpoint for AWS Elastic Compute Cloud (EC2)","language":{"python":{"mapCase":false}}},"ssm":{"type":"string","description":"Override the default endpoint for AWS Systems Manager","language":{"python":{"mapCase":false}}},"sts":{"type":"string","description":"Override the default endpoint for AWS Security Token Service (STS)","language":{"python":{"mapCase":false}}}},"type":"object"},"aws-native:index:ProviderIgnoreTags":{"description":"The configuration with resource tag settings to ignore across all resources handled by this provider (except any individual service tag resources such as `ec2.Tag`) for situations where external systems are managing certain resource tags.","properties":{"keyPrefixes":{"type":"array","items":{"type":"string"},"description":"List of exact resource tag keys to ignore across all resources handled by this provider. This configuration prevents Pulumi from returning the tag in any `tags` attributes and displaying any configuration difference for the tag value. If any resource configuration still has this tag key configured in the `tags` argument, it will display a perpetual difference until the tag is removed from the argument or `ignoreChanges` is also used.","language":{"python":{"mapCase":false}}},"keys":{"type":"array","items":{"type":"string"},"description":"List of resource tag key prefixes to ignore across all resources handled by this provider. This configuration prevents Pulumi from returning any tag key matching the prefixes in any `tags` attributes and displaying any configuration difference for those tag values. If any resource configuration still has a tag matching one of the prefixes configured in the `tags` argument, it will display a perpetual difference until the tag is removed from the argument or `ignoreChanges` is also used.","language":{"python":{"mapCase":false}}}},"type":"object"},"aws-native:index:Tag":{"description":"A set of tags to apply to the resource.","properties":{"key":{"type":"string","description":"The key name of the tag"},"value":{"type":"string","description":"The value of the tag"}},"type":"object","required":["key","value"]},"aws-native:inspector:AssessmentTemplateTag":{"properties":{"key":{"type":"string","description":"A tag key."},"value":{"type":"string","description":"A value assigned to a tag key."}},"type":"object","required":["key","value"]},"aws-native:inspector:ResourceGroupTag":{"properties":{"key":{"type":"string","description":"A tag key."},"value":{"type":"string","description":"A value assigned to a tag key."}},"type":"object","required":["key","value"]},"aws-native:inspectorv2:CisScanConfigurationCisSecurityLevel":{"type":"string","enum":[{"name":"Level1","value":"LEVEL_1"},{"name":"Level2","value":"LEVEL_2"}]},"aws-native:inspectorv2:CisScanConfigurationCisTargets":{"properties":{"accountIds":{"type":"array","items":{"type":"string"}},"targetResourceTags":{"type":"object","additionalProperties":{"$ref":"pulumi.json#/Any"}}},"type":"object","required":["accountIds","targetResourceTags"]},"aws-native:inspectorv2:CisScanConfigurationDailySchedule":{"properties":{"startTime":{"$ref":"#/types/aws-native:inspectorv2:CisScanConfigurationTime"}},"type":"object","required":["startTime"]},"aws-native:inspectorv2:CisScanConfigurationDay":{"type":"string","enum":[{"name":"Mon","value":"MON"},{"name":"Tue","value":"TUE"},{"name":"Wed","value":"WED"},{"name":"Thu","value":"THU"},{"name":"Fri","value":"FRI"},{"name":"Sat","value":"SAT"},{"name":"Sun","value":"SUN"}]},"aws-native:inspectorv2:CisScanConfigurationMonthlySchedule":{"properties":{"day":{"$ref":"#/types/aws-native:inspectorv2:CisScanConfigurationDay"},"startTime":{"$ref":"#/types/aws-native:inspectorv2:CisScanConfigurationTime"}},"type":"object","required":["day","startTime"]},"aws-native:inspectorv2:CisScanConfigurationOneTimeSchedule":{"type":"object"},"aws-native:inspectorv2:CisScanConfigurationSchedule":{"description":"Choose a Schedule cadence","properties":{"daily":{"$ref":"#/types/aws-native:inspectorv2:CisScanConfigurationDailySchedule"},"monthly":{"$ref":"#/types/aws-native:inspectorv2:CisScanConfigurationMonthlySchedule"},"oneTime":{"$ref":"#/types/aws-native:inspectorv2:CisScanConfigurationOneTimeSchedule"},"weekly":{"$ref":"#/types/aws-native:inspectorv2:CisScanConfigurationWeeklySchedule"}},"type":"object"},"aws-native:inspectorv2:CisScanConfigurationTime":{"properties":{"timeOfDay":{"type":"string"},"timeZone":{"type":"string"}},"type":"object","required":["timeOfDay","timeZone"]},"aws-native:inspectorv2:CisScanConfigurationWeeklySchedule":{"properties":{"days":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:CisScanConfigurationDay"}},"startTime":{"$ref":"#/types/aws-native:inspectorv2:CisScanConfigurationTime"}},"type":"object","required":["days","startTime"]},"aws-native:inspectorv2:CodeSecurityIntegrationCreateDetails":{"properties":{"gitlabSelfManaged":{"$ref":"#/types/aws-native:inspectorv2:CodeSecurityIntegrationCreateGitLabSelfManagedIntegrationDetail","description":"Details specific to creating an integration with a self-managed GitLab instance."}},"type":"object","required":["gitlabSelfManaged"]},"aws-native:inspectorv2:CodeSecurityIntegrationCreateGitLabSelfManagedIntegrationDetail":{"properties":{"accessToken":{"type":"string","description":"The personal access token used to authenticate with the self-managed GitLab instance."},"instanceUrl":{"type":"string","description":"The URL of the self-managed GitLab instance."}},"type":"object","required":["accessToken","instanceUrl"]},"aws-native:inspectorv2:CodeSecurityIntegrationIntegrationStatus":{"type":"string","enum":[{"name":"Pending","value":"PENDING"},{"name":"InProgress","value":"IN_PROGRESS"},{"name":"Active","value":"ACTIVE"},{"name":"Inactive","value":"INACTIVE"},{"name":"Disabling","value":"DISABLING"}]},"aws-native:inspectorv2:CodeSecurityIntegrationIntegrationType":{"type":"string","enum":[{"name":"GitlabSelfManaged","value":"GITLAB_SELF_MANAGED"},{"name":"Github","value":"GITHUB"}]},"aws-native:inspectorv2:CodeSecurityIntegrationUpdateDetails":{"properties":{"github":{"$ref":"#/types/aws-native:inspectorv2:CodeSecurityIntegrationUpdateGitHubIntegrationDetail","description":"Details specific to updating an integration with GitHub."},"gitlabSelfManaged":{"$ref":"#/types/aws-native:inspectorv2:CodeSecurityIntegrationUpdateGitLabSelfManagedIntegrationDetail","description":"Details specific to updating an integration with a self-managed GitLab instance."}},"type":"object"},"aws-native:inspectorv2:CodeSecurityIntegrationUpdateGitHubIntegrationDetail":{"properties":{"code":{"type":"string","description":"The authorization code received from GitHub to update the integration."},"installationId":{"type":"string","description":"The installation ID of the GitHub App associated with the integration."}},"type":"object","required":["code","installationId"]},"aws-native:inspectorv2:CodeSecurityIntegrationUpdateGitLabSelfManagedIntegrationDetail":{"properties":{"authCode":{"type":"string","description":"The authorization code received from the self-managed GitLab instance to update the integration."}},"type":"object","required":["authCode"]},"aws-native:inspectorv2:CodeSecurityScanConfiguration":{"properties":{"continuousIntegrationScanConfiguration":{"$ref":"#/types/aws-native:inspectorv2:CodeSecurityScanConfigurationContinuousIntegrationScanConfiguration","description":"Configuration settings for continuous integration scans that run automatically when code changes are made."},"periodicScanConfiguration":{"$ref":"#/types/aws-native:inspectorv2:CodeSecurityScanConfigurationPeriodicScanConfiguration","description":"Configuration settings for periodic scans that run on a scheduled basis."},"ruleSetCategories":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:CodeSecurityScanConfigurationRuleSetCategory"},"description":"The categories of security rules to be applied during the scan."}},"type":"object","required":["ruleSetCategories"]},"aws-native:inspectorv2:CodeSecurityScanConfigurationConfigurationLevel":{"type":"string","enum":[{"name":"Organization","value":"ORGANIZATION"},{"name":"Account","value":"ACCOUNT"}]},"aws-native:inspectorv2:CodeSecurityScanConfigurationContinuousIntegrationScanConfiguration":{"properties":{"supportedEvents":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:CodeSecurityScanConfigurationContinuousIntegrationScanEvent"},"description":"The repository events that trigger continuous integration scans, such as pull requests or commits."}},"type":"object","required":["supportedEvents"]},"aws-native:inspectorv2:CodeSecurityScanConfigurationContinuousIntegrationScanEvent":{"type":"string","enum":[{"name":"PullRequest","value":"PULL_REQUEST"},{"name":"Push","value":"PUSH"}]},"aws-native:inspectorv2:CodeSecurityScanConfigurationPeriodicScanConfiguration":{"properties":{"frequency":{"$ref":"#/types/aws-native:inspectorv2:CodeSecurityScanConfigurationPeriodicScanFrequency","description":"The frequency at which periodic scans are performed (such as weekly or monthly).\n\nIf you don't provide the `frequencyExpression` Amazon Inspector chooses day for the scan to run. If you provide the `frequencyExpression` , the schedule must match the specified `frequency` ."},"frequencyExpression":{"type":"string","description":"The schedule expression for periodic scans, in cron format."}},"type":"object"},"aws-native:inspectorv2:CodeSecurityScanConfigurationPeriodicScanFrequency":{"type":"string","enum":[{"name":"Weekly","value":"WEEKLY"},{"name":"Monthly","value":"MONTHLY"},{"name":"Never","value":"NEVER"}]},"aws-native:inspectorv2:CodeSecurityScanConfigurationProjectSelectionScope":{"type":"string","enum":[{"name":"All","value":"ALL"}]},"aws-native:inspectorv2:CodeSecurityScanConfigurationRuleSetCategory":{"type":"string","enum":[{"name":"Sast","value":"SAST"},{"name":"Iac","value":"IAC"},{"name":"Sca","value":"SCA"}]},"aws-native:inspectorv2:CodeSecurityScanConfigurationScopeSettings":{"properties":{"projectSelectionScope":{"$ref":"#/types/aws-native:inspectorv2:CodeSecurityScanConfigurationProjectSelectionScope","description":"The scope of projects to be selected for scanning within the integrated repositories."}},"type":"object"},"aws-native:inspectorv2:FilterAction":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Suppress","value":"SUPPRESS"}]},"aws-native:inspectorv2:FilterCriteria":{"properties":{"awsAccountId":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details of the AWS account IDs used to filter findings."},"codeVulnerabilityDetectorName":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"}},"codeVulnerabilityDetectorTags":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"}},"codeVulnerabilityFilePath":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"}},"componentId":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details of the component IDs used to filter findings."},"componentType":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details of the component types used to filter findings."},"ec2InstanceImageId":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details of the Amazon EC2 instance image IDs used to filter findings."},"ec2InstanceSubnetId":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details of the Amazon EC2 instance subnet IDs used to filter findings."},"ec2InstanceVpcId":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details of the Amazon EC2 instance VPC IDs used to filter findings."},"ecrImageArchitecture":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details of the Amazon ECR image architecture types used to filter findings."},"ecrImageHash":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details of the Amazon ECR image hashes used to filter findings."},"ecrImagePushedAt":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterDateFilter"},"description":"Details on the Amazon ECR image push date and time used to filter findings."},"ecrImageRegistry":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the Amazon ECR registry used to filter findings."},"ecrImageRepositoryName":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the name of the Amazon ECR repository used to filter findings."},"ecrImageTags":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"The tags attached to the Amazon ECR container image."},"epssScore":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterNumberFilter"}},"exploitAvailable":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"}},"findingArn":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the finding ARNs used to filter findings."},"findingStatus":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the finding status types used to filter findings."},"findingType":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the finding types used to filter findings."},"firstObservedAt":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterDateFilter"},"description":"Details on the date and time a finding was first seen used to filter findings."},"fixAvailable":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"}},"inspectorScore":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterNumberFilter"},"description":"The Amazon Inspector score to filter on."},"lambdaFunctionExecutionRoleArn":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"}},"lambdaFunctionLastModifiedAt":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterDateFilter"}},"lambdaFunctionLayers":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"}},"lambdaFunctionName":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"}},"lambdaFunctionRuntime":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"}},"lastObservedAt":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterDateFilter"},"description":"Details on the date and time a finding was last seen used to filter findings."},"networkProtocol":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on network protocol used to filter findings."},"portRange":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterPortRangeFilter"},"description":"Details on the port ranges used to filter findings."},"relatedVulnerabilities":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the related vulnerabilities used to filter findings."},"resourceId":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the resource IDs used to filter findings."},"resourceTags":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterMapFilter"},"description":"Details on the resource tags used to filter findings."},"resourceType":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the resource types used to filter findings."},"severity":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the severity used to filter findings."},"title":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the finding title used to filter findings."},"updatedAt":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterDateFilter"},"description":"Details on the date and time a finding was last updated at used to filter findings."},"vendorSeverity":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the vendor severity used to filter findings."},"vulnerabilityId":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the vulnerability ID used to filter findings."},"vulnerabilitySource":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"description":"Details on the vulnerability score to filter findings by."},"vulnerablePackages":{"type":"array","items":{"$ref":"#/types/aws-native:inspectorv2:FilterPackageFilter"},"description":"Details on the vulnerable packages used to filter findings."}},"type":"object"},"aws-native:inspectorv2:FilterDateFilter":{"properties":{"endInclusive":{"type":"integer"},"startInclusive":{"type":"integer"}},"type":"object"},"aws-native:inspectorv2:FilterMapComparison":{"type":"string","enum":[{"name":"Equals","value":"EQUALS"}]},"aws-native:inspectorv2:FilterMapFilter":{"properties":{"comparison":{"$ref":"#/types/aws-native:inspectorv2:FilterMapComparison"},"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["comparison"]},"aws-native:inspectorv2:FilterNumberFilter":{"properties":{"lowerInclusive":{"type":"number"},"upperInclusive":{"type":"number"}},"type":"object"},"aws-native:inspectorv2:FilterPackageFilter":{"properties":{"architecture":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"epoch":{"$ref":"#/types/aws-native:inspectorv2:FilterNumberFilter"},"filePath":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"name":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"release":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"sourceLambdaLayerArn":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"sourceLayerHash":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"},"version":{"$ref":"#/types/aws-native:inspectorv2:FilterStringFilter"}},"type":"object"},"aws-native:inspectorv2:FilterPortRangeFilter":{"properties":{"beginInclusive":{"type":"integer"},"endInclusive":{"type":"integer"}},"type":"object"},"aws-native:inspectorv2:FilterStringComparison":{"type":"string","enum":[{"name":"Equals","value":"EQUALS"},{"name":"Prefix","value":"PREFIX"},{"name":"NotEquals","value":"NOT_EQUALS"}]},"aws-native:inspectorv2:FilterStringFilter":{"properties":{"comparison":{"$ref":"#/types/aws-native:inspectorv2:FilterStringComparison"},"value":{"type":"string"}},"type":"object","required":["comparison","value"]},"aws-native:internetmonitor:MonitorConfigState":{"type":"string","enum":[{"name":"Pending","value":"PENDING"},{"name":"Active","value":"ACTIVE"},{"name":"Inactive","value":"INACTIVE"},{"name":"Error","value":"ERROR"}]},"aws-native:internetmonitor:MonitorHealthEventsConfig":{"properties":{"availabilityLocalHealthEventsConfig":{"$ref":"#/types/aws-native:internetmonitor:MonitorLocalHealthEventsConfig","description":"The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue."},"availabilityScoreThreshold":{"type":"number","description":"The health event threshold percentage set for availability scores. When the overall availability score is at or below this percentage, Internet Monitor creates a health event."},"performanceLocalHealthEventsConfig":{"$ref":"#/types/aws-native:internetmonitor:MonitorLocalHealthEventsConfig","description":"The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue."},"performanceScoreThreshold":{"type":"number","description":"The health event threshold percentage set for performance scores. When the overall performance score is at or below this percentage, Internet Monitor creates a health event."}},"type":"object"},"aws-native:internetmonitor:MonitorInternetMeasurementsLogDelivery":{"properties":{"s3Config":{"$ref":"#/types/aws-native:internetmonitor:MonitorS3Config","description":"The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3."}},"type":"object"},"aws-native:internetmonitor:MonitorLocalHealthEventsConfig":{"properties":{"healthScoreThreshold":{"type":"number","description":"The health event threshold percentage set for a local health score."},"minTrafficImpact":{"type":"number","description":"The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.\n\nIf you don't set a minimum traffic impact threshold, the default value is 0.01%."},"status":{"$ref":"#/types/aws-native:internetmonitor:MonitorLocalHealthEventsConfigStatus","description":"The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be `ENABLED` or `DISABLED` ."}},"type":"object"},"aws-native:internetmonitor:MonitorLocalHealthEventsConfigStatus":{"description":"The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be `ENABLED` or `DISABLED` .","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:internetmonitor:MonitorProcessingStatusCode":{"type":"string","enum":[{"name":"Ok","value":"OK"},{"name":"Inactive","value":"INACTIVE"},{"name":"CollectingData","value":"COLLECTING_DATA"},{"name":"InsufficientData","value":"INSUFFICIENT_DATA"},{"name":"FaultService","value":"FAULT_SERVICE"},{"name":"FaultAccessCloudwatch","value":"FAULT_ACCESS_CLOUDWATCH"}]},"aws-native:internetmonitor:MonitorS3Config":{"properties":{"bucketName":{"type":"string","description":"The Amazon S3 bucket name for internet measurements publishing."},"bucketPrefix":{"type":"string","description":"An optional Amazon S3 bucket prefix for internet measurements publishing."},"logDeliveryStatus":{"$ref":"#/types/aws-native:internetmonitor:MonitorS3ConfigLogDeliveryStatus","description":"The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is `ENABLED` if you choose to deliver internet measurements to an S3 bucket, and `DISABLED` otherwise."}},"type":"object"},"aws-native:internetmonitor:MonitorS3ConfigLogDeliveryStatus":{"description":"The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is `ENABLED` if you choose to deliver internet measurements to an S3 bucket, and `DISABLED` otherwise.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:internetmonitor:MonitorTag":{"description":"The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:invoicing:InvoiceUnitResourceTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:invoicing:InvoiceUnitRule":{"properties":{"linkedAccounts":{"type":"array","items":{"type":"string"},"description":"The list of `LINKED_ACCOUNT` IDs where charges are included within the invoice unit."}},"type":"object","required":["linkedAccounts"]},"aws-native:iot:AbortConfigProperties":{"description":"The criteria that determine when and how a job abort takes place.","properties":{"criteriaList":{"type":"array","items":{"$ref":"#/types/aws-native:iot:JobTemplateAbortCriteria"},"description":"The list of criteria that determine when and how to abort the job."}},"type":"object","required":["criteriaList"]},"aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration":{"description":"The configuration for a specific audit check.","properties":{"enabled":{"type":"boolean","description":"True if the check is enabled."}},"type":"object"},"aws-native:iot:AccountAuditConfigurationAuditCheckConfigurations":{"description":"Specifies which audit checks are enabled and disabled for this account.","properties":{"authenticatedCognitoRoleOverlyPermissiveCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks the permissiveness of an authenticated Amazon Cognito identity pool role. For this check, AWS IoT Device Defender audits all Amazon Cognito identity pools that have been used to connect to the AWS IoT message broker during the 31 days before the audit is performed."},"caCertificateExpiringCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks if a CA certificate is expiring. This check applies to CA certificates expiring within 30 days or that have expired."},"caCertificateKeyQualityCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks the quality of the CA certificate key. The quality checks if the key is in a valid format, not expired, and if the key meets a minimum required size. This check applies to CA certificates that are `ACTIVE` or `PENDING_TRANSFER` ."},"conflictingClientIdsCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks if multiple devices connect using the same client ID."},"deviceCertificateAgeCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationDeviceCertAgeAuditCheckConfiguration","description":"Checks when a device certificate has been active for a number of days greater than or equal to the number you specify."},"deviceCertificateExpiringCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationDeviceCertExpirationAuditCheckConfiguration","description":"Checks if a device certificate is expiring. By default, this check applies to device certificates expiring within 30 days or that have expired. You can modify this threshold by configuring the DeviceCertExpirationAuditCheckConfiguration."},"deviceCertificateKeyQualityCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks the quality of the device certificate key. The quality checks if the key is in a valid format, not expired, signed by a registered certificate authority, and if the key meets a minimum required size."},"deviceCertificateSharedCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks if multiple concurrent connections use the same X.509 certificate to authenticate with AWS IoT ."},"intermediateCaRevokedForActiveDeviceCertificatesCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks if device certificates are still active despite being revoked by an intermediate CA."},"ioTPolicyPotentialMisConfigurationCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks if an AWS IoT policy is potentially misconfigured. Misconfigured policies, including overly permissive policies, can cause security incidents like allowing devices access to unintended resources. This check is a warning for you to make sure that only intended actions are allowed before updating the policy."},"iotPolicyOverlyPermissiveCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks the permissiveness of a policy attached to an authenticated Amazon Cognito identity pool role."},"iotRoleAliasAllowsAccessToUnusedServicesCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks if a role alias has access to services that haven't been used for the AWS IoT device in the last year."},"iotRoleAliasOverlyPermissiveCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks if the temporary credentials provided by AWS IoT role aliases are overly permissive."},"loggingDisabledCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks if AWS IoT logs are disabled."},"revokedCaCertificateStillActiveCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks if a revoked CA certificate is still active."},"revokedDeviceCertificateStillActiveCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks if a revoked device certificate is still active."},"unauthenticatedCognitoRoleOverlyPermissiveCheck":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditCheckConfiguration","description":"Checks if policy attached to an unauthenticated Amazon Cognito identity pool role is too permissive."}},"type":"object"},"aws-native:iot:AccountAuditConfigurationAuditNotificationTarget":{"properties":{"enabled":{"type":"boolean","description":"True if notifications to the target are enabled."},"roleArn":{"type":"string","description":"The ARN of the role that grants permission to send notifications to the target."},"targetArn":{"type":"string","description":"The ARN of the target (SNS topic) to which audit notifications are sent."}},"type":"object"},"aws-native:iot:AccountAuditConfigurationAuditNotificationTargetConfigurations":{"description":"Information about the targets to which audit notifications are sent.","properties":{"sns":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationAuditNotificationTarget","description":"The `Sns` notification target."}},"type":"object"},"aws-native:iot:AccountAuditConfigurationCertAgeCheckCustomConfiguration":{"description":"A structure containing the configName and corresponding configValue for configuring audit checks.","properties":{"certAgeThresholdInDays":{"type":"string","description":"The number of days that defines when a device certificate is considered to have aged. The check will report a finding if a certificate has been active for a number of days greater than or equal to this threshold value."}},"type":"object"},"aws-native:iot:AccountAuditConfigurationCertExpirationCheckCustomConfiguration":{"description":"A structure containing the configName and corresponding configValue for configuring audit checks.","properties":{"certExpirationThresholdInDays":{"type":"string","description":"The number of days before expiration that defines when a device certificate is considered to be approaching expiration. The check will report a finding if a certificate will expire within this number of days."}},"type":"object"},"aws-native:iot:AccountAuditConfigurationDeviceCertAgeAuditCheckConfiguration":{"description":"A structure containing the configName and corresponding configValue for configuring DeviceCertAgeCheck.","properties":{"configuration":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationCertAgeCheckCustomConfiguration","description":"Configuration settings for the device certificate age check, including the threshold in days for certificate age. This configuration is of type `CertAgeCheckCustomConfiguration` ."},"enabled":{"type":"boolean","description":"True if the check is enabled."}},"type":"object"},"aws-native:iot:AccountAuditConfigurationDeviceCertExpirationAuditCheckConfiguration":{"description":"A structure containing the configName and corresponding configValue for configuring DeviceCertExpirationCheck.","properties":{"configuration":{"$ref":"#/types/aws-native:iot:AccountAuditConfigurationCertExpirationCheckCustomConfiguration","description":"Configuration settings for the device certificate expiration check, including the threshold in days before expiration. This configuration is of type `CertExpirationCheckCustomConfiguration`"},"enabled":{"type":"boolean","description":"True if the check is enabled."}},"type":"object"},"aws-native:iot:AuthorizerStatus":{"description":"The status of the authorizer.\n\nValid values: `ACTIVE` | `INACTIVE`","type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Inactive","value":"INACTIVE"}]},"aws-native:iot:AuthorizerTag":{"properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iot:BillingGroupPropertiesProperties":{"description":"The properties of the billing group.","properties":{"billingGroupDescription":{"type":"string","description":"The description of the billing group."}},"type":"object"},"aws-native:iot:BillingGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"Tag key (1-128 chars). No 'aws:' prefix. Allows: [A-Za-z0-9 _.:/=+-]"},"value":{"type":"string","description":"Tag value (1-256 chars). No 'aws:' prefix. Allows: [A-Za-z0-9 _.:/=+-]"}},"type":"object","required":["key","value"]},"aws-native:iot:CaCertificateAutoRegistrationStatus":{"description":"Whether the CA certificate is configured for auto registration of device certificates. Valid values are \"ENABLE\" and \"DISABLE\".","type":"string","enum":[{"name":"Enable","value":"ENABLE"},{"name":"Disable","value":"DISABLE"}]},"aws-native:iot:CaCertificateCertificateMode":{"description":"The mode of the CA.\n\nAll the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see [certificate mode](https://docs.aws.amazon.com//iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode) .\n\nValid values are \"DEFAULT\" and \"SNI_ONLY\".","type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"SniOnly","value":"SNI_ONLY"}]},"aws-native:iot:CaCertificateRegistrationConfig":{"properties":{"roleArn":{"type":"string","description":"The ARN of the role."},"templateBody":{"type":"string","description":"The template body."},"templateName":{"type":"string","description":"The name of the provisioning template."}},"type":"object"},"aws-native:iot:CaCertificateStatus":{"description":"The status of the CA certificate.\n\nValid values are \"ACTIVE\" and \"INACTIVE\".","type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Inactive","value":"INACTIVE"}]},"aws-native:iot:CaCertificateTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:iot:CertificateMode":{"description":"Specifies which mode of certificate registration to use with this resource. Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI_ONLY with CertificatePem, and Default with CertificateSigningRequest.\n\n`DEFAULT` : A certificate in `DEFAULT` mode is either generated by AWS IoT Core or registered with an issuer certificate authority (CA). Devices with certificates in `DEFAULT` mode aren't required to send the Server Name Indication (SNI) extension when connecting to AWS IoT Core . However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to AWS IoT Core .\n\n`SNI_ONLY` : A certificate in `SNI_ONLY` mode is registered without an issuer CA. Devices with certificates in `SNI_ONLY` mode must send the SNI extension when connecting to AWS IoT Core .","type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"SniOnly","value":"SNI_ONLY"}]},"aws-native:iot:CertificateProviderOperation":{"type":"string","enum":[{"name":"CreateCertificateFromCsr","value":"CreateCertificateFromCsr"}]},"aws-native:iot:CertificateProviderTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:iot:CertificateStatus":{"description":"The status of the certificate.\n\nValid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.\n\nThe status value REGISTER_INACTIVE is deprecated and should not be used.","type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Inactive","value":"INACTIVE"},{"name":"Revoked","value":"REVOKED"},{"name":"PendingTransfer","value":"PENDING_TRANSFER"},{"name":"PendingActivation","value":"PENDING_ACTIVATION"}]},"aws-native:iot:CommandAwsJsonSubstitutionCommandPreprocessorConfig":{"properties":{"outputFormat":{"$ref":"#/types/aws-native:iot:CommandOutputFormat"}},"type":"object","required":["outputFormat"]},"aws-native:iot:CommandNamespace":{"description":"The namespace to which the command belongs.","type":"string","enum":[{"name":"AwsIoT","value":"AWS-IoT"},{"name":"AwsIoTFleetWise","value":"AWS-IoT-FleetWise"}]},"aws-native:iot:CommandOutputFormat":{"type":"string","enum":[{"name":"Json","value":"JSON"},{"name":"Cbor","value":"CBOR"}]},"aws-native:iot:CommandParameter":{"properties":{"defaultValue":{"$ref":"#/types/aws-native:iot:CommandParameterValue"},"description":{"type":"string"},"name":{"type":"string"},"type":{"$ref":"#/types/aws-native:iot:CommandParameterType"},"value":{"$ref":"#/types/aws-native:iot:CommandParameterValue"},"valueConditions":{"type":"array","items":{"$ref":"#/types/aws-native:iot:CommandParameterValueCondition"}}},"type":"object","required":["name"]},"aws-native:iot:CommandParameterType":{"type":"string","enum":[{"name":"String","value":"STRING"},{"name":"Integer","value":"INTEGER"},{"name":"Double","value":"DOUBLE"},{"name":"Long","value":"LONG"},{"name":"Unsignedlong","value":"UNSIGNEDLONG"},{"name":"Boolean","value":"BOOLEAN"},{"name":"Binary","value":"BINARY"}]},"aws-native:iot:CommandParameterValue":{"properties":{"b":{"type":"boolean"},"bin":{"type":"string"},"d":{"type":"number"},"i":{"type":"integer"},"l":{"type":"string"},"s":{"type":"string"},"ul":{"type":"string"}},"type":"object"},"aws-native:iot:CommandParameterValueComparisonOperand":{"properties":{"number":{"type":"string"},"numberRange":{"$ref":"#/types/aws-native:iot:CommandParameterValueNumberRange"},"numbers":{"type":"array","items":{"type":"string"}},"string":{"type":"string"},"strings":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:iot:CommandParameterValueComparisonOperator":{"type":"string","enum":[{"name":"Equals","value":"EQUALS"},{"name":"NotEquals","value":"NOT_EQUALS"},{"name":"LessThan","value":"LESS_THAN"},{"name":"LessThanEquals","value":"LESS_THAN_EQUALS"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"GreaterThanEquals","value":"GREATER_THAN_EQUALS"},{"name":"InSet","value":"IN_SET"},{"name":"NotInSet","value":"NOT_IN_SET"},{"name":"InRange","value":"IN_RANGE"},{"name":"NotInRange","value":"NOT_IN_RANGE"}]},"aws-native:iot:CommandParameterValueCondition":{"properties":{"comparisonOperator":{"$ref":"#/types/aws-native:iot:CommandParameterValueComparisonOperator"},"operand":{"$ref":"#/types/aws-native:iot:CommandParameterValueComparisonOperand"}},"type":"object","required":["comparisonOperator","operand"]},"aws-native:iot:CommandParameterValueNumberRange":{"properties":{"max":{"type":"string"},"min":{"type":"string"}},"type":"object","required":["max","min"]},"aws-native:iot:CommandPayload":{"properties":{"content":{"type":"string"},"contentType":{"type":"string"}},"type":"object"},"aws-native:iot:CommandPreprocessor":{"properties":{"awsJsonSubstitution":{"$ref":"#/types/aws-native:iot:CommandAwsJsonSubstitutionCommandPreprocessorConfig"}},"type":"object"},"aws-native:iot:CommandTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iot:ConfigurationDetailsProperties":{"properties":{"configurationStatus":{"$ref":"#/types/aws-native:iot:EncryptionConfigurationConfigurationDetailsPropertiesConfigurationStatus","description":"The health status of KMS key and AWS  access role. If either KMS key or AWS  access role is `UNHEALTHY` , the return value will be `UNHEALTHY` . To use a customer managed KMS key, the value of `configurationStatus` must be `HEALTHY` ."},"errorCode":{"type":"string","description":"The error code that indicates either the KMS key or the AWS  access role is `UNHEALTHY` . Valid values: `KMS_KEY_VALIDATION_ERROR` and `ROLE_VALIDATION_ERROR` ."},"errorMessage":{"type":"string","description":"The detailed error message that corresponds to the `errorCode` ."}},"type":"object"},"aws-native:iot:CustomMetricMetricType":{"description":"The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.","type":"string","enum":[{"name":"StringList","value":"string-list"},{"name":"IpAddressList","value":"ip-address-list"},{"name":"NumberList","value":"number-list"},{"name":"Number","value":"number"}]},"aws-native:iot:CustomMetricTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iot:DimensionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iot:DimensionType":{"description":"Specifies the type of the dimension.","type":"string","enum":[{"name":"TopicFilter","value":"TOPIC_FILTER"}]},"aws-native:iot:DomainConfigurationApplicationProtocol":{"description":"An enumerated string that speciﬁes the application-layer protocol.","type":"string","enum":[{"name":"SecureMqtt","value":"SECURE_MQTT"},{"name":"MqttWss","value":"MQTT_WSS"},{"name":"Https","value":"HTTPS"},{"name":"Default","value":"DEFAULT"}]},"aws-native:iot:DomainConfigurationAuthenticationType":{"description":"An enumerated string that speciﬁes the authentication type.","type":"string","enum":[{"name":"AwsX509","value":"AWS_X509"},{"name":"CustomAuth","value":"CUSTOM_AUTH"},{"name":"AwsSigv4","value":"AWS_SIGV4"},{"name":"CustomAuthX509","value":"CUSTOM_AUTH_X509"},{"name":"Default","value":"DEFAULT"}]},"aws-native:iot:DomainConfigurationAuthorizerConfig":{"properties":{"allowAuthorizerOverride":{"type":"boolean","description":"A Boolean that specifies whether the domain configuration's authorization service can be overridden."},"defaultAuthorizerName":{"type":"string","description":"The name of the authorization service for a domain configuration."}},"type":"object"},"aws-native:iot:DomainConfigurationClientCertificateConfig":{"properties":{"clientCertificateCallbackArn":{"type":"string","description":"The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection."}},"type":"object"},"aws-native:iot:DomainConfigurationDomainType":{"description":"The type of service delivered by the domain.","type":"string","enum":[{"name":"Endpoint","value":"ENDPOINT"},{"name":"AwsManaged","value":"AWS_MANAGED"},{"name":"CustomerManaged","value":"CUSTOMER_MANAGED"}]},"aws-native:iot:DomainConfigurationServerCertificateConfig":{"properties":{"enableOcspCheck":{"type":"boolean","description":"A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server certificate check is enabled or not. For more information, see [Configurable endpoints](https://docs.aws.amazon.com//iot/latest/developerguide/iot-custom-endpoints-configurable.html) from the AWS IoT Core Developer Guide."},"ocspAuthorizedResponderArn":{"type":"string","description":"The Amazon Resource Name (ARN) for an X.509 certificate stored in ACM. If provided, AWS IoT Core will use this certificate to validate the signature of the received OCSP response. The OCSP responder must sign responses using either this authorized responder certificate or the issuing certificate, depending on whether the ARN is provided or not. The certificate must be in the same account and region as the domain configuration."},"ocspLambdaArn":{"type":"string","description":"The Amazon Resource Name (ARN) for a Lambda function that acts as a Request for Comments (RFC) 6960-compliant Online Certificate Status Protocol (OCSP) responder, supporting basic OCSP responses. The Lambda function accepts a base64-encoding of the OCSP request in the Distinguished Encoding Rules (DER) format. The Lambda function's response is also a base64-encoded OCSP response in the DER format. The response size must not exceed 4 kilobytes (KiB). The Lambda function must be in the same account and region as the domain configuration."}},"type":"object"},"aws-native:iot:DomainConfigurationServerCertificateSummary":{"properties":{"serverCertificateArn":{"type":"string","description":"The ARN of the server certificate."},"serverCertificateStatus":{"$ref":"#/types/aws-native:iot:DomainConfigurationServerCertificateSummaryServerCertificateStatus","description":"The status of the server certificate."},"serverCertificateStatusDetail":{"type":"string","description":"Details that explain the status of the server certificate."}},"type":"object"},"aws-native:iot:DomainConfigurationServerCertificateSummaryServerCertificateStatus":{"description":"The status of the server certificate.","type":"string","enum":[{"name":"Invalid","value":"INVALID"},{"name":"Valid","value":"VALID"}]},"aws-native:iot:DomainConfigurationServiceType":{"description":"The type of service delivered by the endpoint.\n\n\u003e AWS IoT Core currently supports only the `DATA` service type.","type":"string","enum":[{"name":"Data","value":"DATA"},{"name":"CredentialProvider","value":"CREDENTIAL_PROVIDER"},{"name":"Jobs","value":"JOBS"}]},"aws-native:iot:DomainConfigurationStatus":{"description":"The status to which the domain configuration should be updated.\n\nValid values: `ENABLED` | `DISABLED`","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:iot:DomainConfigurationTag":{"properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iot:DomainConfigurationTlsConfig":{"properties":{"securityPolicy":{"type":"string","description":"The security policy for a domain configuration. For more information, see [Security policies](https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html#tls-policy-table) in the *AWS IoT Core developer guide* ."}},"type":"object"},"aws-native:iot:EncryptionConfigurationConfigurationDetailsPropertiesConfigurationStatus":{"description":"The health status of KMS key and AWS  access role. If either KMS key or AWS  access role is `UNHEALTHY` , the return value will be `UNHEALTHY` . To use a customer managed KMS key, the value of `configurationStatus` must be `HEALTHY` .","type":"string","enum":[{"name":"Healthy","value":"HEALTHY"},{"name":"Unhealthy","value":"UNHEALTHY"}]},"aws-native:iot:EncryptionConfigurationEncryptionType":{"description":"The type of the KMS key.","type":"string","enum":[{"name":"CustomerManagedKmsKey","value":"CUSTOMER_MANAGED_KMS_KEY"},{"name":"AwsOwnedKmsKey","value":"AWS_OWNED_KMS_KEY"}]},"aws-native:iot:FleetMetricAggregationType":{"description":"Aggregation types supported by Fleet Indexing","properties":{"name":{"type":"string","description":"Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality"},"values":{"type":"array","items":{"type":"string"},"description":"Fleet Indexing aggregation type values"}},"type":"object","required":["name","values"]},"aws-native:iot:FleetMetricTag":{"description":"A key-value pair to associate with a resource","properties":{"key":{"type":"string","description":"The tag's key"},"value":{"type":"string","description":"The tag's value"}},"type":"object","required":["key","value"]},"aws-native:iot:JobExecutionsRetryConfigProperties":{"description":"Allows you to create the criteria to retry a job.","properties":{"retryCriteriaList":{"type":"array","items":{"$ref":"#/types/aws-native:iot:JobTemplateRetryCriteria"},"description":"The list of criteria that determines how many retries are allowed for each failure type for a job."}},"type":"object"},"aws-native:iot:JobExecutionsRolloutConfigProperties":{"description":"Allows you to create a staged rollout of a job.","properties":{"exponentialRolloutRate":{"$ref":"#/types/aws-native:iot:JobTemplateExponentialRolloutRate","description":"The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout."},"maximumPerMinute":{"type":"integer","description":"The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout."}},"type":"object"},"aws-native:iot:JobTemplateAbortCriteria":{"description":"The criteria that determine when and how a job abort takes place.","properties":{"action":{"$ref":"#/types/aws-native:iot:JobTemplateAction","description":"The type of job action to take to initiate the job abort."},"failureType":{"$ref":"#/types/aws-native:iot:JobTemplateFailureType","description":"The type of job execution failures that can initiate a job abort."},"minNumberOfExecutedThings":{"type":"integer","description":"The minimum number of things which must receive job execution notifications before the job can be aborted."},"thresholdPercentage":{"type":"number","description":"The minimum percentage of job execution failures that must occur to initiate the job abort."}},"type":"object","required":["action","failureType","minNumberOfExecutedThings","thresholdPercentage"]},"aws-native:iot:JobTemplateAction":{"type":"string","enum":[{"name":"Cancel","value":"CANCEL"}]},"aws-native:iot:JobTemplateExponentialRolloutRate":{"description":"Allows you to create an exponential rate of rollout for a job.","properties":{"baseRatePerMinute":{"type":"integer","description":"The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout."},"incrementFactor":{"type":"number","description":"The exponential factor to increase the rate of rollout for a job."},"rateIncreaseCriteria":{"$ref":"#/types/aws-native:iot:JobTemplateRateIncreaseCriteria","description":"The criteria to initiate the increase in rate of rollout for a job."}},"type":"object","required":["baseRatePerMinute","incrementFactor","rateIncreaseCriteria"]},"aws-native:iot:JobTemplateFailureType":{"type":"string","enum":[{"name":"Failed","value":"FAILED"},{"name":"Rejected","value":"REJECTED"},{"name":"TimedOut","value":"TIMED_OUT"},{"name":"All","value":"ALL"}]},"aws-native:iot:JobTemplateJobRetryFailureType":{"type":"string","enum":[{"name":"Failed","value":"FAILED"},{"name":"TimedOut","value":"TIMED_OUT"},{"name":"All","value":"ALL"}]},"aws-native:iot:JobTemplateMaintenanceWindow":{"description":"Specifies a start time and duration for a scheduled Job.","properties":{"durationInMinutes":{"type":"integer","description":"Displays the duration of the next maintenance window."},"startTime":{"type":"string","description":"Displays the start time of the next maintenance window."}},"type":"object"},"aws-native:iot:JobTemplateRateIncreaseCriteria":{"properties":{"numberOfNotifiedThings":{"type":"integer","description":"The threshold for number of notified things that will initiate the increase in rate of rollout."},"numberOfSucceededThings":{"type":"integer","description":"The threshold for number of succeeded things that will initiate the increase in rate of rollout."}},"type":"object"},"aws-native:iot:JobTemplateRetryCriteria":{"description":"Specifies how many times a failure type should be retried.","properties":{"failureType":{"$ref":"#/types/aws-native:iot:JobTemplateJobRetryFailureType","description":"The type of job execution failures that can initiate a job retry."},"numberOfRetries":{"type":"integer","description":"The number of retries allowed for a failure type for the job."}},"type":"object"},"aws-native:iot:JobTemplateTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iot:LoggingDefaultLogLevel":{"description":"The log level to use. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.","type":"string","enum":[{"name":"Error","value":"ERROR"},{"name":"Warn","value":"WARN"},{"name":"Info","value":"INFO"},{"name":"Debug","value":"DEBUG"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:iot:LoggingEventConfiguration":{"description":"Configuration for event-based logging that specifies which event types to log and their logging settings. Used for account-level logging overrides.","properties":{"eventType":{"type":"string","description":"The type of event to log. These include event types like Connect, Publish, and Disconnect."},"logDestination":{"type":"string","description":"CloudWatch Log Group for event-based logging. Specifies where log events should be sent. The log destination for event-based logging overrides default Log Group for the specified event type and applies to all resources associated with that event."},"logLevel":{"$ref":"#/types/aws-native:iot:LoggingEventConfigurationLogLevel","description":"The logging level for the specified event type. Determines the verbosity of log messages generated for this event type."}},"type":"object","required":["eventType"]},"aws-native:iot:LoggingEventConfigurationLogLevel":{"description":"The logging level for the specified event type. Determines the verbosity of log messages generated for this event type.","type":"string","enum":[{"name":"Error","value":"ERROR"},{"name":"Warn","value":"WARN"},{"name":"Info","value":"INFO"},{"name":"Debug","value":"DEBUG"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:iot:MetricsExportConfigProperties":{"description":"A structure containing the mqtt topic for metrics export.","properties":{"mqttTopic":{"type":"string","description":"The topic for metrics export."},"roleArn":{"type":"string","description":"The ARN of the role that grants permission to publish to mqtt topic."}},"type":"object","required":["mqttTopic","roleArn"]},"aws-native:iot:MitigationActionActionParams":{"description":"The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).","properties":{"addThingsToThingGroupParams":{"$ref":"#/types/aws-native:iot:MitigationActionAddThingsToThingGroupParams","description":"Specifies the group to which you want to add the devices."},"enableIoTLoggingParams":{"$ref":"#/types/aws-native:iot:MitigationActionEnableIoTLoggingParams","description":"Specifies the logging level and the role with permissions for logging. You cannot specify a logging level of `DISABLED` ."},"publishFindingToSnsParams":{"$ref":"#/types/aws-native:iot:MitigationActionPublishFindingToSnsParams","description":"Specifies the topic to which the finding should be published."},"replaceDefaultPolicyVersionParams":{"$ref":"#/types/aws-native:iot:MitigationActionReplaceDefaultPolicyVersionParams","description":"Replaces the policy version with a default or blank policy. You specify the template name. Only a value of `BLANK_POLICY` is currently supported."},"updateCaCertificateParams":{"$ref":"#/types/aws-native:iot:MitigationActionUpdateCaCertificateParams","description":"Specifies the new state for the CA certificate. Only a value of `DEACTIVATE` is currently supported."},"updateDeviceCertificateParams":{"$ref":"#/types/aws-native:iot:MitigationActionUpdateDeviceCertificateParams","description":"Specifies the new state for a device certificate. Only a value of `DEACTIVATE` is currently supported."}},"type":"object"},"aws-native:iot:MitigationActionAddThingsToThingGroupParams":{"description":"Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.","properties":{"overrideDynamicGroups":{"type":"boolean","description":"Specifies if this mitigation action can move the things that triggered the mitigation action out of one or more dynamic thing groups."},"thingGroupNames":{"type":"array","items":{"type":"string"},"description":"The list of groups to which you want to add the things that triggered the mitigation action."}},"type":"object","required":["thingGroupNames"]},"aws-native:iot:MitigationActionEnableIoTLoggingParams":{"description":"Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.","properties":{"logLevel":{"$ref":"#/types/aws-native:iot:MitigationActionEnableIoTLoggingParamsLogLevel","description":" Specifies which types of information are logged."},"roleArnForLogging":{"type":"string","description":" The ARN of the IAM role used for logging."}},"type":"object","required":["logLevel","roleArnForLogging"]},"aws-native:iot:MitigationActionEnableIoTLoggingParamsLogLevel":{"description":" Specifies which types of information are logged.","type":"string","enum":[{"name":"Debug","value":"DEBUG"},{"name":"Info","value":"INFO"},{"name":"Error","value":"ERROR"},{"name":"Warn","value":"WARN"},{"name":"UnsetValue","value":"UNSET_VALUE"}]},"aws-native:iot:MitigationActionPublishFindingToSnsParams":{"description":"Parameters, to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.","properties":{"topicArn":{"type":"string","description":"The ARN of the topic to which you want to publish the findings."}},"type":"object","required":["topicArn"]},"aws-native:iot:MitigationActionReplaceDefaultPolicyVersionParams":{"description":"Parameters to define a mitigation action that adds a blank policy to restrict permissions.","properties":{"templateName":{"$ref":"#/types/aws-native:iot:MitigationActionReplaceDefaultPolicyVersionParamsTemplateName","description":"The name of the template to be applied. The only supported value is `BLANK_POLICY` ."}},"type":"object","required":["templateName"]},"aws-native:iot:MitigationActionReplaceDefaultPolicyVersionParamsTemplateName":{"description":"The name of the template to be applied. The only supported value is `BLANK_POLICY` .","type":"string","enum":[{"name":"BlankPolicy","value":"BLANK_POLICY"},{"name":"UnsetValue","value":"UNSET_VALUE"}]},"aws-native:iot:MitigationActionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iot:MitigationActionUpdateCaCertificateParams":{"description":"Parameters to define a mitigation action that changes the state of the CA certificate to inactive.","properties":{"action":{"$ref":"#/types/aws-native:iot:MitigationActionUpdateCaCertificateParamsAction","description":"The action that you want to apply to the CA certificate. The only supported value is `DEACTIVATE` ."}},"type":"object","required":["action"]},"aws-native:iot:MitigationActionUpdateCaCertificateParamsAction":{"description":"The action that you want to apply to the CA certificate. The only supported value is `DEACTIVATE` .","type":"string","enum":[{"name":"Deactivate","value":"DEACTIVATE"},{"name":"UnsetValue","value":"UNSET_VALUE"}]},"aws-native:iot:MitigationActionUpdateDeviceCertificateParams":{"description":"Parameters to define a mitigation action that changes the state of the device certificate to inactive.","properties":{"action":{"$ref":"#/types/aws-native:iot:MitigationActionUpdateDeviceCertificateParamsAction","description":"The action that you want to apply to the device certificate. The only supported value is `DEACTIVATE` ."}},"type":"object","required":["action"]},"aws-native:iot:MitigationActionUpdateDeviceCertificateParamsAction":{"description":"The action that you want to apply to the device certificate. The only supported value is `DEACTIVATE` .","type":"string","enum":[{"name":"Deactivate","value":"DEACTIVATE"},{"name":"UnsetValue","value":"UNSET_VALUE"}]},"aws-native:iot:PolicyTag":{"properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iot:PresignedUrlConfigProperties":{"description":"Configuration for pre-signed S3 URLs.","properties":{"expiresInSec":{"type":"integer","description":"How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document."},"roleArn":{"type":"string","description":"The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.\n\n\u003e For information about addressing the confused deputy problem, see [cross-service confused deputy prevention](https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html) in the *AWS IoT Core developer guide* ."}},"type":"object","required":["roleArn"]},"aws-native:iot:ProvisioningTemplateProvisioningHook":{"properties":{"payloadVersion":{"type":"string","description":"The payload that was sent to the target function. The valid payload is `\"2020-04-01\"` ."},"targetArn":{"type":"string","description":"The ARN of the target function."}},"type":"object"},"aws-native:iot:ProvisioningTemplateTag":{"properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iot:ProvisioningTemplateTemplateType":{"description":"The type of the provisioning template.","type":"string","enum":[{"name":"FleetProvisioning","value":"FLEET_PROVISIONING"},{"name":"Jitp","value":"JITP"}]},"aws-native:iot:ResourceSpecificLoggingLogLevel":{"description":"The log level for a specific target. Valid values are: ERROR, WARN, INFO, DEBUG, or DISABLED.","type":"string","enum":[{"name":"Error","value":"ERROR"},{"name":"Warn","value":"WARN"},{"name":"Info","value":"INFO"},{"name":"Debug","value":"DEBUG"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:iot:ResourceSpecificLoggingTargetType":{"description":"The target type. Value must be THING_GROUP, CLIENT_ID, SOURCE_IP, PRINCIPAL_ID, or EVENT_TYPE.","type":"string","enum":[{"name":"ThingGroup","value":"THING_GROUP"},{"name":"ClientId","value":"CLIENT_ID"},{"name":"SourceIp","value":"SOURCE_IP"},{"name":"PrincipalId","value":"PRINCIPAL_ID"},{"name":"EventType","value":"EVENT_TYPE"}]},"aws-native:iot:RoleAliasTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:iot:ScheduledAuditDayOfWeek":{"description":"The day of the week on which the scheduled audit takes place. Can be one of SUN, MON, TUE,WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.","type":"string","enum":[{"name":"Sun","value":"SUN"},{"name":"Mon","value":"MON"},{"name":"Tue","value":"TUE"},{"name":"Wed","value":"WED"},{"name":"Thu","value":"THU"},{"name":"Fri","value":"FRI"},{"name":"Sat","value":"SAT"},{"name":"UnsetValue","value":"UNSET_VALUE"}]},"aws-native:iot:ScheduledAuditFrequency":{"description":"How often the scheduled audit takes place. Can be one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY.","type":"string","enum":[{"name":"Daily","value":"DAILY"},{"name":"Weekly","value":"WEEKLY"},{"name":"Biweekly","value":"BIWEEKLY"},{"name":"Monthly","value":"MONTHLY"}]},"aws-native:iot:ScheduledAuditTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iot:SecurityProfileAlertTarget":{"description":"A structure containing the alert target ARN and the role ARN.","properties":{"alertTargetArn":{"type":"string","description":"The ARN of the notification target to which alerts are sent."},"roleArn":{"type":"string","description":"The ARN of the role that grants permission to send alerts to the notification target."}},"type":"object","required":["alertTargetArn","roleArn"]},"aws-native:iot:SecurityProfileBehavior":{"description":"A security profile behavior.","properties":{"criteria":{"$ref":"#/types/aws-native:iot:SecurityProfileBehaviorCriteria","description":"The criteria that determine if a device is behaving normally in regard to the `metric` .\n\n\u003e In the AWS IoT console, you can choose to be sent an alert through Amazon SNS when AWS IoT Device Defender detects that a device is behaving anomalously."},"exportMetric":{"type":"boolean","description":"Value indicates exporting metrics related to the behavior when it is true."},"metric":{"type":"string","description":"What is measured by the behavior."},"metricDimension":{"$ref":"#/types/aws-native:iot:SecurityProfileMetricDimension","description":"The dimension of the metric."},"name":{"type":"string","description":"The name for the behavior."},"suppressAlerts":{"type":"boolean","description":"Manage Detect alarm SNS notifications by setting behavior notification to on or suppressed. Detect will continue to performing device behavior evaluations. However, suppressed alarms wouldn't be forwarded for SNS notification."}},"type":"object","required":["name"]},"aws-native:iot:SecurityProfileBehaviorCriteria":{"description":"The criteria by which the behavior is determined to be normal.","properties":{"comparisonOperator":{"$ref":"#/types/aws-native:iot:SecurityProfileBehaviorCriteriaComparisonOperator","description":"The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold)."},"consecutiveDatapointsToAlarm":{"type":"integer","description":"If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1."},"consecutiveDatapointsToClear":{"type":"integer","description":"If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1."},"durationSeconds":{"type":"integer","description":"Use this to specify the time duration over which the behavior is evaluated."},"mlDetectionConfig":{"$ref":"#/types/aws-native:iot:SecurityProfileMachineLearningDetectionConfig","description":"The confidence level of the detection model."},"statisticalThreshold":{"$ref":"#/types/aws-native:iot:SecurityProfileStatisticalThreshold","description":"A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior."},"value":{"$ref":"#/types/aws-native:iot:SecurityProfileMetricValue","description":"The value to be compared with the `metric` ."}},"type":"object"},"aws-native:iot:SecurityProfileBehaviorCriteriaComparisonOperator":{"description":"The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).","type":"string","enum":[{"name":"LessThan","value":"less-than"},{"name":"LessThanEquals","value":"less-than-equals"},{"name":"GreaterThan","value":"greater-than"},{"name":"GreaterThanEquals","value":"greater-than-equals"},{"name":"InCidrSet","value":"in-cidr-set"},{"name":"NotInCidrSet","value":"not-in-cidr-set"},{"name":"InPortSet","value":"in-port-set"},{"name":"NotInPortSet","value":"not-in-port-set"},{"name":"InSet","value":"in-set"},{"name":"NotInSet","value":"not-in-set"}]},"aws-native:iot:SecurityProfileMachineLearningDetectionConfig":{"description":"The configuration of an ML Detect Security Profile.","properties":{"confidenceLevel":{"$ref":"#/types/aws-native:iot:SecurityProfileMachineLearningDetectionConfigConfidenceLevel","description":"The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High."}},"type":"object"},"aws-native:iot:SecurityProfileMachineLearningDetectionConfigConfidenceLevel":{"description":"The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.","type":"string","enum":[{"name":"Low","value":"LOW"},{"name":"Medium","value":"MEDIUM"},{"name":"High","value":"HIGH"}]},"aws-native:iot:SecurityProfileMetricDimension":{"description":"The dimension of a metric.","properties":{"dimensionName":{"type":"string","description":"A unique identifier for the dimension."},"operator":{"$ref":"#/types/aws-native:iot:SecurityProfileMetricDimensionOperator","description":"Defines how the dimensionValues of a dimension are interpreted."}},"type":"object","required":["dimensionName"]},"aws-native:iot:SecurityProfileMetricDimensionOperator":{"description":"Defines how the dimensionValues of a dimension are interpreted.","type":"string","enum":[{"name":"In","value":"IN"},{"name":"NotIn","value":"NOT_IN"}]},"aws-native:iot:SecurityProfileMetricToRetain":{"description":"The metric you want to retain. Dimensions are optional.","properties":{"exportMetric":{"type":"boolean","description":"The value indicates exporting metrics related to the `MetricToRetain` when it's true."},"metric":{"type":"string","description":"What is measured by the behavior."},"metricDimension":{"$ref":"#/types/aws-native:iot:SecurityProfileMetricDimension","description":"The dimension of the metric."}},"type":"object","required":["metric"]},"aws-native:iot:SecurityProfileMetricValue":{"description":"The value to be compared with the metric.","properties":{"cidrs":{"type":"array","items":{"type":"string"},"description":"If the ComparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric."},"count":{"type":"string","description":"If the ComparisonOperator calls for a numeric value, use this to specify that (integer) numeric value to be compared with the metric."},"number":{"type":"number","description":"The numeral value of a metric."},"numbers":{"type":"array","items":{"type":"number"},"description":"The numeral values of a metric."},"ports":{"type":"array","items":{"type":"integer"},"description":"If the ComparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric."},"strings":{"type":"array","items":{"type":"string"},"description":"The string values of a metric."}},"type":"object"},"aws-native:iot:SecurityProfileStatisticalThreshold":{"description":"A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.","properties":{"statistic":{"$ref":"#/types/aws-native:iot:SecurityProfileStatisticalThresholdStatistic","description":"The percentile which resolves to a threshold value by which compliance with a behavior is determined"}},"type":"object"},"aws-native:iot:SecurityProfileStatisticalThresholdStatistic":{"description":"The percentile which resolves to a threshold value by which compliance with a behavior is determined","type":"string","enum":[{"name":"Average","value":"Average"},{"name":"P0","value":"p0"},{"name":"P01","value":"p0.1"},{"name":"P001","value":"p0.01"},{"name":"P1","value":"p1"},{"name":"P10","value":"p10"},{"name":"P50","value":"p50"},{"name":"P90","value":"p90"},{"name":"P99","value":"p99"},{"name":"P999","value":"p99.9"},{"name":"P9999","value":"p99.99"},{"name":"P100","value":"p100"}]},"aws-native:iot:SecurityProfileTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iot:SoftwarePackageTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:iot:SoftwarePackageVersionPackageVersionArtifact":{"description":"The artifact location of the package version","properties":{"s3Location":{"$ref":"#/types/aws-native:iot:SoftwarePackageVersionS3Location"}},"type":"object","required":["s3Location"]},"aws-native:iot:SoftwarePackageVersionPackageVersionStatus":{"type":"string","enum":[{"name":"Draft","value":"DRAFT"},{"name":"Published","value":"PUBLISHED"},{"name":"Deprecated","value":"DEPRECATED"}]},"aws-native:iot:SoftwarePackageVersionS3Location":{"description":"The Amazon S3 location","properties":{"bucket":{"type":"string","description":"The S3 bucket"},"key":{"type":"string","description":"The S3 key"},"version":{"type":"string","description":"The S3 version"}},"type":"object","required":["bucket","key","version"]},"aws-native:iot:SoftwarePackageVersionSbom":{"description":"The sbom zip archive location of the package version","properties":{"s3Location":{"$ref":"#/types/aws-native:iot:SoftwarePackageVersionS3Location"}},"type":"object","required":["s3Location"]},"aws-native:iot:SoftwarePackageVersionSbomValidationStatus":{"description":"The validation status of the Sbom file","type":"string","enum":[{"name":"InProgress","value":"IN_PROGRESS"},{"name":"Failed","value":"FAILED"},{"name":"Succeeded","value":"SUCCEEDED"},{"name":"Empty","value":""}]},"aws-native:iot:SoftwarePackageVersionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:iot:ThingAttributePayload":{"properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"},"description":"A JSON string containing up to three key-value pair in JSON format. For example:\n\n`{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}`"}},"type":"object"},"aws-native:iot:ThingGroupAttributePayload":{"properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"},"description":"A JSON string containing up to three key-value pair in JSON format. For example:\n\n`{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}`"}},"type":"object"},"aws-native:iot:ThingGroupPropertiesProperties":{"description":"Thing group properties.","properties":{"attributePayload":{"$ref":"#/types/aws-native:iot:ThingGroupAttributePayload","description":"The thing group attributes in JSON format."},"thingGroupDescription":{"type":"string","description":"The thing group description."}},"type":"object"},"aws-native:iot:ThingGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"Tag key (1-128 chars). No 'aws:' prefix. Allows: [A-Za-z0-9 _.:/=+-]"},"value":{"type":"string","description":"Tag value (1-256 chars). No 'aws:' prefix. Allows: [A-Za-z0-9 _.:/=+-]"}},"type":"object","required":["key","value"]},"aws-native:iot:ThingTypePropagatingAttribute":{"properties":{"connectionAttribute":{"$ref":"#/types/aws-native:iot:ThingTypePropagatingAttributeConnectionAttribute","description":"The attribute associated with the connection details."},"thingAttribute":{"type":"string","description":"The thing attribute that is propagating for MQTT 5 message enrichment."},"userPropertyKey":{"type":"string","description":"The key of the MQTT 5 user property, which is a key-value pair."}},"type":"object","required":["userPropertyKey"]},"aws-native:iot:ThingTypePropagatingAttributeConnectionAttribute":{"description":"The attribute associated with the connection details.","type":"string","enum":[{"name":"IotClientId","value":"iot:ClientId"},{"name":"IotThingThingName","value":"iot:Thing.ThingName"}]},"aws-native:iot:ThingTypePropertiesProperties":{"description":"The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update `Mqtt5Configuration` .","properties":{"mqtt5Configuration":{"$ref":"#/types/aws-native:iot:ThingTypePropertiesPropertiesMqtt5ConfigurationProperties","description":"The configuration to add user-defined properties to enrich MQTT 5 messages."},"searchableAttributes":{"type":"array","items":{"type":"string"},"description":"A list of searchable thing attribute names."},"thingTypeDescription":{"type":"string","description":"The description of the thing type."}},"type":"object"},"aws-native:iot:ThingTypePropertiesPropertiesMqtt5ConfigurationProperties":{"description":"The configuration to add user-defined properties to enrich MQTT 5 messages.","properties":{"propagatingAttributes":{"type":"array","items":{"$ref":"#/types/aws-native:iot:ThingTypePropagatingAttribute"}}},"type":"object"},"aws-native:iot:ThingTypeTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"Tag key (1-128 chars). No 'aws:' prefix. Allows: [A-Za-z0-9 _.:/=+-]"},"value":{"type":"string","description":"Tag value (1-256 chars). No 'aws:' prefix. Allows: [A-Za-z0-9 _.:/=+-]"}},"type":"object","required":["key","value"]},"aws-native:iot:TimeoutConfigProperties":{"description":"Specifies the amount of time each device has to finish its execution of the job.","properties":{"inProgressTimeoutInMinutes":{"type":"integer","description":"Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal `TIMED_OUT` status."}},"type":"object","required":["inProgressTimeoutInMinutes"]},"aws-native:iot:TopicRuleAction":{"properties":{"cloudwatchAlarm":{"$ref":"#/types/aws-native:iot:TopicRuleCloudwatchAlarmAction","description":"Change the state of a CloudWatch alarm."},"cloudwatchLogs":{"$ref":"#/types/aws-native:iot:TopicRuleCloudwatchLogsAction","description":"Sends data to CloudWatch."},"cloudwatchMetric":{"$ref":"#/types/aws-native:iot:TopicRuleCloudwatchMetricAction","description":"Capture a CloudWatch metric."},"dynamoDBv2":{"$ref":"#/types/aws-native:iot:TopicRuleDynamoDBv2Action","description":"Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column."},"dynamoDb":{"$ref":"#/types/aws-native:iot:TopicRuleDynamoDbAction","description":"Write to a DynamoDB table."},"elasticsearch":{"$ref":"#/types/aws-native:iot:TopicRuleElasticsearchAction","description":"Write data to an Amazon OpenSearch Service domain.\n\n\u003e The `Elasticsearch` action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the `OpenSearch` rule action instead. For more information, see [OpenSearchAction](https://docs.aws.amazon.com//iot/latest/apireference/API_OpenSearchAction.html) ."},"firehose":{"$ref":"#/types/aws-native:iot:TopicRuleFirehoseAction","description":"Write to an Amazon Kinesis Firehose stream."},"http":{"$ref":"#/types/aws-native:iot:TopicRuleHttpAction","description":"Send data to an HTTPS endpoint."},"iotAnalytics":{"$ref":"#/types/aws-native:iot:TopicRuleIotAnalyticsAction","description":"Sends message data to an AWS IoT Analytics channel."},"iotEvents":{"$ref":"#/types/aws-native:iot:TopicRuleIotEventsAction","description":"Sends an input to an AWS IoT Events detector."},"iotSiteWise":{"$ref":"#/types/aws-native:iot:TopicRuleIotSiteWiseAction","description":"Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties."},"kafka":{"$ref":"#/types/aws-native:iot:TopicRuleKafkaAction","description":"Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster."},"kinesis":{"$ref":"#/types/aws-native:iot:TopicRuleKinesisAction","description":"Write data to an Amazon Kinesis stream."},"lambda":{"$ref":"#/types/aws-native:iot:TopicRuleLambdaAction","description":"Invoke a Lambda function."},"location":{"$ref":"#/types/aws-native:iot:TopicRuleLocationAction","description":"Sends device location data to [Amazon Location Service](https://docs.aws.amazon.com//location/latest/developerguide/welcome.html) ."},"openSearch":{"$ref":"#/types/aws-native:iot:TopicRuleOpenSearchAction","description":"Write data to an Amazon OpenSearch Service domain."},"republish":{"$ref":"#/types/aws-native:iot:TopicRuleRepublishAction","description":"Publish to another MQTT topic."},"s3":{"$ref":"#/types/aws-native:iot:TopicRuleS3Action","description":"Write to an Amazon S3 bucket."},"sns":{"$ref":"#/types/aws-native:iot:TopicRuleSnsAction","description":"Publish to an Amazon SNS topic."},"sqs":{"$ref":"#/types/aws-native:iot:TopicRuleSqsAction","description":"Publish to an Amazon SQS queue."},"stepFunctions":{"$ref":"#/types/aws-native:iot:TopicRuleStepFunctionsAction","description":"Starts execution of a Step Functions state machine."},"timestream":{"$ref":"#/types/aws-native:iot:TopicRuleTimestreamAction","description":"Writes attributes from an MQTT message."}},"type":"object"},"aws-native:iot:TopicRuleAssetPropertyTimestamp":{"properties":{"offsetInNanos":{"type":"string","description":"Optional. A string that contains the nanosecond time offset. Accepts substitution templates."},"timeInSeconds":{"type":"string","description":"A string that contains the time in seconds since epoch. Accepts substitution templates."}},"type":"object","required":["timeInSeconds"]},"aws-native:iot:TopicRuleAssetPropertyValue":{"properties":{"quality":{"type":"string","description":"Optional. A string that describes the quality of the value. Accepts substitution templates. Must be `GOOD` , `BAD` , or `UNCERTAIN` ."},"timestamp":{"$ref":"#/types/aws-native:iot:TopicRuleAssetPropertyTimestamp","description":"The asset property value timestamp."},"value":{"$ref":"#/types/aws-native:iot:TopicRuleAssetPropertyVariant","description":"The value of the asset property."}},"type":"object","required":["timestamp","value"]},"aws-native:iot:TopicRuleAssetPropertyVariant":{"properties":{"booleanValue":{"type":"string","description":"Optional. A string that contains the boolean value ( `true` or `false` ) of the value entry. Accepts substitution templates."},"doubleValue":{"type":"string","description":"Optional. A string that contains the double value of the value entry. Accepts substitution templates."},"integerValue":{"type":"string","description":"Optional. A string that contains the integer value of the value entry. Accepts substitution templates."},"stringValue":{"type":"string","description":"Optional. The string value of the value entry. Accepts substitution templates."}},"type":"object"},"aws-native:iot:TopicRuleBatchConfig":{"properties":{"maxBatchOpenMs":{"type":"integer"},"maxBatchSize":{"type":"integer"},"maxBatchSizeBytes":{"type":"integer"}},"type":"object"},"aws-native:iot:TopicRuleCannedAccessControlList":{"type":"string","enum":[{"name":"Private","value":"private"},{"name":"PublicRead","value":"public-read"},{"name":"PublicReadWrite","value":"public-read-write"},{"name":"AwsExecRead","value":"aws-exec-read"},{"name":"AuthenticatedRead","value":"authenticated-read"},{"name":"BucketOwnerRead","value":"bucket-owner-read"},{"name":"BucketOwnerFullControl","value":"bucket-owner-full-control"},{"name":"LogDeliveryWrite","value":"log-delivery-write"}]},"aws-native:iot:TopicRuleCloudwatchAlarmAction":{"properties":{"alarmName":{"type":"string","description":"The CloudWatch alarm name."},"roleArn":{"type":"string","description":"The IAM role that allows access to the CloudWatch alarm."},"stateReason":{"type":"string","description":"The reason for the alarm change."},"stateValue":{"type":"string","description":"The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA."}},"type":"object","required":["alarmName","roleArn","stateReason","stateValue"]},"aws-native:iot:TopicRuleCloudwatchLogsAction":{"properties":{"batchMode":{"type":"boolean","description":"Indicates whether batches of log records will be extracted and uploaded into CloudWatch."},"logGroupName":{"type":"string","description":"The CloudWatch log name."},"roleArn":{"type":"string","description":"The IAM role that allows access to the CloudWatch log."}},"type":"object","required":["logGroupName","roleArn"]},"aws-native:iot:TopicRuleCloudwatchMetricAction":{"properties":{"metricName":{"type":"string","description":"The CloudWatch metric name."},"metricNamespace":{"type":"string","description":"The CloudWatch metric namespace name."},"metricTimestamp":{"type":"string","description":"An optional [Unix timestamp](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp) ."},"metricUnit":{"type":"string","description":"The [metric unit](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit) supported by CloudWatch."},"metricValue":{"type":"string","description":"The CloudWatch metric value."},"roleArn":{"type":"string","description":"The IAM role that allows access to the CloudWatch metric."}},"type":"object","required":["metricName","metricNamespace","metricUnit","metricValue","roleArn"]},"aws-native:iot:TopicRuleDestinationHttpUrlDestinationSummary":{"properties":{"confirmationUrl":{"type":"string","description":"The URL used to confirm the HTTP topic rule destination URL."}},"type":"object"},"aws-native:iot:TopicRuleDestinationStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"InProgress","value":"IN_PROGRESS"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:iot:TopicRuleDestinationVpcDestinationProperties":{"properties":{"roleArn":{"type":"string","description":"The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"The security groups of the VPC destination."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The subnet IDs of the VPC destination."},"vpcId":{"type":"string","description":"The ID of the VPC."}},"type":"object"},"aws-native:iot:TopicRuleDynamoDBv2Action":{"properties":{"putItem":{"$ref":"#/types/aws-native:iot:TopicRulePutItemInput","description":"Specifies the DynamoDB table to which the message data will be written. For example:\n\n`{ \"dynamoDBv2\": { \"roleArn\": \"aws:iam:12341251:my-role\" \"putItem\": { \"tableName\": \"my-table\" } } }`\n\nEach attribute in the message payload will be written to a separate column in the DynamoDB database."},"roleArn":{"type":"string","description":"The ARN of the IAM role that grants access to the DynamoDB table."}},"type":"object"},"aws-native:iot:TopicRuleDynamoDbAction":{"properties":{"hashKeyField":{"type":"string","description":"The hash key name."},"hashKeyType":{"type":"string","description":"The hash key type. Valid values are \"STRING\" or \"NUMBER\""},"hashKeyValue":{"type":"string","description":"The hash key value."},"payloadField":{"type":"string","description":"The action payload. This name can be customized."},"rangeKeyField":{"type":"string","description":"The range key name."},"rangeKeyType":{"type":"string","description":"The range key type. Valid values are \"STRING\" or \"NUMBER\""},"rangeKeyValue":{"type":"string","description":"The range key value."},"roleArn":{"type":"string","description":"The ARN of the IAM role that grants access to the DynamoDB table."},"tableName":{"type":"string","description":"The name of the DynamoDB table."}},"type":"object","required":["hashKeyField","hashKeyValue","roleArn","tableName"]},"aws-native:iot:TopicRuleElasticsearchAction":{"properties":{"endpoint":{"type":"string","description":"The endpoint of your OpenSearch domain."},"id":{"type":"string","description":"The unique identifier for the document you are storing."},"index":{"type":"string","description":"The index where you want to store your data."},"roleArn":{"type":"string","description":"The IAM role ARN that has access to OpenSearch."},"type":{"type":"string","description":"The type of document you are storing."}},"type":"object","required":["endpoint","id","index","roleArn","type"]},"aws-native:iot:TopicRuleFirehoseAction":{"properties":{"batchMode":{"type":"boolean","description":"Whether to deliver the Kinesis Data Firehose stream as a batch by using [`PutRecordBatch`](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) . The default value is `false` .\n\nWhen `batchMode` is `true` and the rule's SQL statement evaluates to an Array, each Array element forms one record in the [`PutRecordBatch`](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) request. The resulting array can't have more than 500 records."},"deliveryStreamName":{"type":"string","description":"The delivery stream name."},"roleArn":{"type":"string","description":"The IAM role that grants access to the Amazon Kinesis Firehose stream."},"separator":{"type":"string","description":"A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma)."}},"type":"object","required":["deliveryStreamName","roleArn"]},"aws-native:iot:TopicRuleHttpAction":{"properties":{"auth":{"$ref":"#/types/aws-native:iot:TopicRuleHttpAuthorization","description":"The authentication method to use when sending data to an HTTPS endpoint."},"batchConfig":{"$ref":"#/types/aws-native:iot:TopicRuleBatchConfig"},"confirmationUrl":{"type":"string","description":"The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL."},"enableBatching":{"type":"boolean"},"headers":{"type":"array","items":{"$ref":"#/types/aws-native:iot:TopicRuleHttpActionHeader"},"description":"The HTTP headers to send with the message data."},"url":{"type":"string","description":"The endpoint URL. If substitution templates are used in the URL, you must also specify a `confirmationUrl` . If this is a new destination, a new `TopicRuleDestination` is created if possible."}},"type":"object","required":["url"]},"aws-native:iot:TopicRuleHttpActionHeader":{"properties":{"key":{"type":"string","description":"The HTTP header key."},"value":{"type":"string","description":"The HTTP header value. Substitution templates are supported."}},"type":"object","required":["key","value"]},"aws-native:iot:TopicRuleHttpAuthorization":{"properties":{"sigv4":{"$ref":"#/types/aws-native:iot:TopicRuleSigV4Authorization","description":"Use Sig V4 authorization. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) ."}},"type":"object"},"aws-native:iot:TopicRuleIotAnalyticsAction":{"properties":{"batchMode":{"type":"boolean","description":"Whether to process the action as a batch. The default value is `false` .\n\nWhen `batchMode` is `true` and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by [`BatchPutMessage`](https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html) The resulting array can't have more than 100 messages."},"channelName":{"type":"string","description":"The name of the IoT Analytics channel to which message data will be sent."},"roleArn":{"type":"string","description":"The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage)."}},"type":"object","required":["channelName","roleArn"]},"aws-native:iot:TopicRuleIotEventsAction":{"properties":{"batchMode":{"type":"boolean","description":"Whether to process the event actions as a batch. The default value is `false` .\n\nWhen `batchMode` is `true` , you can't specify a `messageId` .\n\nWhen `batchMode` is `true` and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by calling [`BatchPutMessage`](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html) . The resulting array can't have more than 10 messages."},"inputName":{"type":"string","description":"The name of the AWS IoT Events input."},"messageId":{"type":"string","description":"The ID of the message. The default `messageId` is a new UUID value.\n\nWhen `batchMode` is `true` , you can't specify a `messageId` --a new UUID value will be assigned.\n\nAssign a value to this property to ensure that only one input (message) with a given `messageId` will be processed by an AWS IoT Events detector."},"roleArn":{"type":"string","description":"The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. (\"Action\":\"iotevents:BatchPutMessage\")."}},"type":"object","required":["inputName","roleArn"]},"aws-native:iot:TopicRuleIotSiteWiseAction":{"properties":{"putAssetPropertyValueEntries":{"type":"array","items":{"$ref":"#/types/aws-native:iot:TopicRulePutAssetPropertyValueEntry"},"description":"A list of asset property value entries."},"roleArn":{"type":"string","description":"The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise. ( `\"Action\": \"iotsitewise:BatchPutAssetPropertyValue\"` ). The trust policy can restrict access to specific asset hierarchy paths."}},"type":"object","required":["putAssetPropertyValueEntries","roleArn"]},"aws-native:iot:TopicRuleKafkaAction":{"properties":{"clientProperties":{"type":"object","additionalProperties":{"type":"string"},"description":"Properties of the Apache Kafka producer client."},"destinationArn":{"type":"string","description":"The ARN of Kafka action's VPC `TopicRuleDestination` ."},"headers":{"type":"array","items":{"$ref":"#/types/aws-native:iot:TopicRuleKafkaActionHeader"},"description":"The list of Kafka headers that you specify."},"key":{"type":"string","description":"The Kafka message key."},"partition":{"type":"string","description":"The Kafka message partition."},"topic":{"type":"string","description":"The Kafka topic for messages to be sent to the Kafka broker."}},"type":"object","required":["clientProperties","destinationArn","topic"]},"aws-native:iot:TopicRuleKafkaActionHeader":{"properties":{"key":{"type":"string","description":"The key of the Kafka header."},"value":{"type":"string","description":"The value of the Kafka header."}},"type":"object","required":["key","value"]},"aws-native:iot:TopicRuleKinesisAction":{"properties":{"partitionKey":{"type":"string","description":"The partition key."},"roleArn":{"type":"string","description":"The ARN of the IAM role that grants access to the Amazon Kinesis stream."},"streamName":{"type":"string","description":"The name of the Amazon Kinesis stream."}},"type":"object","required":["roleArn","streamName"]},"aws-native:iot:TopicRuleLambdaAction":{"properties":{"functionArn":{"type":"string","description":"The ARN of the Lambda function."}},"type":"object"},"aws-native:iot:TopicRuleLocationAction":{"properties":{"deviceId":{"type":"string","description":"The unique ID of the device providing the location data."},"latitude":{"type":"string","description":"A string that evaluates to a double value that represents the latitude of the device's location."},"longitude":{"type":"string","description":"A string that evaluates to a double value that represents the longitude of the device's location."},"roleArn":{"type":"string","description":"The IAM role that grants permission to write to the Amazon Location resource."},"timestamp":{"$ref":"#/types/aws-native:iot:TopicRuleTimestamp","description":"The time that the location data was sampled. The default value is the time the MQTT message was processed."},"trackerName":{"type":"string","description":"The name of the tracker resource in Amazon Location in which the location is updated."}},"type":"object","required":["deviceId","latitude","longitude","roleArn","trackerName"]},"aws-native:iot:TopicRuleOpenSearchAction":{"properties":{"endpoint":{"type":"string","description":"The endpoint of your OpenSearch domain."},"id":{"type":"string","description":"The unique identifier for the document you are storing."},"index":{"type":"string","description":"The OpenSearch index where you want to store your data."},"roleArn":{"type":"string","description":"The IAM role ARN that has access to OpenSearch."},"type":{"type":"string","description":"The type of document you are storing."}},"type":"object","required":["endpoint","id","index","roleArn","type"]},"aws-native:iot:TopicRulePayload":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:iot:TopicRuleAction"},"description":"The actions associated with the rule."},"awsIotSqlVersion":{"type":"string","description":"The version of the SQL rules engine to use when evaluating the rule.\n\nThe default value is 2015-10-08."},"description":{"type":"string","description":"The description of the rule."},"errorAction":{"$ref":"#/types/aws-native:iot:TopicRuleAction","description":"The action to take when an error occurs."},"ruleDisabled":{"type":"boolean","description":"Specifies whether the rule is disabled."},"sql":{"type":"string","description":"The SQL statement used to query the topic. For more information, see [AWS IoT SQL Reference](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html) in the *AWS IoT Developer Guide* ."}},"type":"object","required":["actions","sql"]},"aws-native:iot:TopicRulePutAssetPropertyValueEntry":{"properties":{"assetId":{"type":"string","description":"The ID of the AWS IoT SiteWise asset. You must specify either a `propertyAlias` or both an `aliasId` and a `propertyId` . Accepts substitution templates."},"entryId":{"type":"string","description":"Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID."},"propertyAlias":{"type":"string","description":"The name of the property alias associated with your asset property. You must specify either a `propertyAlias` or both an `aliasId` and a `propertyId` . Accepts substitution templates."},"propertyId":{"type":"string","description":"The ID of the asset's property. You must specify either a `propertyAlias` or both an `aliasId` and a `propertyId` . Accepts substitution templates."},"propertyValues":{"type":"array","items":{"$ref":"#/types/aws-native:iot:TopicRuleAssetPropertyValue"},"description":"A list of property values to insert that each contain timestamp, quality, and value (TQV) information."}},"type":"object","required":["propertyValues"]},"aws-native:iot:TopicRulePutItemInput":{"properties":{"tableName":{"type":"string","description":"The table where the message data will be written."}},"type":"object","required":["tableName"]},"aws-native:iot:TopicRuleRepublishAction":{"properties":{"headers":{"$ref":"#/types/aws-native:iot:TopicRuleRepublishActionHeaders","description":"MQTT Version 5.0 headers information. For more information, see [MQTT](https://docs.aws.amazon.com//iot/latest/developerguide/mqtt.html) in the IoT Core Developer Guide."},"qos":{"type":"integer","description":"The Quality of Service (QoS) level to use when republishing messages. The default value is 0."},"roleArn":{"type":"string","description":"The ARN of the IAM role that grants access."},"topic":{"type":"string","description":"The name of the MQTT topic."}},"type":"object","required":["roleArn","topic"]},"aws-native:iot:TopicRuleRepublishActionHeaders":{"properties":{"contentType":{"type":"string","description":"A UTF-8 encoded string that describes the content of the publishing message.\n\nFor more information, see [Content Type](https://docs.aws.amazon.com/https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118) in the MQTT Version 5.0 specification.\n\nSupports [substitution templates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html) ."},"correlationData":{"type":"string","description":"The base64-encoded binary data used by the sender of the request message to identify which request the response message is for.\n\nFor more information, see [Correlation Data](https://docs.aws.amazon.com/https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115) in the MQTT Version 5.0 specification.\n\nSupports [substitution templates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html) .\n\n\u003e This binary data must be base64-encoded."},"messageExpiry":{"type":"string","description":"A user-defined integer value that represents the message expiry interval at the broker. If the messages haven't been sent to the subscribers within that interval, the message expires and is removed. The value of `messageExpiry` represents the number of seconds before it expires. For more information about the limits of `messageExpiry` , see [Message broker and protocol limits and quotas](https://docs.aws.amazon.com//general/latest/gr/iot-core.html#limits_iot) in the IoT Core Reference Guide.\n\nSupports [substitution templates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html) ."},"payloadFormatIndicator":{"type":"string","description":"An `Enum` string value that indicates whether the payload is formatted as UTF-8.\n\nValid values are `UNSPECIFIED_BYTES` and `UTF8_DATA` .\n\nFor more information, see [Payload Format Indicator](https://docs.aws.amazon.com/https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111) from the MQTT Version 5.0 specification.\n\nSupports [substitution templates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html) ."},"responseTopic":{"type":"string","description":"A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic to which the receiver should publish as part of the request-response flow. The topic must not contain wildcard characters.\n\nFor more information, see [Response Topic](https://docs.aws.amazon.com/https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901114) in the MQTT Version 5.0 specification.\n\nSupports [substitution templates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html) ."},"userProperties":{"type":"array","items":{"$ref":"#/types/aws-native:iot:TopicRuleUserProperty"},"description":"An array of key-value pairs that you define in the MQTT5 header."}},"type":"object"},"aws-native:iot:TopicRuleS3Action":{"properties":{"bucketName":{"type":"string","description":"The Amazon S3 bucket."},"cannedAcl":{"$ref":"#/types/aws-native:iot:TopicRuleCannedAccessControlList","description":"The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see [S3 canned ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) ."},"key":{"type":"string","description":"The object key. For more information, see [Actions, resources, and condition keys for Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html) ."},"roleArn":{"type":"string","description":"The ARN of the IAM role that grants access."}},"type":"object","required":["bucketName","key","roleArn"]},"aws-native:iot:TopicRuleSigV4Authorization":{"properties":{"roleArn":{"type":"string","description":"The ARN of the signing role."},"serviceName":{"type":"string","description":"The service name to use while signing with Sig V4."},"signingRegion":{"type":"string","description":"The signing region."}},"type":"object","required":["roleArn","serviceName","signingRegion"]},"aws-native:iot:TopicRuleSnsAction":{"properties":{"messageFormat":{"type":"string","description":"(Optional) The message format of the message to publish. Accepted values are \"JSON\" and \"RAW\". The default value of the attribute is \"RAW\". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. For more information, see [Amazon SNS Message and JSON Formats](https://docs.aws.amazon.com/sns/latest/dg/json-formats.html) in the *Amazon Simple Notification Service Developer Guide* ."},"roleArn":{"type":"string","description":"The ARN of the IAM role that grants access."},"targetArn":{"type":"string","description":"The ARN of the SNS topic."}},"type":"object","required":["roleArn","targetArn"]},"aws-native:iot:TopicRuleSqsAction":{"properties":{"queueUrl":{"type":"string","description":"The URL of the Amazon SQS queue."},"roleArn":{"type":"string","description":"The ARN of the IAM role that grants access."},"useBase64":{"type":"boolean","description":"Specifies whether to use Base64 encoding."}},"type":"object","required":["queueUrl","roleArn"]},"aws-native:iot:TopicRuleStepFunctionsAction":{"properties":{"executionNamePrefix":{"type":"string","description":"(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided."},"roleArn":{"type":"string","description":"The ARN of the role that grants IoT permission to start execution of a state machine (\"Action\":\"states:StartExecution\")."},"stateMachineName":{"type":"string","description":"The name of the Step Functions state machine whose execution will be started."}},"type":"object","required":["roleArn","stateMachineName"]},"aws-native:iot:TopicRuleTag":{"properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iot:TopicRuleTimestamp":{"properties":{"unit":{"type":"string","description":"The precision of the timestamp value that results from the expression described in `value` ."},"value":{"type":"string","description":"An expression that returns a long epoch time value."}},"type":"object","required":["value"]},"aws-native:iot:TopicRuleTimestreamAction":{"properties":{"databaseName":{"type":"string","description":"The name of an Amazon Timestream database that has the table to write records into."},"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:iot:TopicRuleTimestreamDimension"},"description":"Metadata attributes of the time series that are written in each measure record."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table."},"tableName":{"type":"string","description":"The table where the message data will be written."},"timestamp":{"$ref":"#/types/aws-native:iot:TopicRuleTimestreamTimestamp","description":"The value to use for the entry's timestamp. If blank, the time that the entry was processed is used."}},"type":"object","required":["databaseName","dimensions","roleArn","tableName"]},"aws-native:iot:TopicRuleTimestreamDimension":{"properties":{"name":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["name","value"]},"aws-native:iot:TopicRuleTimestreamTimestamp":{"properties":{"unit":{"type":"string","description":"The precision of the timestamp value that results from the expression described in `value` ."},"value":{"type":"string","description":"An expression that returns a long epoch time value."}},"type":"object","required":["unit","value"]},"aws-native:iot:TopicRuleUserProperty":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:iotanalytics:ChannelCustomerManagedS3":{"properties":{"bucket":{"type":"string","description":"The name of the S3 bucket in which channel data is stored."},"keyPrefix":{"type":"string","description":"(Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/)."},"roleArn":{"type":"string","description":"The ARN of the role that grants ITA permission to interact with your Amazon S3 resources."}},"type":"object","required":["bucket","roleArn"]},"aws-native:iotanalytics:ChannelRetentionPeriod":{"properties":{"numberOfDays":{"type":"integer","description":"The number of days that message data is kept. The `unlimited` parameter must be false."},"unlimited":{"type":"boolean","description":"If true, message data is kept indefinitely."}},"type":"object"},"aws-native:iotanalytics:ChannelServiceManagedS3":{"type":"object"},"aws-native:iotanalytics:ChannelStorage":{"properties":{"customerManagedS3":{"$ref":"#/types/aws-native:iotanalytics:ChannelCustomerManagedS3","description":"Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the `retentionPeriod` parameter is ignored. You can't change the choice of S3 storage after the data store is created."},"serviceManagedS3":{"$ref":"#/types/aws-native:iotanalytics:ChannelServiceManagedS3","description":"Used to store channel data in an S3 bucket managed by ITA . You can't change the choice of S3 storage after the data store is created."}},"type":"object"},"aws-native:iotanalytics:ChannelTag":{"properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iotanalytics:DatasetAction":{"properties":{"actionName":{"type":"string","description":"The name of the data set action by which data set contents are automatically created."},"containerAction":{"$ref":"#/types/aws-native:iotanalytics:DatasetContainerAction","description":"Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries."},"queryAction":{"$ref":"#/types/aws-native:iotanalytics:DatasetQueryAction","description":"An \"SqlQueryDatasetAction\" object that uses an SQL query to automatically create data set contents."}},"type":"object","required":["actionName"]},"aws-native:iotanalytics:DatasetContainerAction":{"properties":{"executionRoleArn":{"type":"string","description":"The ARN of the role which gives permission to the system to access needed resources in order to run the \"containerAction\". This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application."},"image":{"type":"string","description":"The ARN of the Docker container stored in your account. The Docker container contains an application and needed support libraries and is used to generate data set contents."},"resourceConfiguration":{"$ref":"#/types/aws-native:iotanalytics:DatasetResourceConfiguration","description":"Configuration of the resource which executes the \"containerAction\"."},"variables":{"type":"array","items":{"$ref":"#/types/aws-native:iotanalytics:DatasetVariable"},"description":"The values of variables used within the context of the execution of the containerized application (basically, parameters passed to the application). Each variable must have a name and a value given by one of \"stringValue\", \"datasetContentVersionValue\", or \"outputFileUriValue\"."}},"type":"object","required":["executionRoleArn","image","resourceConfiguration"]},"aws-native:iotanalytics:DatasetContentDeliveryRule":{"properties":{"destination":{"$ref":"#/types/aws-native:iotanalytics:DatasetContentDeliveryRuleDestination","description":"The destination to which dataset contents are delivered."},"entryName":{"type":"string","description":"The name of the dataset content delivery rules entry."}},"type":"object","required":["destination"]},"aws-native:iotanalytics:DatasetContentDeliveryRuleDestination":{"properties":{"iotEventsDestinationConfiguration":{"$ref":"#/types/aws-native:iotanalytics:DatasetIotEventsDestinationConfiguration","description":"Configuration information for delivery of dataset contents to AWS IoT Events ."},"s3DestinationConfiguration":{"$ref":"#/types/aws-native:iotanalytics:DatasetS3DestinationConfiguration","description":"Configuration information for delivery of dataset contents to Amazon S3."}},"type":"object"},"aws-native:iotanalytics:DatasetContentVersionValue":{"properties":{"datasetName":{"type":"string","description":"The name of the dataset whose latest contents are used as input to the notebook or application."}},"type":"object","required":["datasetName"]},"aws-native:iotanalytics:DatasetDeltaTime":{"properties":{"offsetSeconds":{"type":"integer","description":"The number of seconds of estimated in-flight lag time of message data. When you create dataset contents using message data from a specified timeframe, some message data might still be in flight when processing begins, and so do not arrive in time to be processed. Use this field to make allowances for the in flight time of your message data, so that data not processed from a previous timeframe is included with the next timeframe. Otherwise, missed message data would be excluded from processing during the next timeframe too, because its timestamp places it within the previous timeframe."},"timeExpression":{"type":"string","description":"An expression by which the time of the message data might be determined. This can be the name of a timestamp field or a SQL expression that is used to derive the time the message data was generated."}},"type":"object","required":["offsetSeconds","timeExpression"]},"aws-native:iotanalytics:DatasetDeltaTimeSessionWindowConfiguration":{"properties":{"timeoutInMinutes":{"type":"integer","description":"A time interval. You can use `timeoutInMinutes` so that ITA can batch up late data notifications that have been generated since the last execution. ITA sends one batch of notifications to Amazon CloudWatch Events at one time.\n\nFor more information about how to write a timestamp expression, see [Date and Time Functions and Operators](https://docs.aws.amazon.com/https://prestodb.io/docs/current/functions/datetime.html) , in the *Presto 0.172 Documentation* ."}},"type":"object","required":["timeoutInMinutes"]},"aws-native:iotanalytics:DatasetFilter":{"properties":{"deltaTime":{"$ref":"#/types/aws-native:iotanalytics:DatasetDeltaTime","description":"Used to limit data to that which has arrived since the last execution of the action."}},"type":"object"},"aws-native:iotanalytics:DatasetGlueConfiguration":{"properties":{"databaseName":{"type":"string","description":"The name of the database in your AWS Glue Data Catalog in which the table is located. An AWS Glue Data Catalog database contains metadata tables."},"tableName":{"type":"string","description":"The name of the table in your AWS Glue Data Catalog that is used to perform the ETL operations. An AWS Glue Data Catalog table contains partitioned data and descriptions of data sources and targets."}},"type":"object","required":["databaseName","tableName"]},"aws-native:iotanalytics:DatasetIotEventsDestinationConfiguration":{"properties":{"inputName":{"type":"string","description":"The name of the AWS IoT Events input to which dataset contents are delivered."},"roleArn":{"type":"string","description":"The ARN of the role that grants ITA permission to deliver dataset contents to an AWS IoT Events input."}},"type":"object","required":["inputName","roleArn"]},"aws-native:iotanalytics:DatasetLateDataRule":{"properties":{"ruleConfiguration":{"$ref":"#/types/aws-native:iotanalytics:DatasetLateDataRuleConfiguration","description":"The information needed to configure the late data rule."},"ruleName":{"type":"string","description":"The name of the late data rule."}},"type":"object","required":["ruleConfiguration"]},"aws-native:iotanalytics:DatasetLateDataRuleConfiguration":{"properties":{"deltaTimeSessionWindowConfiguration":{"$ref":"#/types/aws-native:iotanalytics:DatasetDeltaTimeSessionWindowConfiguration","description":"The information needed to configure a delta time session window."}},"type":"object"},"aws-native:iotanalytics:DatasetOutputFileUriValue":{"properties":{"fileName":{"type":"string","description":"The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket."}},"type":"object","required":["fileName"]},"aws-native:iotanalytics:DatasetQueryAction":{"properties":{"filters":{"type":"array","items":{"$ref":"#/types/aws-native:iotanalytics:DatasetFilter"},"description":"Pre-filters applied to message data."},"sqlQuery":{"type":"string","description":"An \"SqlQueryDatasetAction\" object that uses an SQL query to automatically create data set contents."}},"type":"object","required":["sqlQuery"]},"aws-native:iotanalytics:DatasetResourceConfiguration":{"properties":{"computeType":{"$ref":"#/types/aws-native:iotanalytics:DatasetResourceConfigurationComputeType","description":"The type of the compute resource used to execute the `containerAction` . Possible values are: `ACU_1` (vCPU=4, memory=16 GiB) or `ACU_2` (vCPU=8, memory=32 GiB)."},"volumeSizeInGb":{"type":"integer","description":"The size, in GB, of the persistent storage available to the resource instance used to execute the `containerAction` (min: 1, max: 50)."}},"type":"object","required":["computeType","volumeSizeInGb"]},"aws-native:iotanalytics:DatasetResourceConfigurationComputeType":{"description":"The type of the compute resource used to execute the `containerAction` . Possible values are: `ACU_1` (vCPU=4, memory=16 GiB) or `ACU_2` (vCPU=8, memory=32 GiB).","type":"string","enum":[{"name":"Acu1","value":"ACU_1"},{"name":"Acu2","value":"ACU_2"}]},"aws-native:iotanalytics:DatasetRetentionPeriod":{"properties":{"numberOfDays":{"type":"integer","description":"The number of days that message data is kept. The `unlimited` parameter must be false."},"unlimited":{"type":"boolean","description":"If true, message data is kept indefinitely."}},"type":"object"},"aws-native:iotanalytics:DatasetS3DestinationConfiguration":{"properties":{"bucket":{"type":"string","description":"The name of the S3 bucket to which dataset contents are delivered."},"glueConfiguration":{"$ref":"#/types/aws-native:iotanalytics:DatasetGlueConfiguration","description":"Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service."},"key":{"type":"string","description":"The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.\n\nYou can create a unique key with the following options:\n\n- Use `!{iotanalytics:scheduleTime}` to insert the time of a scheduled SQL query run.\n- Use `!{iotanalytics:versionId}` to insert a unique hash that identifies a dataset content.\n- Use `!{iotanalytics:creationTime}` to insert the creation time of a dataset content.\n\nThe following example creates a unique key for a CSV file: `dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv`\n\n\u003e If you don't use `!{iotanalytics:versionId}` to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same `scheduleTime` but different `versionId` s. This means that one dataset content overwrites the other."},"roleArn":{"type":"string","description":"The ARN of the role that grants ITA permission to interact with your Amazon S3 and AWS Glue resources."}},"type":"object","required":["bucket","key","roleArn"]},"aws-native:iotanalytics:DatasetSchedule":{"properties":{"scheduleExpression":{"type":"string","description":"The expression that defines when to trigger an update. For more information, see [Schedule Expressions for Rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) in the Amazon CloudWatch documentation."}},"type":"object","required":["scheduleExpression"]},"aws-native:iotanalytics:DatasetTag":{"properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iotanalytics:DatasetTrigger":{"properties":{"schedule":{"$ref":"#/types/aws-native:iotanalytics:DatasetSchedule","description":"The \"Schedule\" when the trigger is initiated."},"triggeringDataset":{"$ref":"#/types/aws-native:iotanalytics:DatasetTriggeringDataset","description":"Information about the data set whose content generation triggers the new data set content generation."}},"type":"object"},"aws-native:iotanalytics:DatasetTriggeringDataset":{"properties":{"datasetName":{"type":"string","description":"The name of the data set whose content generation triggers the new data set content generation."}},"type":"object","required":["datasetName"]},"aws-native:iotanalytics:DatasetVariable":{"properties":{"datasetContentVersionValue":{"$ref":"#/types/aws-native:iotanalytics:DatasetContentVersionValue","description":"The value of the variable as a structure that specifies a dataset content version."},"doubleValue":{"type":"number","description":"The value of the variable as a double (numeric)."},"outputFileUriValue":{"$ref":"#/types/aws-native:iotanalytics:DatasetOutputFileUriValue","description":"The value of the variable as a structure that specifies an output file URI."},"stringValue":{"type":"string","description":"The value of the variable as a string."},"variableName":{"type":"string","description":"The name of the variable."}},"type":"object","required":["variableName"]},"aws-native:iotanalytics:DatasetVersioningConfiguration":{"properties":{"maxVersions":{"type":"integer","description":"How many versions of dataset contents are kept. The `unlimited` parameter must be `false` ."},"unlimited":{"type":"boolean","description":"If true, unlimited versions of dataset contents are kept."}},"type":"object"},"aws-native:iotanalytics:DatastoreColumn":{"properties":{"name":{"type":"string","description":"The name of the column."},"type":{"type":"string","description":"The type of data. For more information about the supported data types, see [Common data types](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html) in the *AWS Glue Developer Guide* ."}},"type":"object","required":["name","type"]},"aws-native:iotanalytics:DatastoreCustomerManagedS3":{"properties":{"bucket":{"type":"string","description":"The name of the Amazon S3 bucket where your data is stored."},"keyPrefix":{"type":"string","description":"(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/)."},"roleArn":{"type":"string","description":"The ARN of the role that grants ITA permission to interact with your Amazon S3 resources."}},"type":"object","required":["bucket","roleArn"]},"aws-native:iotanalytics:DatastoreCustomerManagedS3Storage":{"properties":{"bucket":{"type":"string","description":"The name of the Amazon S3 bucket where your data is stored."},"keyPrefix":{"type":"string","description":"(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/)."}},"type":"object","required":["bucket"]},"aws-native:iotanalytics:DatastoreFileFormatConfiguration":{"properties":{"jsonConfiguration":{"$ref":"#/types/aws-native:iotanalytics:DatastoreJsonConfiguration","description":"Contains the configuration information of the JSON format."},"parquetConfiguration":{"$ref":"#/types/aws-native:iotanalytics:DatastoreParquetConfiguration","description":"Contains the configuration information of the Parquet format."}},"type":"object"},"aws-native:iotanalytics:DatastoreIotSiteWiseMultiLayerStorage":{"properties":{"customerManagedS3Storage":{"$ref":"#/types/aws-native:iotanalytics:DatastoreCustomerManagedS3Storage","description":"Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage."}},"type":"object"},"aws-native:iotanalytics:DatastoreJsonConfiguration":{"type":"object"},"aws-native:iotanalytics:DatastoreParquetConfiguration":{"properties":{"schemaDefinition":{"$ref":"#/types/aws-native:iotanalytics:DatastoreSchemaDefinition","description":"Information needed to define a schema."}},"type":"object"},"aws-native:iotanalytics:DatastorePartition":{"properties":{"partition":{"$ref":"#/types/aws-native:iotanalytics:Partition","description":"A partition dimension defined by an attribute."},"timestampPartition":{"$ref":"#/types/aws-native:iotanalytics:DatastoreTimestampPartition","description":"A partition dimension defined by a timestamp attribute."}},"type":"object"},"aws-native:iotanalytics:DatastorePartitions":{"properties":{"partitions":{"type":"array","items":{"$ref":"#/types/aws-native:iotanalytics:DatastorePartition"},"description":"A list of partition dimensions in a data store."}},"type":"object"},"aws-native:iotanalytics:DatastoreRetentionPeriod":{"properties":{"numberOfDays":{"type":"integer","description":"The number of days that message data is kept. The `unlimited` parameter must be false."},"unlimited":{"type":"boolean","description":"If true, message data is kept indefinitely."}},"type":"object"},"aws-native:iotanalytics:DatastoreSchemaDefinition":{"properties":{"columns":{"type":"array","items":{"$ref":"#/types/aws-native:iotanalytics:DatastoreColumn"},"description":"Specifies one or more columns that store your data.\n\nEach schema can have up to 100 columns. Each column can have up to 100 nested types."}},"type":"object"},"aws-native:iotanalytics:DatastoreServiceManagedS3":{"type":"object"},"aws-native:iotanalytics:DatastoreStorage":{"properties":{"customerManagedS3":{"$ref":"#/types/aws-native:iotanalytics:DatastoreCustomerManagedS3","description":"Use this to store data store data in an S3 bucket that you manage. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store."},"iotSiteWiseMultiLayerStorage":{"$ref":"#/types/aws-native:iotanalytics:DatastoreIotSiteWiseMultiLayerStorage","description":"Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created."},"serviceManagedS3":{"$ref":"#/types/aws-native:iotanalytics:DatastoreServiceManagedS3","description":"Use this to store data store data in an S3 bucket managed by the  service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store."}},"type":"object"},"aws-native:iotanalytics:DatastoreTag":{"properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iotanalytics:DatastoreTimestampPartition":{"properties":{"attributeName":{"type":"string","description":"The attribute name of the partition defined by a timestamp."},"timestampFormat":{"type":"string","description":"The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time)."}},"type":"object","required":["attributeName"]},"aws-native:iotanalytics:Partition":{"properties":{"attributeName":{"type":"string","description":"The name of the attribute that defines a partition dimension."}},"type":"object","required":["attributeName"]},"aws-native:iotanalytics:PipelineActivity":{"properties":{"addAttributes":{"$ref":"#/types/aws-native:iotanalytics:PipelineAddAttributes","description":"Adds other attributes based on existing attributes in the message."},"channel":{"$ref":"#/types/aws-native:iotanalytics:PipelineChannel","description":"Determines the source of the messages to be processed."},"datastore":{"$ref":"#/types/aws-native:iotanalytics:PipelineDatastore","description":"Specifies where to store the processed message data."},"deviceRegistryEnrich":{"$ref":"#/types/aws-native:iotanalytics:PipelineDeviceRegistryEnrich","description":"Adds data from the AWS IoT device registry to your message."},"deviceShadowEnrich":{"$ref":"#/types/aws-native:iotanalytics:PipelineDeviceShadowEnrich","description":"Adds information from the AWS IoT Device Shadows service to a message."},"filter":{"$ref":"#/types/aws-native:iotanalytics:PipelineFilter","description":"Filters a message based on its attributes."},"lambda":{"$ref":"#/types/aws-native:iotanalytics:PipelineLambda","description":"Runs a Lambda function to modify the message."},"math":{"$ref":"#/types/aws-native:iotanalytics:PipelineMath","description":"Computes an arithmetic expression using the message's attributes and adds it to the message."},"removeAttributes":{"$ref":"#/types/aws-native:iotanalytics:PipelineRemoveAttributes","description":"Removes attributes from a message."},"selectAttributes":{"$ref":"#/types/aws-native:iotanalytics:PipelineSelectAttributes","description":"Creates a new message using only the specified attributes from the original message."}},"type":"object"},"aws-native:iotanalytics:PipelineAddAttributes":{"properties":{"attributes":{"type":"object","additionalProperties":{"type":"string"},"description":"A list of 1-50 \"AttributeNameMapping\" objects that map an existing attribute to a new attribute.\n\n\u003e The existing attributes remain in the message, so if you want to remove the originals, use \"RemoveAttributeActivity\"."},"name":{"type":"string","description":"The name of the 'addAttributes' activity."},"next":{"type":"string","description":"The next activity in the pipeline."}},"type":"object","required":["attributes","name"]},"aws-native:iotanalytics:PipelineChannel":{"properties":{"channelName":{"type":"string","description":"The name of the channel from which the messages are processed."},"name":{"type":"string","description":"The name of the 'channel' activity."},"next":{"type":"string","description":"The next activity in the pipeline."}},"type":"object","required":["channelName","name"]},"aws-native:iotanalytics:PipelineDatastore":{"properties":{"datastoreName":{"type":"string","description":"The name of the data store where processed messages are stored."},"name":{"type":"string","description":"The name of the datastore activity."}},"type":"object","required":["datastoreName","name"]},"aws-native:iotanalytics:PipelineDeviceRegistryEnrich":{"properties":{"attribute":{"type":"string","description":"The name of the attribute that is added to the message."},"name":{"type":"string","description":"The name of the 'deviceRegistryEnrich' activity."},"next":{"type":"string","description":"The next activity in the pipeline."},"roleArn":{"type":"string","description":"The ARN of the role that allows access to the device's registry information."},"thingName":{"type":"string","description":"The name of the IoT device whose registry information is added to the message."}},"type":"object","required":["attribute","name","roleArn","thingName"]},"aws-native:iotanalytics:PipelineDeviceShadowEnrich":{"properties":{"attribute":{"type":"string","description":"The name of the attribute that is added to the message."},"name":{"type":"string","description":"The name of the 'deviceShadowEnrich' activity."},"next":{"type":"string","description":"The next activity in the pipeline."},"roleArn":{"type":"string","description":"The ARN of the role that allows access to the device's shadow."},"thingName":{"type":"string","description":"The name of the IoT device whose shadow information is added to the message."}},"type":"object","required":["attribute","name","roleArn","thingName"]},"aws-native:iotanalytics:PipelineFilter":{"properties":{"filter":{"type":"string","description":"An expression that looks like an SQL WHERE clause that must return a Boolean value."},"name":{"type":"string","description":"The name of the 'filter' activity."},"next":{"type":"string","description":"The next activity in the pipeline."}},"type":"object","required":["filter","name"]},"aws-native:iotanalytics:PipelineLambda":{"properties":{"batchSize":{"type":"integer","description":"The number of messages passed to the Lambda function for processing.\n\nThe AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions."},"lambdaName":{"type":"string","description":"The name of the Lambda function that is run on the message."},"name":{"type":"string","description":"The name of the 'lambda' activity."},"next":{"type":"string","description":"The next activity in the pipeline."}},"type":"object","required":["batchSize","lambdaName","name"]},"aws-native:iotanalytics:PipelineMath":{"properties":{"attribute":{"type":"string","description":"The name of the attribute that contains the result of the math operation."},"math":{"type":"string","description":"An expression that uses one or more existing attributes and must return an integer value."},"name":{"type":"string","description":"The name of the 'math' activity."},"next":{"type":"string","description":"The next activity in the pipeline."}},"type":"object","required":["attribute","math","name"]},"aws-native:iotanalytics:PipelineRemoveAttributes":{"properties":{"attributes":{"type":"array","items":{"type":"string"},"description":"A list of 1-50 attributes to remove from the message."},"name":{"type":"string","description":"The name of the 'removeAttributes' activity."},"next":{"type":"string","description":"The next activity in the pipeline."}},"type":"object","required":["attributes","name"]},"aws-native:iotanalytics:PipelineSelectAttributes":{"properties":{"attributes":{"type":"array","items":{"type":"string"},"description":"A list of the attributes to select from the message."},"name":{"type":"string","description":"The name of the 'selectAttributes' activity."},"next":{"type":"string","description":"The next activity in the pipeline."}},"type":"object","required":["attributes","name"]},"aws-native:iotanalytics:PipelineTag":{"properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iotcoredeviceadvisor:SuiteDefinitionConfigurationProperties":{"description":"Gets the suite definition configuration.","properties":{"devicePermissionRoleArn":{"type":"string","description":"Gets the device permission ARN. This is a required parameter."},"devices":{"type":"array","items":{"$ref":"#/types/aws-native:iotcoredeviceadvisor:SuiteDefinitionDeviceUnderTest"},"description":"Gets the devices configured."},"intendedForQualification":{"type":"boolean","description":"Gets the tests intended for qualification in a suite."},"rootGroup":{"type":"string","description":"Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if `intendedForQualification` is set to true, `rootGroup` can be an empty string. If `intendedForQualification` is false, `rootGroup` cannot be an empty string. If `rootGroup` is empty, and `intendedForQualification` is set to true, all the qualification tests are included, and the configuration is default.\n\nFor a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048."},"suiteDefinitionName":{"type":"string","description":"Gets the suite definition name. This is a required parameter."}},"type":"object","required":["devicePermissionRoleArn","rootGroup"]},"aws-native:iotcoredeviceadvisor:SuiteDefinitionDeviceUnderTest":{"properties":{"certificateArn":{"type":"string"},"thingArn":{"type":"string"}},"type":"object"},"aws-native:iotcoredeviceadvisor:SuiteDefinitionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:iotevents:AlarmModelAcknowledgeFlow":{"description":"Specifies whether to get notified for alarm state changes.","properties":{"enabled":{"type":"boolean","description":"The value must be ``TRUE`` or ``FALSE``. If ``TRUE``, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to ``NORMAL``. If ``FALSE``, you won't receive notifications. The alarm automatically changes to the ``NORMAL`` state when the input property value returns to the specified range."}},"type":"object"},"aws-native:iotevents:AlarmModelAlarmAction":{"description":"Specifies one of the following actions to receive notifications when the alarm state changes.","properties":{"dynamoDBv2":{"$ref":"#/types/aws-native:iotevents:AlarmModelDynamoDBv2","description":"Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.\n You must use expressions for all parameters in ``DynamoDBv2Action``. The expressions accept literals, operators, functions, references, and substitution templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``tableName`` parameter can be ``'GreenhouseTemperatureTable'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``tableName`` parameter can be ``$variable.ddbtableName``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``contentExpression`` parameter in ``Payload`` uses a substitution template. \n  ``'{\\\"sensorID\\\": \\\"${$input.GreenhouseInput.sensor_id}\\\", \\\"temperature\\\": \\\"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\\\"}'`` \n  +  For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``tableName`` parameter uses a string concatenation. \n  ``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`` \n  \n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.\n The value for the ``type`` parameter in ``Payload`` must be ``JSON``."},"dynamoDb":{"$ref":"#/types/aws-native:iotevents:AlarmModelDynamoDb","description":"Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.\n You must use expressions for all parameters in ``DynamoDBAction``. The expressions accept literals, operators, functions, references, and substitution templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``hashKeyType`` parameter can be ``'STRING'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``hashKeyField`` parameter can be ``$input.GreenhouseInput.name``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``hashKeyValue`` parameter uses a substitution template. \n  ``'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'`` \n  +  For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``tableName`` parameter uses a string concatenation. \n  ``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`` \n  \n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.\n If the defined payload type is a string, ``DynamoDBAction`` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the ``payloadField`` parameter is ``\u003cpayload-field\u003e_raw``."},"firehose":{"$ref":"#/types/aws-native:iotevents:AlarmModelFirehose","description":"Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream."},"iotEvents":{"$ref":"#/types/aws-native:iotevents:AlarmModelIotEvents","description":"Sends an ITE input, passing in information about the detector model instance and the event that triggered the action."},"iotSiteWise":{"$ref":"#/types/aws-native:iotevents:AlarmModelIotSiteWise","description":"Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW.\n You must use expressions for all parameters in ``IotSiteWiseAction``. The expressions accept literals, operators, functions, references, and substitutions templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``propertyAlias`` parameter can be ``'/company/windfarm/3/turbine/7/temperature'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``propertyAlias`` parameter uses a substitution template. \n  ``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'`` \n  \n You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in ITSW.\n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*."},"iotTopicPublish":{"$ref":"#/types/aws-native:iotevents:AlarmModelIotTopicPublish","description":"Information required to publish the MQTT message through the IoT message broker."},"lambda":{"$ref":"#/types/aws-native:iotevents:AlarmModelLambda","description":"Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action."},"sns":{"$ref":"#/types/aws-native:iotevents:AlarmModelSns","description":"Information required to publish the Amazon SNS message."},"sqs":{"$ref":"#/types/aws-native:iotevents:AlarmModelSqs","description":"Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue."}},"type":"object"},"aws-native:iotevents:AlarmModelAlarmCapabilities":{"description":"Contains the configuration information of alarm state changes.","properties":{"acknowledgeFlow":{"$ref":"#/types/aws-native:iotevents:AlarmModelAcknowledgeFlow","description":"Specifies whether to get notified for alarm state changes."},"initializationConfiguration":{"$ref":"#/types/aws-native:iotevents:AlarmModelInitializationConfiguration","description":"Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model."}},"type":"object"},"aws-native:iotevents:AlarmModelAlarmEventActions":{"description":"Contains information about one or more alarm actions.","properties":{"alarmActions":{"type":"array","items":{"$ref":"#/types/aws-native:iotevents:AlarmModelAlarmAction"},"description":"Specifies one or more supported actions to receive notifications when the alarm state changes."}},"type":"object"},"aws-native:iotevents:AlarmModelAlarmRule":{"description":"Defines when your alarm is invoked.","properties":{"simpleRule":{"$ref":"#/types/aws-native:iotevents:AlarmModelSimpleRule","description":"A rule that compares an input property value to a threshold value with a comparison operator."}},"type":"object"},"aws-native:iotevents:AlarmModelAssetPropertyTimestamp":{"description":"A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *API Reference*.\n You must use expressions for all parameters in ``AssetPropertyTimestamp``. The expressions accept literals, operators, functions, references, and substitution templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``timeInSeconds`` parameter can be ``'1586400675'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``offsetInNanos`` parameter can be ``$variable.time``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``timeInSeconds`` parameter uses a substitution template.\n  ``'${$input.TemperatureInput.sensorData.timestamp / 1000}'`` \n  \n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.","properties":{"offsetInNanos":{"type":"string","description":"The nanosecond offset converted from ``timeInSeconds``. The valid range is between 0-999999999."},"timeInSeconds":{"type":"string","description":"The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199."}},"type":"object","required":["timeInSeconds"]},"aws-native:iotevents:AlarmModelAssetPropertyValue":{"description":"A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *API Reference*.\n You must use expressions for all parameters in ``AssetPropertyValue``. The expressions accept literals, operators, functions, references, and substitution templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``quality`` parameter can be ``'GOOD'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``quality`` parameter can be ``$input.TemperatureInput.sensorData.quality``.\n  \n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.","properties":{"quality":{"type":"string","description":"The quality of the asset property value. The value must be ``'GOOD'``, ``'BAD'``, or ``'UNCERTAIN'``."},"timestamp":{"$ref":"#/types/aws-native:iotevents:AlarmModelAssetPropertyTimestamp","description":"The timestamp associated with the asset property value. The default is the current event time."},"value":{"$ref":"#/types/aws-native:iotevents:AlarmModelAssetPropertyVariant","description":"The value to send to an asset property."}},"type":"object","required":["value"]},"aws-native:iotevents:AlarmModelAssetPropertyVariant":{"description":"A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *API Reference*.\n You must use expressions for all parameters in ``AssetPropertyVariant``. The expressions accept literals, operators, functions, references, and substitution templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``integerValue`` parameter can be ``'100'``.\n  +  For references, you must specify either variables or parameters. For example, the value for the ``booleanValue`` parameter can be ``$variable.offline``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. \n In the following example, the value for the ``doubleValue`` parameter uses a substitution template. \n  ``'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'`` \n  \n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.\n You must specify one of the following value types, depending on the ``dataType`` of the specified asset property. For more information, see [AssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the *API Reference*.","properties":{"booleanValue":{"type":"string","description":"The asset property value is a Boolean value that must be ``'TRUE'`` or ``'FALSE'``. You must use an expression, and the evaluated result should be a Boolean value."},"doubleValue":{"type":"string","description":"The asset property value is a double. You must use an expression, and the evaluated result should be a double."},"integerValue":{"type":"string","description":"The asset property value is an integer. You must use an expression, and the evaluated result should be an integer."},"stringValue":{"type":"string","description":"The asset property value is a string. You must use an expression, and the evaluated result should be a string."}},"type":"object"},"aws-native:iotevents:AlarmModelDynamoDBv2":{"description":"Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.\n You must use expressions for all parameters in ``DynamoDBv2Action``. The expressions accept literals, operators, functions, references, and substitution templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``tableName`` parameter can be ``'GreenhouseTemperatureTable'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``tableName`` parameter can be ``$variable.ddbtableName``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``contentExpression`` parameter in ``Payload`` uses a substitution template. \n  ``'{\\\"sensorID\\\": \\\"${$input.GreenhouseInput.sensor_id}\\\", \\\"temperature\\\": \\\"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\\\"}'`` \n  +  For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``tableName`` parameter uses a string concatenation. \n  ``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`` \n  \n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.\n The value for the ``type`` parameter in ``Payload`` must be ``JSON``.","properties":{"payload":{"$ref":"#/types/aws-native:iotevents:AlarmModelPayload","description":"Information needed to configure the payload.\n By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``."},"tableName":{"type":"string","description":"The name of the DynamoDB table."}},"type":"object","required":["tableName"]},"aws-native:iotevents:AlarmModelDynamoDb":{"description":"Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.\n You must use expressions for all parameters in ``DynamoDBAction``. The expressions accept literals, operators, functions, references, and substitution templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``hashKeyType`` parameter can be ``'STRING'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``hashKeyField`` parameter can be ``$input.GreenhouseInput.name``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``hashKeyValue`` parameter uses a substitution template. \n  ``'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'`` \n  +  For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``tableName`` parameter uses a string concatenation. \n  ``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`` \n  \n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.\n If the defined payload type is a string, ``DynamoDBAction`` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the ``payloadField`` parameter is ``\u003cpayload-field\u003e_raw``.","properties":{"hashKeyField":{"type":"string","description":"The name of the hash key (also called the partition key). The ``hashKeyField`` value must match the partition key of the target DynamoDB table."},"hashKeyType":{"type":"string","description":"The data type for the hash key (also called the partition key). You can specify the following values:\n  +   ``'STRING'`` - The hash key is a string.\n  +   ``'NUMBER'`` - The hash key is a number.\n  \n If you don't specify ``hashKeyType``, the default value is ``'STRING'``."},"hashKeyValue":{"type":"string","description":"The value of the hash key (also called the partition key)."},"operation":{"type":"string","description":"The type of operation to perform. You can specify the following values: \n  +   ``'INSERT'`` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.\n  +   ``'UPDATE'`` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n  +   ``'DELETE'`` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n  \n If you don't specify this parameter, ITE triggers the ``'INSERT'`` operation."},"payload":{"$ref":"#/types/aws-native:iotevents:AlarmModelPayload","description":"Information needed to configure the payload.\n By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``."},"payloadField":{"type":"string","description":"The name of the DynamoDB column that receives the action payload.\n If you don't specify this parameter, the name of the DynamoDB column is ``payload``."},"rangeKeyField":{"type":"string","description":"The name of the range key (also called the sort key). The ``rangeKeyField`` value must match the sort key of the target DynamoDB table."},"rangeKeyType":{"type":"string","description":"The data type for the range key (also called the sort key), You can specify the following values:\n  +   ``'STRING'`` - The range key is a string.\n  +   ``'NUMBER'`` - The range key is number.\n  \n If you don't specify ``rangeKeyField``, the default value is ``'STRING'``."},"rangeKeyValue":{"type":"string","description":"The value of the range key (also called the sort key)."},"tableName":{"type":"string","description":"The name of the DynamoDB table. The ``tableName`` value must match the table name of the target DynamoDB table."}},"type":"object","required":["hashKeyField","hashKeyValue","tableName"]},"aws-native:iotevents:AlarmModelFirehose":{"description":"Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.","properties":{"deliveryStreamName":{"type":"string","description":"The name of the Kinesis Data Firehose delivery stream where the data is written."},"payload":{"$ref":"#/types/aws-native:iotevents:AlarmModelPayload","description":"You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream."},"separator":{"type":"string","description":"A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma)."}},"type":"object","required":["deliveryStreamName"]},"aws-native:iotevents:AlarmModelInitializationConfiguration":{"description":"Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.","properties":{"disabledOnInitialization":{"type":"boolean","description":"The value must be ``TRUE`` or ``FALSE``. If ``FALSE``, all alarm instances created based on the alarm model are activated. The default value is ``TRUE``."}},"type":"object","required":["disabledOnInitialization"]},"aws-native:iotevents:AlarmModelIotEvents":{"description":"Sends an ITE input, passing in information about the detector model instance and the event that triggered the action.","properties":{"inputName":{"type":"string","description":"The name of the ITE input where the data is sent."},"payload":{"$ref":"#/types/aws-native:iotevents:AlarmModelPayload","description":"You can configure the action payload when you send a message to an ITE input."}},"type":"object","required":["inputName"]},"aws-native:iotevents:AlarmModelIotSiteWise":{"description":"Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW.\n You must use expressions for all parameters in ``IotSiteWiseAction``. The expressions accept literals, operators, functions, references, and substitutions templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``propertyAlias`` parameter can be ``'/company/windfarm/3/turbine/7/temperature'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``propertyAlias`` parameter uses a substitution template. \n  ``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'`` \n  \n You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in ITSW.\n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.","properties":{"assetId":{"type":"string","description":"The ID of the asset that has the specified property."},"entryId":{"type":"string","description":"A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier."},"propertyAlias":{"type":"string","description":"The alias of the asset property."},"propertyId":{"type":"string","description":"The ID of the asset property."},"propertyValue":{"$ref":"#/types/aws-native:iotevents:AlarmModelAssetPropertyValue","description":"The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information."}},"type":"object"},"aws-native:iotevents:AlarmModelIotTopicPublish":{"description":"Information required to publish the MQTT message through the IoT message broker.","properties":{"mqttTopic":{"type":"string","description":"The MQTT topic of the message. You can use a string expression that includes variables (``$variable.\u003cvariable-name\u003e``) and input values (``$input.\u003cinput-name\u003e.\u003cpath-to-datum\u003e``) as the topic string."},"payload":{"$ref":"#/types/aws-native:iotevents:AlarmModelPayload","description":"You can configure the action payload when you publish a message to an IoTCore topic."}},"type":"object","required":["mqttTopic"]},"aws-native:iotevents:AlarmModelLambda":{"description":"Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.","properties":{"functionArn":{"type":"string","description":"The ARN of the Lambda function that is executed."},"payload":{"$ref":"#/types/aws-native:iotevents:AlarmModelPayload","description":"You can configure the action payload when you send a message to a Lambda function."}},"type":"object","required":["functionArn"]},"aws-native:iotevents:AlarmModelPayload":{"description":"Information needed to configure the payload.\n By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``.","properties":{"contentExpression":{"type":"string","description":"The content of the payload. You can use a string expression that includes quoted strings (``'\u003cstring\u003e'``), variables (``$variable.\u003cvariable-name\u003e``), input values (``$input.\u003cinput-name\u003e.\u003cpath-to-datum\u003e``), string concatenations, and quoted strings that contain ``${}`` as the content. The recommended maximum size of a content expression is 1 KB."},"type":{"type":"string","description":"The value of the payload type can be either ``STRING`` or ``JSON``."}},"type":"object","required":["contentExpression","type"]},"aws-native:iotevents:AlarmModelSimpleRule":{"description":"A rule that compares an input property value to a threshold value with a comparison operator.","properties":{"comparisonOperator":{"$ref":"#/types/aws-native:iotevents:AlarmModelSimpleRuleComparisonOperator","description":"The comparison operator."},"inputProperty":{"type":"string","description":"The value on the left side of the comparison operator. You can specify an ITE input attribute as an input property."},"threshold":{"type":"string","description":"The value on the right side of the comparison operator. You can enter a number or specify an ITE input attribute."}},"type":"object","required":["comparisonOperator","inputProperty","threshold"]},"aws-native:iotevents:AlarmModelSimpleRuleComparisonOperator":{"description":"The comparison operator.","type":"string","enum":[{"name":"Greater","value":"GREATER"},{"name":"GreaterOrEqual","value":"GREATER_OR_EQUAL"},{"name":"Less","value":"LESS"},{"name":"LessOrEqual","value":"LESS_OR_EQUAL"},{"name":"Equal","value":"EQUAL"},{"name":"NotEqual","value":"NOT_EQUAL"}]},"aws-native:iotevents:AlarmModelSns":{"description":"Information required to publish the Amazon SNS message.","properties":{"payload":{"$ref":"#/types/aws-native:iotevents:AlarmModelPayload","description":"You can configure the action payload when you send a message as an Amazon SNS push notification."},"targetArn":{"type":"string","description":"The ARN of the Amazon SNS target where the message is sent."}},"type":"object","required":["targetArn"]},"aws-native:iotevents:AlarmModelSqs":{"description":"Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.","properties":{"payload":{"$ref":"#/types/aws-native:iotevents:AlarmModelPayload","description":"You can configure the action payload when you send a message to an Amazon SQS queue."},"queueUrl":{"type":"string","description":"The URL of the SQS queue where the data is written."},"useBase64":{"type":"boolean","description":"Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE."}},"type":"object","required":["queueUrl"]},"aws-native:iotevents:AlarmModelTag":{"description":"Metadata that can be used to manage the resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iotevents:DetectorModelAction":{"description":"An action to be performed when the ``condition`` is TRUE.","properties":{"clearTimer":{"$ref":"#/types/aws-native:iotevents:DetectorModelClearTimer","description":"Information needed to clear the timer."},"dynamoDBv2":{"$ref":"#/types/aws-native:iotevents:DetectorModelDynamoDBv2","description":"Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *Developer Guide*."},"dynamoDb":{"$ref":"#/types/aws-native:iotevents:DetectorModelDynamoDb","description":"Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see [Actions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html) in *Developer Guide*."},"firehose":{"$ref":"#/types/aws-native:iotevents:DetectorModelFirehose","description":"Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream."},"iotEvents":{"$ref":"#/types/aws-native:iotevents:DetectorModelIotEvents","description":"Sends ITE input, which passes information about the detector model instance and the event that triggered the action."},"iotSiteWise":{"$ref":"#/types/aws-native:iotevents:DetectorModelIotSiteWise","description":"Sends information about the detector model instance and the event that triggered the action to an asset property in ITSW ."},"iotTopicPublish":{"$ref":"#/types/aws-native:iotevents:DetectorModelIotTopicPublish","description":"Publishes an MQTT message with the given topic to the IoT message broker."},"lambda":{"$ref":"#/types/aws-native:iotevents:DetectorModelLambda","description":"Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action."},"resetTimer":{"$ref":"#/types/aws-native:iotevents:DetectorModelResetTimer","description":"Information needed to reset the timer."},"setTimer":{"$ref":"#/types/aws-native:iotevents:DetectorModelSetTimer","description":"Information needed to set the timer."},"setVariable":{"$ref":"#/types/aws-native:iotevents:DetectorModelSetVariable","description":"Sets a variable to a specified value."},"sns":{"$ref":"#/types/aws-native:iotevents:DetectorModelSns","description":"Sends an Amazon SNS message."},"sqs":{"$ref":"#/types/aws-native:iotevents:DetectorModelSqs","description":"Sends an Amazon SNS message."}},"type":"object"},"aws-native:iotevents:DetectorModelAssetPropertyTimestamp":{"description":"A structure that contains timestamp information. For more information, see [TimeInNanos](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html) in the *API Reference*.\n You must use expressions for all parameters in ``AssetPropertyTimestamp``. The expressions accept literals, operators, functions, references, and substitution templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``timeInSeconds`` parameter can be ``'1586400675'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``offsetInNanos`` parameter can be ``$variable.time``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``timeInSeconds`` parameter uses a substitution template.\n  ``'${$input.TemperatureInput.sensorData.timestamp / 1000}'`` \n  \n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.","properties":{"offsetInNanos":{"type":"string","description":"The nanosecond offset converted from ``timeInSeconds``. The valid range is between 0-999999999."},"timeInSeconds":{"type":"string","description":"The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199."}},"type":"object","required":["timeInSeconds"]},"aws-native:iotevents:DetectorModelAssetPropertyValue":{"description":"A structure that contains value information. For more information, see [AssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html) in the *API Reference*.\n You must use expressions for all parameters in ``AssetPropertyValue``. The expressions accept literals, operators, functions, references, and substitution templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``quality`` parameter can be ``'GOOD'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``quality`` parameter can be ``$input.TemperatureInput.sensorData.quality``.\n  \n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.","properties":{"quality":{"type":"string","description":"The quality of the asset property value. The value must be ``'GOOD'``, ``'BAD'``, or ``'UNCERTAIN'``."},"timestamp":{"$ref":"#/types/aws-native:iotevents:DetectorModelAssetPropertyTimestamp","description":"The timestamp associated with the asset property value. The default is the current event time."},"value":{"$ref":"#/types/aws-native:iotevents:DetectorModelAssetPropertyVariant","description":"The value to send to an asset property."}},"type":"object","required":["value"]},"aws-native:iotevents:DetectorModelAssetPropertyVariant":{"description":"A structure that contains an asset property value. For more information, see [Variant](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html) in the *API Reference*.\n You must use expressions for all parameters in ``AssetPropertyVariant``. The expressions accept literals, operators, functions, references, and substitution templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``integerValue`` parameter can be ``'100'``.\n  +  For references, you must specify either variables or parameters. For example, the value for the ``booleanValue`` parameter can be ``$variable.offline``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. \n In the following example, the value for the ``doubleValue`` parameter uses a substitution template. \n  ``'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'`` \n  \n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.\n You must specify one of the following value types, depending on the ``dataType`` of the specified asset property. For more information, see [AssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the *API Reference*.","properties":{"booleanValue":{"type":"string","description":"The asset property value is a Boolean value that must be ``'TRUE'`` or ``'FALSE'``. You must use an expression, and the evaluated result should be a Boolean value."},"doubleValue":{"type":"string","description":"The asset property value is a double. You must use an expression, and the evaluated result should be a double."},"integerValue":{"type":"string","description":"The asset property value is an integer. You must use an expression, and the evaluated result should be an integer."},"stringValue":{"type":"string","description":"The asset property value is a string. You must use an expression, and the evaluated result should be a string."}},"type":"object"},"aws-native:iotevents:DetectorModelClearTimer":{"description":"Information needed to clear the timer.","properties":{"timerName":{"type":"string","description":"The name of the timer to clear."}},"type":"object","required":["timerName"]},"aws-native:iotevents:DetectorModelDefinition":{"description":"Information that defines how a detector operates.","properties":{"initialStateName":{"type":"string","description":"The state that is entered at the creation of each detector (instance)."},"states":{"type":"array","items":{"$ref":"#/types/aws-native:iotevents:DetectorModelState"},"description":"Information about the states of the detector."}},"type":"object","required":["initialStateName","states"]},"aws-native:iotevents:DetectorModelDynamoDBv2":{"description":"Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.\n You must use expressions for all parameters in ``DynamoDBv2Action``. The expressions accept literals, operators, functions, references, and substitution templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``tableName`` parameter can be ``'GreenhouseTemperatureTable'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``tableName`` parameter can be ``$variable.ddbtableName``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``contentExpression`` parameter in ``Payload`` uses a substitution template. \n  ``'{\\\"sensorID\\\": \\\"${$input.GreenhouseInput.sensor_id}\\\", \\\"temperature\\\": \\\"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\\\"}'`` \n  +  For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``tableName`` parameter uses a string concatenation. \n  ``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`` \n  \n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.\n The value for the ``type`` parameter in ``Payload`` must be ``JSON``.","properties":{"payload":{"$ref":"#/types/aws-native:iotevents:DetectorModelPayload","description":"Information needed to configure the payload.\n By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``."},"tableName":{"type":"string","description":"The name of the DynamoDB table."}},"type":"object","required":["tableName"]},"aws-native:iotevents:DetectorModelDynamoDb":{"description":"Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.\n You must use expressions for all parameters in ``DynamoDBAction``. The expressions accept literals, operators, functions, references, and substitution templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``hashKeyType`` parameter can be ``'STRING'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``hashKeyField`` parameter can be ``$input.GreenhouseInput.name``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``hashKeyValue`` parameter uses a substitution template. \n  ``'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'`` \n  +  For a string concatenation, you must use ``+``. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``tableName`` parameter uses a string concatenation. \n  ``'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date`` \n  \n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.\n If the defined payload type is a string, ``DynamoDBAction`` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the ``payloadField`` parameter is ``\u003cpayload-field\u003e_raw``.","properties":{"hashKeyField":{"type":"string","description":"The name of the hash key (also called the partition key). The ``hashKeyField`` value must match the partition key of the target DynamoDB table."},"hashKeyType":{"type":"string","description":"The data type for the hash key (also called the partition key). You can specify the following values:\n  +   ``'STRING'`` - The hash key is a string.\n  +   ``'NUMBER'`` - The hash key is a number.\n  \n If you don't specify ``hashKeyType``, the default value is ``'STRING'``."},"hashKeyValue":{"type":"string","description":"The value of the hash key (also called the partition key)."},"operation":{"type":"string","description":"The type of operation to perform. You can specify the following values: \n  +   ``'INSERT'`` - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.\n  +   ``'UPDATE'`` - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n  +   ``'DELETE'`` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.\n  \n If you don't specify this parameter, ITE triggers the ``'INSERT'`` operation."},"payload":{"$ref":"#/types/aws-native:iotevents:DetectorModelPayload","description":"Information needed to configure the payload.\n By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``."},"payloadField":{"type":"string","description":"The name of the DynamoDB column that receives the action payload.\n If you don't specify this parameter, the name of the DynamoDB column is ``payload``."},"rangeKeyField":{"type":"string","description":"The name of the range key (also called the sort key). The ``rangeKeyField`` value must match the sort key of the target DynamoDB table."},"rangeKeyType":{"type":"string","description":"The data type for the range key (also called the sort key), You can specify the following values:\n  +   ``'STRING'`` - The range key is a string.\n  +   ``'NUMBER'`` - The range key is number.\n  \n If you don't specify ``rangeKeyField``, the default value is ``'STRING'``."},"rangeKeyValue":{"type":"string","description":"The value of the range key (also called the sort key)."},"tableName":{"type":"string","description":"The name of the DynamoDB table. The ``tableName`` value must match the table name of the target DynamoDB table."}},"type":"object","required":["hashKeyField","hashKeyValue","tableName"]},"aws-native:iotevents:DetectorModelEvaluationMethod":{"description":"Information about the order in which events are evaluated and how actions are executed.","type":"string","enum":[{"name":"Batch","value":"BATCH"},{"name":"Serial","value":"SERIAL"}]},"aws-native:iotevents:DetectorModelEvent":{"description":"Specifies the ``actions`` to be performed when the ``condition`` evaluates to TRUE.","properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:iotevents:DetectorModelAction"},"description":"The actions to be performed."},"condition":{"type":"string","description":"Optional. The Boolean expression that, when TRUE, causes the ``actions`` to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE)."},"eventName":{"type":"string","description":"The name of the event."}},"type":"object","required":["eventName"]},"aws-native:iotevents:DetectorModelFirehose":{"description":"Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.","properties":{"deliveryStreamName":{"type":"string","description":"The name of the Kinesis Data Firehose delivery stream where the data is written."},"payload":{"$ref":"#/types/aws-native:iotevents:DetectorModelPayload","description":"You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream."},"separator":{"type":"string","description":"A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma)."}},"type":"object","required":["deliveryStreamName"]},"aws-native:iotevents:DetectorModelIotEvents":{"description":"Sends an ITE input, passing in information about the detector model instance and the event that triggered the action.","properties":{"inputName":{"type":"string","description":"The name of the ITE input where the data is sent."},"payload":{"$ref":"#/types/aws-native:iotevents:DetectorModelPayload","description":"You can configure the action payload when you send a message to an ITE input."}},"type":"object","required":["inputName"]},"aws-native:iotevents:DetectorModelIotSiteWise":{"description":"Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW.\n You must use expressions for all parameters in ``IotSiteWiseAction``. The expressions accept literals, operators, functions, references, and substitutions templates.\n  **Examples**\n +  For literal values, the expressions must contain single quotes. For example, the value for the ``propertyAlias`` parameter can be ``'/company/windfarm/3/turbine/7/temperature'``.\n  +  For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1``.\n  +  For a substitution template, you must use ``${}``, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.\n In the following example, the value for the ``propertyAlias`` parameter uses a substitution template. \n  ``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'`` \n  \n You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in ITSW.\n For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *Developer Guide*.","properties":{"assetId":{"type":"string","description":"The ID of the asset that has the specified property."},"entryId":{"type":"string","description":"A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier."},"propertyAlias":{"type":"string","description":"The alias of the asset property."},"propertyId":{"type":"string","description":"The ID of the asset property."},"propertyValue":{"$ref":"#/types/aws-native:iotevents:DetectorModelAssetPropertyValue","description":"The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information."}},"type":"object","required":["propertyValue"]},"aws-native:iotevents:DetectorModelIotTopicPublish":{"description":"Information required to publish the MQTT message through the IoT message broker.","properties":{"mqttTopic":{"type":"string","description":"The MQTT topic of the message. You can use a string expression that includes variables (``$variable.\u003cvariable-name\u003e``) and input values (``$input.\u003cinput-name\u003e.\u003cpath-to-datum\u003e``) as the topic string."},"payload":{"$ref":"#/types/aws-native:iotevents:DetectorModelPayload","description":"You can configure the action payload when you publish a message to an IoTCore topic."}},"type":"object","required":["mqttTopic"]},"aws-native:iotevents:DetectorModelLambda":{"description":"Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.","properties":{"functionArn":{"type":"string","description":"The ARN of the Lambda function that is executed."},"payload":{"$ref":"#/types/aws-native:iotevents:DetectorModelPayload","description":"You can configure the action payload when you send a message to a Lambda function."}},"type":"object","required":["functionArn"]},"aws-native:iotevents:DetectorModelOnEnter":{"description":"When entering this state, perform these ``actions`` if the ``condition`` is TRUE.","properties":{"events":{"type":"array","items":{"$ref":"#/types/aws-native:iotevents:DetectorModelEvent"},"description":"Specifies the actions that are performed when the state is entered and the ``condition`` is ``TRUE``."}},"type":"object"},"aws-native:iotevents:DetectorModelOnExit":{"description":"When exiting this state, perform these ``actions`` if the specified ``condition`` is ``TRUE``.","properties":{"events":{"type":"array","items":{"$ref":"#/types/aws-native:iotevents:DetectorModelEvent"},"description":"Specifies the ``actions`` that are performed when the state is exited and the ``condition`` is ``TRUE``."}},"type":"object"},"aws-native:iotevents:DetectorModelOnInput":{"description":"Specifies the actions performed when the ``condition`` evaluates to TRUE.","properties":{"events":{"type":"array","items":{"$ref":"#/types/aws-native:iotevents:DetectorModelEvent"},"description":"Specifies the actions performed when the ``condition`` evaluates to TRUE."},"transitionEvents":{"type":"array","items":{"$ref":"#/types/aws-native:iotevents:DetectorModelTransitionEvent"},"description":"Specifies the actions performed, and the next state entered, when a ``condition`` evaluates to TRUE."}},"type":"object"},"aws-native:iotevents:DetectorModelPayload":{"description":"Information needed to configure the payload.\n By default, ITE generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression``.","properties":{"contentExpression":{"type":"string","description":"The content of the payload. You can use a string expression that includes quoted strings (``'\u003cstring\u003e'``), variables (``$variable.\u003cvariable-name\u003e``), input values (``$input.\u003cinput-name\u003e.\u003cpath-to-datum\u003e``), string concatenations, and quoted strings that contain ``${}`` as the content. The recommended maximum size of a content expression is 1 KB."},"type":{"type":"string","description":"The value of the payload type can be either ``STRING`` or ``JSON``."}},"type":"object","required":["contentExpression","type"]},"aws-native:iotevents:DetectorModelResetTimer":{"description":"Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer.","properties":{"timerName":{"type":"string","description":"The name of the timer to reset."}},"type":"object","required":["timerName"]},"aws-native:iotevents:DetectorModelSetTimer":{"description":"Information needed to set the timer.","properties":{"durationExpression":{"type":"string","description":"The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (``$variable.\u003cvariable-name\u003e``), and input values (``$input.\u003cinput-name\u003e.\u003cpath-to-datum\u003e``) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number."},"seconds":{"type":"integer","description":"The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds."},"timerName":{"type":"string","description":"The name of the timer."}},"type":"object","required":["timerName"]},"aws-native:iotevents:DetectorModelSetVariable":{"description":"Information about the variable and its new value.","properties":{"value":{"type":"string","description":"The new value of the variable."},"variableName":{"type":"string","description":"The name of the variable."}},"type":"object","required":["value","variableName"]},"aws-native:iotevents:DetectorModelSns":{"description":"Information required to publish the Amazon SNS message.","properties":{"payload":{"$ref":"#/types/aws-native:iotevents:DetectorModelPayload","description":"You can configure the action payload when you send a message as an Amazon SNS push notification."},"targetArn":{"type":"string","description":"The ARN of the Amazon SNS target where the message is sent."}},"type":"object","required":["targetArn"]},"aws-native:iotevents:DetectorModelSqs":{"description":"Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.","properties":{"payload":{"$ref":"#/types/aws-native:iotevents:DetectorModelPayload","description":"You can configure the action payload when you send a message to an Amazon SQS queue."},"queueUrl":{"type":"string","description":"The URL of the SQS queue where the data is written."},"useBase64":{"type":"boolean","description":"Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE."}},"type":"object","required":["queueUrl"]},"aws-native:iotevents:DetectorModelState":{"description":"Information that defines a state of a detector.","properties":{"onEnter":{"$ref":"#/types/aws-native:iotevents:DetectorModelOnEnter","description":"When entering this state, perform these ``actions`` if the ``condition`` is TRUE."},"onExit":{"$ref":"#/types/aws-native:iotevents:DetectorModelOnExit","description":"When exiting this state, perform these ``actions`` if the specified ``condition`` is ``TRUE``."},"onInput":{"$ref":"#/types/aws-native:iotevents:DetectorModelOnInput","description":"When an input is received and the ``condition`` is TRUE, perform the specified ``actions``."},"stateName":{"type":"string","description":"The name of the state."}},"type":"object","required":["stateName"]},"aws-native:iotevents:DetectorModelTag":{"description":"Metadata that can be used to manage the resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iotevents:DetectorModelTransitionEvent":{"description":"Specifies the actions performed and the next state entered when a ``condition`` evaluates to TRUE.","properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:iotevents:DetectorModelAction"},"description":"The actions to be performed."},"condition":{"type":"string","description":"Required. A Boolean expression that when TRUE causes the actions to be performed and the ``nextState`` to be entered."},"eventName":{"type":"string","description":"The name of the transition event."},"nextState":{"type":"string","description":"The next state to enter."}},"type":"object","required":["condition","eventName","nextState"]},"aws-native:iotevents:InputAttribute":{"description":"The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the ITE system using ``BatchPutMessage``. Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the ``condition`` expressions used by detectors.","properties":{"jsonPath":{"type":"string","description":"An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to ITE (``BatchPutMessage``). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the ``condition`` expressions used by detectors. \n Syntax: ``\u003cfield-name\u003e.\u003cfield-name\u003e...``"}},"type":"object","required":["jsonPath"]},"aws-native:iotevents:InputDefinition":{"description":"The definition of the input.","properties":{"attributes":{"type":"array","items":{"$ref":"#/types/aws-native:iotevents:InputAttribute"},"description":"The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the ITE system using ``BatchPutMessage``. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the ``condition`` expressions used by detectors that monitor this input."}},"type":"object","required":["attributes"]},"aws-native:iotevents:InputTag":{"description":"Metadata that can be used to manage the resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:iotfleethub:ApplicationTag":{"description":"To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:iotsitewise:AccessPolicyIamRole":{"description":"Contains information for an IAM role identity in an access policy.","properties":{"arn":{"type":"string","description":"The ARN of the IAM role."}},"type":"object"},"aws-native:iotsitewise:AccessPolicyIamUser":{"description":"Contains information for an IAM user identity in an access policy.","properties":{"arn":{"type":"string","description":"The ARN of the IAM user."}},"type":"object"},"aws-native:iotsitewise:AccessPolicyIdentity":{"description":"The identity for this access policy. Choose either an SSO user or group or an IAM user or role.","properties":{"iamRole":{"$ref":"#/types/aws-native:iotsitewise:AccessPolicyIamRole","description":"An IAM role identity."},"iamUser":{"$ref":"#/types/aws-native:iotsitewise:AccessPolicyIamUser","description":"An IAM user identity."},"user":{"$ref":"#/types/aws-native:iotsitewise:AccessPolicyUser","description":"An IAM Identity Center user identity."}},"type":"object"},"aws-native:iotsitewise:AccessPolicyPortal":{"description":"A portal resource.","properties":{"id":{"type":"string","description":"The ID of the portal."}},"type":"object"},"aws-native:iotsitewise:AccessPolicyProject":{"description":"A project resource.","properties":{"id":{"type":"string","description":"The ID of the project."}},"type":"object"},"aws-native:iotsitewise:AccessPolicyResource":{"description":"The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.","properties":{"portal":{"$ref":"#/types/aws-native:iotsitewise:AccessPolicyPortal","description":"Identifies an AWS IoT SiteWise Monitor portal."},"project":{"$ref":"#/types/aws-native:iotsitewise:AccessPolicyProject","description":"Identifies a specific AWS IoT SiteWise Monitor project."}},"type":"object"},"aws-native:iotsitewise:AccessPolicyUser":{"description":"Contains information for a user identity in an access policy.","properties":{"id":{"type":"string","description":"The AWS SSO ID of the user."}},"type":"object"},"aws-native:iotsitewise:AlarmsProperties":{"description":"Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.","properties":{"alarmRoleArn":{"type":"string","description":"The ARN of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events."},"notificationLambdaArn":{"type":"string","description":"The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide."}},"type":"object"},"aws-native:iotsitewise:AssetHierarchy":{"description":"A hierarchy specifies allowed parent/child asset relationships.","properties":{"childAssetId":{"type":"string","description":"The ID of the child asset to be associated."},"externalId":{"type":"string","description":"String-friendly customer provided external ID"},"id":{"type":"string","description":"Customer provided actual UUID for property"},"logicalId":{"type":"string","description":"The LogicalID of a hierarchy in the parent asset's model."}},"type":"object","required":["childAssetId"]},"aws-native:iotsitewise:AssetModelAttribute":{"properties":{"defaultValue":{"type":"string","description":"The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see [Updating attribute values](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html) in the *AWS IoT SiteWise User Guide* ."}},"type":"object"},"aws-native:iotsitewise:AssetModelCompositeModel":{"description":"Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.","properties":{"composedAssetModelId":{"type":"string","description":"The component model ID for which the composite model is composed of"},"compositeModelProperties":{"type":"array","items":{"$ref":"#/types/aws-native:iotsitewise:AssetModelProperty"},"description":"The property definitions of the asset model. You can specify up to 200 properties per asset model."},"description":{"type":"string","description":"A description for the asset composite model."},"externalId":{"type":"string","description":"The External ID of the composite model"},"id":{"type":"string","description":"The Actual ID of the composite model"},"name":{"type":"string","description":"A unique, friendly name for the asset composite model."},"parentAssetModelCompositeModelExternalId":{"type":"string","description":"The parent composite model External ID"},"path":{"type":"array","items":{"type":"string"},"description":"The path of the composite model. This is only for derived composite models"},"type":{"type":"string","description":"The type of the composite model. For alarm composite models, this type is AWS/ALARM"}},"type":"object","required":["name","type"]},"aws-native:iotsitewise:AssetModelDataType":{"type":"string","enum":[{"name":"String","value":"STRING"},{"name":"Integer","value":"INTEGER"},{"name":"Double","value":"DOUBLE"},{"name":"Boolean","value":"BOOLEAN"},{"name":"Struct","value":"STRUCT"}]},"aws-native:iotsitewise:AssetModelDataTypeSpec":{"type":"string","enum":[{"name":"AwsalarmState","value":"AWS/ALARM_STATE"}]},"aws-native:iotsitewise:AssetModelEnforcedAssetModelInterfacePropertyMapping":{"description":"Contains information about enforced interface property and asset model property","properties":{"assetModelPropertyExternalId":{"type":"string","description":"The external ID of the enforced asset model property"},"assetModelPropertyLogicalId":{"type":"string","description":"The logical ID of the enforced asset model property"},"interfaceAssetModelPropertyExternalId":{"type":"string","description":"The external ID of the enforced interface property"}},"type":"object","required":["interfaceAssetModelPropertyExternalId"]},"aws-native:iotsitewise:AssetModelEnforcedAssetModelInterfaceRelationship":{"description":"Contains information about enforced interface hierarchy and asset model hierarchy","properties":{"interfaceAssetModelId":{"type":"string","description":"The ID of the interface that is enforced to the asset model"},"propertyMappings":{"type":"array","items":{"$ref":"#/types/aws-native:iotsitewise:AssetModelEnforcedAssetModelInterfacePropertyMapping"},"description":"Contains information about enforced interface property and asset model property"}},"type":"object"},"aws-native:iotsitewise:AssetModelExpressionVariable":{"properties":{"name":{"type":"string","description":"The friendly name of the variable to be used in the expression."},"value":{"$ref":"#/types/aws-native:iotsitewise:AssetModelVariableValue","description":"The variable that identifies an asset property from which to use values."}},"type":"object","required":["name","value"]},"aws-native:iotsitewise:AssetModelHierarchy":{"description":"Contains information about an asset model hierarchy.","properties":{"childAssetModelId":{"type":"string","description":"The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model."},"externalId":{"type":"string","description":"Customer provided external ID for hierarchy"},"id":{"type":"string","description":"Customer provided actual ID for hierarchy"},"logicalId":{"type":"string","description":"Customer provided logical ID for hierarchy."},"name":{"type":"string","description":"The name of the asset model hierarchy."}},"type":"object","required":["childAssetModelId","name"]},"aws-native:iotsitewise:AssetModelMetric":{"properties":{"expression":{"type":"string","description":"The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression."},"variables":{"type":"array","items":{"$ref":"#/types/aws-native:iotsitewise:AssetModelExpressionVariable"},"description":"The list of variables used in the expression."},"window":{"$ref":"#/types/aws-native:iotsitewise:AssetModelMetricWindow","description":"The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression"}},"type":"object","required":["expression","variables","window"]},"aws-native:iotsitewise:AssetModelMetricWindow":{"description":"Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).","properties":{"tumbling":{"$ref":"#/types/aws-native:iotsitewise:AssetModelTumblingWindow","description":"The tumbling time interval window."}},"type":"object"},"aws-native:iotsitewise:AssetModelProperty":{"description":"Contains information about an asset model property.","properties":{"dataType":{"$ref":"#/types/aws-native:iotsitewise:AssetModelDataType","description":"The data type of the asset model property."},"dataTypeSpec":{"$ref":"#/types/aws-native:iotsitewise:AssetModelDataTypeSpec","description":"The data type of the structure for this property."},"externalId":{"type":"string","description":"The External ID of the Asset Model Property"},"id":{"type":"string","description":"The ID of the Asset Model Property"},"logicalId":{"type":"string","description":"Customer provided Logical ID for property."},"name":{"type":"string","description":"The name of the asset model property."},"type":{"$ref":"#/types/aws-native:iotsitewise:AssetModelPropertyType","description":"The property type"},"unit":{"type":"string","description":"The unit of the asset model property, such as Newtons or RPM."}},"type":"object","required":["dataType","name","type"]},"aws-native:iotsitewise:AssetModelPropertyPathDefinition":{"description":"The definition for property path which is used to reference properties in transforms/metrics","properties":{"name":{"type":"string","description":"The name of the property"}},"type":"object","required":["name"]},"aws-native:iotsitewise:AssetModelPropertyType":{"description":"Contains a property type, which can be one of attribute, measurement, metric, or transform.","properties":{"attribute":{"$ref":"#/types/aws-native:iotsitewise:AssetModelAttribute","description":"Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an [IIoT](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) wind turbine."},"metric":{"$ref":"#/types/aws-native:iotsitewise:AssetModelMetric","description":"Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature."},"transform":{"$ref":"#/types/aws-native:iotsitewise:AssetModelTransform","description":"Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit."},"typeName":{"$ref":"#/types/aws-native:iotsitewise:AssetModelTypeName","description":"The type of property type, which can be one of `Attribute` , `Measurement` , `Metric` , or `Transform` ."}},"type":"object","required":["typeName"]},"aws-native:iotsitewise:AssetModelTag":{"properties":{"key":{"type":"string","description":"The key or name that identifies the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:iotsitewise:AssetModelTransform":{"properties":{"expression":{"type":"string","description":"The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression."},"variables":{"type":"array","items":{"$ref":"#/types/aws-native:iotsitewise:AssetModelExpressionVariable"},"description":"The list of variables used in the expression."}},"type":"object","required":["expression","variables"]},"aws-native:iotsitewise:AssetModelTumblingWindow":{"description":"Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time interval. This window is used in metric and aggregation computations.","properties":{"interval":{"type":"string","description":"The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.\n\nAWS IoT SiteWise computes the `1w` interval the end of Sunday at midnight each week (UTC), the `1d` interval at the end of each day at midnight (UTC), the `1h` interval at the end of each hour, and so on.\n\nWhen AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval."},"offset":{"type":"string","description":"The offset for the tumbling window. The `offset` parameter accepts the following:\n\n- The offset time.\n\nFor example, if you specify `18h` for `offset` and `1d` for `interval` , AWS IoT SiteWise aggregates data in one of the following ways:\n\n- If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.\n- If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.\n- The ISO 8601 format.\n\nFor example, if you specify `PT18H` for `offset` and `1d` for `interval` , AWS IoT SiteWise aggregates data in one of the following ways:\n\n- If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.\n- If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.\n- The 24-hour clock.\n\nFor example, if you specify `00:03:00` for `offset` , `5m` for `interval` , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).\n- The offset time zone.\n\nFor example, if you specify `2021-07-23T18:00-08` for `offset` and `1d` for `interval` , AWS IoT SiteWise aggregates data in one of the following ways:\n\n- If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.\n- If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day."}},"type":"object","required":["interval"]},"aws-native:iotsitewise:AssetModelTypeName":{"type":"string","enum":[{"name":"Measurement","value":"Measurement"},{"name":"Attribute","value":"Attribute"},{"name":"Transform","value":"Transform"},{"name":"Metric","value":"Metric"}]},"aws-native:iotsitewise:AssetModelVariableValue":{"properties":{"hierarchyExternalId":{"type":"string","description":"The External ID of the hierarchy that is trying to be referenced"},"hierarchyId":{"type":"string","description":"The ID of the hierarchy that is trying to be referenced"},"hierarchyLogicalId":{"type":"string","description":"The `LogicalID` of the hierarchy to query for the `PropertyLogicalID` .\n\nYou use a `hierarchyLogicalID` instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see [Defining relationships between asset models (hierarchies)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) in the *AWS IoT SiteWise User Guide* ."},"propertyExternalId":{"type":"string","description":"The External ID of the property that is trying to be referenced"},"propertyId":{"type":"string","description":"The ID of the property that is trying to be referenced"},"propertyLogicalId":{"type":"string","description":"The `LogicalID` of the property that is being referenced."},"propertyPath":{"type":"array","items":{"$ref":"#/types/aws-native:iotsitewise:AssetModelPropertyPathDefinition"},"description":"The path of the property that is trying to be referenced"}},"type":"object"},"aws-native:iotsitewise:AssetProperty":{"description":"The asset property's definition, alias, unit, and notification state.","properties":{"alias":{"type":"string","description":"The property alias that identifies the property."},"externalId":{"type":"string","description":"String-friendly customer provided external ID"},"id":{"type":"string","description":"Customer provided actual UUID for property"},"logicalId":{"type":"string","description":"Customer provided ID for property."},"notificationState":{"$ref":"#/types/aws-native:iotsitewise:AssetPropertyNotificationState","description":"The MQTT notification state (ENABLED or DISABLED) for this asset property."},"unit":{"type":"string","description":"The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model."}},"type":"object"},"aws-native:iotsitewise:AssetPropertyNotificationState":{"description":"The MQTT notification state (ENABLED or DISABLED) for this asset property.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:iotsitewise:AssetTag":{"properties":{"key":{"type":"string","description":"The key or name that identifies the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:iotsitewise:DashboardTag":{"description":"To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted","properties":{"key":{"type":"string","description":"The key or name that identifies the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:iotsitewise:DatasetKendraSourceDetail":{"properties":{"knowledgeBaseArn":{"type":"string","description":"The knowledgeBaseArn details for the Kendra dataset source."},"roleArn":{"type":"string","description":"The roleARN details for the Kendra dataset source."}},"type":"object","required":["knowledgeBaseArn","roleArn"]},"aws-native:iotsitewise:DatasetSource":{"properties":{"sourceDetail":{"$ref":"#/types/aws-native:iotsitewise:DatasetSourceDetail","description":"The details of the dataset source associated with the dataset."},"sourceFormat":{"$ref":"#/types/aws-native:iotsitewise:DatasetSourceSourceFormat","description":"The format of the dataset source associated with the dataset."},"sourceType":{"$ref":"#/types/aws-native:iotsitewise:DatasetSourceSourceType","description":"The type of data source for the dataset."}},"type":"object","required":["sourceFormat","sourceType"]},"aws-native:iotsitewise:DatasetSourceDetail":{"properties":{"kendra":{"$ref":"#/types/aws-native:iotsitewise:DatasetKendraSourceDetail","description":"Contains details about the Kendra dataset source."}},"type":"object"},"aws-native:iotsitewise:DatasetSourceSourceFormat":{"description":"The format of the dataset source associated with the dataset.","type":"string","enum":[{"name":"KnowledgeBase","value":"KNOWLEDGE_BASE"}]},"aws-native:iotsitewise:DatasetSourceSourceType":{"description":"The type of data source for the dataset.","type":"string","enum":[{"name":"Kendra","value":"KENDRA"}]},"aws-native:iotsitewise:DatasetTag":{"properties":{"key":{"type":"string","description":"The key or name that identifies the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:iotsitewise:GatewayCapabilitySummary":{"description":"Contains a summary of a gateway capability configuration.","properties":{"capabilityConfiguration":{"type":"string","description":"The JSON document that defines the configuration for the gateway capability. For more information, see [Configuring data sources (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) in the *AWS IoT SiteWise User Guide* ."},"capabilityNamespace":{"type":"string","description":"The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace `iotsitewise:opcuacollector:3` ."}},"type":"object","required":["capabilityNamespace"]},"aws-native:iotsitewise:GatewayGreengrassV2":{"description":"Contains the CoreDeviceThingName of AWS IoT Greengrass Group V2 that the gateway runs on.","properties":{"coreDeviceOperatingSystem":{"$ref":"#/types/aws-native:iotsitewise:GatewayGreengrassV2CoreDeviceOperatingSystem","description":"The operating system of the core device in AWS IoT Greengrass V2."},"coreDeviceThingName":{"type":"string","description":"The name of the CoreDevice in GreenGrass V2."}},"type":"object","required":["coreDeviceThingName"]},"aws-native:iotsitewise:GatewayGreengrassV2CoreDeviceOperatingSystem":{"description":"The operating system of the core device in AWS IoT Greengrass V2.","type":"string","enum":[{"name":"LinuxAarch64","value":"LINUX_AARCH64"},{"name":"LinuxAmd64","value":"LINUX_AMD64"},{"name":"WindowsAmd64","value":"WINDOWS_AMD64"}]},"aws-native:iotsitewise:GatewayPlatform":{"description":"Contains a gateway's platform information.","properties":{"greengrassV2":{"$ref":"#/types/aws-native:iotsitewise:GatewayGreengrassV2","description":"A gateway that runs on AWS IoT Greengrass V2."},"siemensIe":{"$ref":"#/types/aws-native:iotsitewise:GatewaySiemensIe","description":"A gateway that runs on Siemens Industrial Edge."}},"type":"object"},"aws-native:iotsitewise:GatewaySiemensIe":{"description":"Contains the IotCoreThingName of AWS IoT Thing that the gateway runs on.","properties":{"iotCoreThingName":{"type":"string","description":"The name of the IoT Core Thing."}},"type":"object","required":["iotCoreThingName"]},"aws-native:iotsitewise:GatewayTag":{"description":"To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted","properties":{"key":{"type":"string","description":"The key or name that identifies the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:iotsitewise:PortalTag":{"description":"To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted.","properties":{"key":{"type":"string","description":"The key or name that identifies the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:iotsitewise:PortalType":{"description":"The type of portal","type":"string","enum":[{"name":"SitewisePortalV1","value":"SITEWISE_PORTAL_V1"},{"name":"SitewisePortalV2","value":"SITEWISE_PORTAL_V2"}]},"aws-native:iotsitewise:PortalTypeEntry":{"description":"Container associated a certain PortalType.","properties":{"portalTools":{"type":"array","items":{"type":"string"},"description":"The array of tools associated with the specified portal type. The possible values are `ASSISTANT` and `DASHBOARD` ."}},"type":"object","required":["portalTools"]},"aws-native:iotsitewise:ProjectTag":{"description":"To add or update tag, provide both key and value. To delete tag, provide only tag key to be deleted","properties":{"key":{"type":"string","description":"The key or name that identifies the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:iottwinmaker:ComponentTypeCompositeComponentType":{"description":"An object that sets information about a composite component type.","properties":{"componentTypeId":{"type":"string","description":"The id of the composite component type."}},"type":"object"},"aws-native:iottwinmaker:ComponentTypeDataConnector":{"description":"The data connector.","properties":{"isNative":{"type":"boolean","description":"A Boolean value that specifies whether the data connector is native to IoT TwinMaker."},"lambda":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeLambdaFunction","description":"The Lambda function associated with this data connector."}},"type":"object"},"aws-native:iottwinmaker:ComponentTypeDataType":{"description":"An object that specifies the data type of a property.","properties":{"allowedValues":{"type":"array","items":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeDataValue"},"description":"The allowed values for this data type."},"nestedType":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeDataType","description":"The nested type in the data type."},"relationship":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeRelationship","description":"A relationship that associates a component with another component."},"type":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeDataTypeType","description":"The underlying type of the data type."},"unitOfMeasure":{"type":"string","description":"The unit of measure used in this data type."}},"type":"object","required":["type"]},"aws-native:iottwinmaker:ComponentTypeDataTypeType":{"description":"The underlying type of the data type.","type":"string","enum":[{"name":"Relationship","value":"RELATIONSHIP"},{"name":"String","value":"STRING"},{"name":"Long","value":"LONG"},{"name":"Boolean","value":"BOOLEAN"},{"name":"Integer","value":"INTEGER"},{"name":"Double","value":"DOUBLE"},{"name":"List","value":"LIST"},{"name":"Map","value":"MAP"}]},"aws-native:iottwinmaker:ComponentTypeDataValue":{"description":"An object that specifies a value for a property.","properties":{"booleanValue":{"type":"boolean","description":"A Boolean value."},"doubleValue":{"type":"number","description":"A double value."},"expression":{"type":"string","description":"An expression that produces the value."},"integerValue":{"type":"integer","description":"An integer value."},"listValue":{"type":"array","items":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeDataValue"},"description":"A list of multiple values."},"longValue":{"type":"number","description":"A long value."},"mapValue":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeDataValue"},"description":"An object that maps strings to multiple DataValue objects. \n\n"},"relationshipValue":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeDataValueRelationshipValueProperties","description":"A value that relates a component to another component."},"stringValue":{"type":"string","description":"A string value."}},"type":"object"},"aws-native:iottwinmaker:ComponentTypeDataValueRelationshipValueProperties":{"description":"A value that relates a component to another component.","properties":{"targetComponentName":{"type":"string"},"targetEntityId":{"type":"string"}},"type":"object"},"aws-native:iottwinmaker:ComponentTypeFunction":{"description":"The function of component type.","properties":{"implementedBy":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeDataConnector","description":"The data connector."},"requiredProperties":{"type":"array","items":{"type":"string"},"description":"The required properties of the function."},"scope":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeFunctionScope","description":"The scope of the function."}},"type":"object"},"aws-native:iottwinmaker:ComponentTypeFunctionScope":{"description":"The scope of the function.","type":"string","enum":[{"name":"Entity","value":"ENTITY"},{"name":"Workspace","value":"WORKSPACE"}]},"aws-native:iottwinmaker:ComponentTypeLambdaFunction":{"properties":{"arn":{"type":"string"}},"type":"object","required":["arn"]},"aws-native:iottwinmaker:ComponentTypePropertyDefinition":{"description":"An object that sets information about a property.","properties":{"configurations":{"type":"object","additionalProperties":{"type":"string"},"description":"An object that specifies information about a property."},"dataType":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeDataType","description":"An object that contains information about the data type."},"defaultValue":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeDataValue","description":"An object that contains the default value."},"isExternalId":{"type":"boolean","description":"A Boolean value that specifies whether the property ID comes from an external data store."},"isRequiredInEntity":{"type":"boolean","description":"A Boolean value that specifies whether the property is required."},"isStoredExternally":{"type":"boolean","description":"A Boolean value that specifies whether the property is stored externally."},"isTimeSeries":{"type":"boolean","description":"A Boolean value that specifies whether the property consists of time series data."}},"type":"object"},"aws-native:iottwinmaker:ComponentTypePropertyGroup":{"description":"An object that sets information about a property group.","properties":{"groupType":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypePropertyGroupGroupType","description":"The type of property group."},"propertyNames":{"type":"array","items":{"type":"string"},"description":"The list of property names in the property group."}},"type":"object"},"aws-native:iottwinmaker:ComponentTypePropertyGroupGroupType":{"description":"The type of property group.","type":"string","enum":[{"name":"Tabular","value":"TABULAR"}]},"aws-native:iottwinmaker:ComponentTypeRelationship":{"description":"The type of the relationship.","properties":{"relationshipType":{"type":"string","description":"The type of the relationship."},"targetComponentTypeId":{"type":"string","description":"The ID of the target component type associated with this relationship."}},"type":"object"},"aws-native:iottwinmaker:ComponentTypeStatus":{"properties":{"error":{"oneOf":[{"$ref":"pulumi.json#/Any"},{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeStatusErrorProperties"}],"description":"The component type error."},"state":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeStatusState","description":"The component type status state."}},"type":"object"},"aws-native:iottwinmaker:ComponentTypeStatusError1Properties":{"description":"Error object with Message and Code.","properties":{"code":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeStatusError1PropertiesCode"},"message":{"type":"string"}},"type":"object"},"aws-native:iottwinmaker:ComponentTypeStatusError1PropertiesCode":{"type":"string","enum":[{"name":"ValidationError","value":"VALIDATION_ERROR"},{"name":"InternalFailure","value":"INTERNAL_FAILURE"}]},"aws-native:iottwinmaker:ComponentTypeStatusErrorProperties":{"description":"Error object with Message and Code.","properties":{"code":{"$ref":"#/types/aws-native:iottwinmaker:ComponentTypeStatusErrorPropertiesCode"},"message":{"type":"string"}},"type":"object"},"aws-native:iottwinmaker:ComponentTypeStatusErrorPropertiesCode":{"type":"string","enum":[{"name":"ValidationError","value":"VALIDATION_ERROR"},{"name":"InternalFailure","value":"INTERNAL_FAILURE"}]},"aws-native:iottwinmaker:ComponentTypeStatusState":{"description":"The component type status state.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"Active","value":"ACTIVE"},{"name":"Error","value":"ERROR"}]},"aws-native:iottwinmaker:EntityComponent":{"properties":{"componentName":{"type":"string","description":"The name of the component."},"componentTypeId":{"type":"string","description":"The ID of the component type."},"definedIn":{"type":"string","description":"The name of the property definition set in the component."},"description":{"type":"string","description":"The description of the component."},"properties":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:iottwinmaker:EntityProperty"},"description":"An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object."},"propertyGroups":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:iottwinmaker:EntityPropertyGroup"},"description":"An object that maps strings to the property groups to set in the component type. Each string in the mapping must be unique to this object."},"status":{"$ref":"#/types/aws-native:iottwinmaker:EntityStatus","description":"The current status of the entity."}},"type":"object"},"aws-native:iottwinmaker:EntityCompositeComponent":{"properties":{"componentName":{"type":"string","description":"The name of the component."},"componentPath":{"type":"string","description":"The path of the component."},"componentTypeId":{"type":"string","description":"The ID of the component type."},"description":{"type":"string","description":"The description of the component."},"properties":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:iottwinmaker:EntityProperty"},"description":"An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object."},"propertyGroups":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:iottwinmaker:EntityPropertyGroup"},"description":"An object that maps strings to the property groups to set in the component type. Each string in the mapping must be unique to this object."},"status":{"$ref":"#/types/aws-native:iottwinmaker:EntityStatus","description":"The current status of the component."}},"type":"object"},"aws-native:iottwinmaker:EntityDataType":{"description":"An object that specifies the data type of a property.","properties":{"allowedValues":{"type":"array","items":{"$ref":"#/types/aws-native:iottwinmaker:EntityDataValue"},"description":"The allowed values for this data type."},"nestedType":{"$ref":"#/types/aws-native:iottwinmaker:EntityDataType","description":"The nested type in the data type."},"relationship":{"$ref":"#/types/aws-native:iottwinmaker:EntityRelationship","description":"A relationship that associates a component with another component."},"type":{"$ref":"#/types/aws-native:iottwinmaker:EntityDataTypeType","description":"The underlying type of the data type."},"unitOfMeasure":{"type":"string","description":"The unit of measure used in this data type."}},"type":"object"},"aws-native:iottwinmaker:EntityDataTypeType":{"description":"The underlying type of the data type.","type":"string","enum":[{"name":"Relationship","value":"RELATIONSHIP"},{"name":"String","value":"STRING"},{"name":"Long","value":"LONG"},{"name":"Boolean","value":"BOOLEAN"},{"name":"Integer","value":"INTEGER"},{"name":"Double","value":"DOUBLE"},{"name":"List","value":"LIST"},{"name":"Map","value":"MAP"}]},"aws-native:iottwinmaker:EntityDataValue":{"description":"An object that specifies a value for a property.","properties":{"booleanValue":{"type":"boolean","description":"A Boolean value."},"doubleValue":{"type":"number","description":"A double value."},"expression":{"type":"string","description":"An expression that produces the value."},"integerValue":{"type":"integer","description":"An integer value."},"listValue":{"type":"array","items":{"$ref":"#/types/aws-native:iottwinmaker:EntityDataValue"},"description":"A list of multiple values."},"longValue":{"type":"number","description":"A long value."},"mapValue":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:iottwinmaker:EntityDataValue"},"description":"An object that maps strings to multiple DataValue objects."},"relationshipValue":{"$ref":"#/types/aws-native:iottwinmaker:EntityDataValueRelationshipValueProperties","description":"A value that relates a component to another component."},"stringValue":{"type":"string","description":"A string value."}},"type":"object"},"aws-native:iottwinmaker:EntityDataValueRelationshipValueProperties":{"description":"A value that relates a component to another component.","properties":{"targetComponentName":{"type":"string"},"targetEntityId":{"type":"string"}},"type":"object"},"aws-native:iottwinmaker:EntityDefinition":{"description":"An object that specifies information about a property definition.","properties":{"configuration":{"type":"object","additionalProperties":{"type":"string"},"description":"An object that specifies information about a property configuration."},"dataType":{"$ref":"#/types/aws-native:iottwinmaker:EntityDataType","description":"An object that contains information about the data type."},"defaultValue":{"$ref":"#/types/aws-native:iottwinmaker:EntityDataValue","description":"An object that contains the default value."},"isExternalId":{"type":"boolean","description":"A Boolean value that specifies whether the property ID comes from an external data store."},"isFinal":{"type":"boolean","description":"A Boolean value that specifies whether the property definition can be updated."},"isImported":{"type":"boolean","description":"A Boolean value that specifies whether the property definition is imported from an external data store."},"isInherited":{"type":"boolean","description":"A Boolean value that specifies whether the property definition is inherited from a parent entity."},"isRequiredInEntity":{"type":"boolean","description":"A Boolean value that specifies whether the property is required."},"isStoredExternally":{"type":"boolean","description":"A Boolean value that specifies whether the property is stored externally."},"isTimeSeries":{"type":"boolean","description":"A Boolean value that specifies whether the property consists of time series data."}},"type":"object"},"aws-native:iottwinmaker:EntityProperty":{"description":"An object that specifies information about a property.","properties":{"definition":{"$ref":"#/types/aws-native:iottwinmaker:EntityDefinition","description":"The definition of the property."},"value":{"$ref":"#/types/aws-native:iottwinmaker:EntityDataValue","description":"The value of the property."}},"type":"object"},"aws-native:iottwinmaker:EntityPropertyGroup":{"description":"An object that specifies information about a property group.","properties":{"groupType":{"$ref":"#/types/aws-native:iottwinmaker:EntityPropertyGroupGroupType","description":"The type of property group."},"propertyNames":{"type":"array","items":{"type":"string"},"description":"The list of property names in the property group."}},"type":"object"},"aws-native:iottwinmaker:EntityPropertyGroupGroupType":{"description":"The type of property group.","type":"string","enum":[{"name":"Tabular","value":"TABULAR"}]},"aws-native:iottwinmaker:EntityRelationship":{"description":"The type of the relationship.","properties":{"relationshipType":{"type":"string","description":"The type of the relationship."},"targetComponentTypeId":{"type":"string","description":"The ID of the target component type associated with this relationship."}},"type":"object"},"aws-native:iottwinmaker:EntityStatus":{"properties":{"error":{"oneOf":[{"$ref":"pulumi.json#/Any"},{"$ref":"#/types/aws-native:iottwinmaker:EntityStatusErrorProperties"}]},"state":{"$ref":"#/types/aws-native:iottwinmaker:EntityStatusState"}},"type":"object"},"aws-native:iottwinmaker:EntityStatusError1Properties":{"description":"Error object with Message and Code.","properties":{"code":{"$ref":"#/types/aws-native:iottwinmaker:EntityStatusError1PropertiesCode"},"message":{"type":"string"}},"type":"object"},"aws-native:iottwinmaker:EntityStatusError1PropertiesCode":{"type":"string","enum":[{"name":"ValidationError","value":"VALIDATION_ERROR"},{"name":"InternalFailure","value":"INTERNAL_FAILURE"}]},"aws-native:iottwinmaker:EntityStatusErrorProperties":{"description":"Error object with Message and Code.","properties":{"code":{"$ref":"#/types/aws-native:iottwinmaker:EntityStatusErrorPropertiesCode"},"message":{"type":"string"}},"type":"object"},"aws-native:iottwinmaker:EntityStatusErrorPropertiesCode":{"type":"string","enum":[{"name":"ValidationError","value":"VALIDATION_ERROR"},{"name":"InternalFailure","value":"INTERNAL_FAILURE"}]},"aws-native:iottwinmaker:EntityStatusState":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"Active","value":"ACTIVE"},{"name":"Error","value":"ERROR"}]},"aws-native:iotwireless:DestinationExpressionType":{"description":"Must be RuleName","type":"string","enum":[{"name":"RuleName","value":"RuleName"},{"name":"MqttTopic","value":"MqttTopic"},{"name":"SnsTopic","value":"SnsTopic"}]},"aws-native:iotwireless:DestinationTag":{"properties":{"key":{"type":"string","description":"The tag's key value."},"value":{"type":"string","description":"The tag's value."}},"type":"object"},"aws-native:iotwireless:DeviceProfileLoRaWanDeviceProfile":{"properties":{"classBTimeout":{"type":"integer","description":"The ClassBTimeout value."},"classCTimeout":{"type":"integer","description":"The ClassCTimeout value."},"factoryPresetFreqsList":{"type":"array","items":{"type":"integer"},"description":"The list of values that make up the FactoryPresetFreqs value. Valid range of values include a minimum value of 1000000 and a maximum value of 16700000."},"macVersion":{"type":"string","description":"The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile."},"maxDutyCycle":{"type":"integer","description":"The MaxDutyCycle value."},"maxEirp":{"type":"integer","description":"The MaxEIRP value."},"pingSlotDr":{"type":"integer","description":"The PingSlotDR value."},"pingSlotFreq":{"type":"integer","description":"The PingSlotFreq value."},"pingSlotPeriod":{"type":"integer","description":"The PingSlotPeriod value."},"regParamsRevision":{"type":"string","description":"The version of regional parameters."},"rfRegion":{"type":"string","description":"The frequency band (RFRegion) value."},"rxDataRate2":{"type":"integer","description":"The RXDataRate2 value."},"rxDelay1":{"type":"integer","description":"The RXDelay1 value."},"rxDrOffset1":{"type":"integer","description":"The RXDROffset1 value."},"rxFreq2":{"type":"integer","description":"The RXFreq2 value."},"supports32BitFCnt":{"type":"boolean","description":"The Supports32BitFCnt value."},"supportsClassB":{"type":"boolean","description":"The SupportsClassB value."},"supportsClassC":{"type":"boolean","description":"The SupportsClassC value."},"supportsJoin":{"type":"boolean","description":"The SupportsJoin value."}},"type":"object"},"aws-native:iotwireless:DeviceProfileTag":{"properties":{"key":{"type":"string","description":"The tag's key value."},"value":{"type":"string","description":"The tag's value."}},"type":"object"},"aws-native:iotwireless:FuotaTaskLoRaWan":{"properties":{"rfRegion":{"type":"string","description":"FUOTA task LoRaWAN RF region"},"startTime":{"type":"string","description":"FUOTA task LoRaWAN start time"}},"type":"object","required":["rfRegion"]},"aws-native:iotwireless:FuotaTaskTag":{"properties":{"key":{"type":"string","description":"The tag's key value."},"value":{"type":"string","description":"The tag's value."}},"type":"object"},"aws-native:iotwireless:MulticastGroupLoRaWan":{"properties":{"dlClass":{"type":"string","description":"Multicast group LoRaWAN DL Class"},"numberOfDevicesInGroup":{"type":"integer","description":"Multicast group number of devices in group. Returned after successful read."},"numberOfDevicesRequested":{"type":"integer","description":"Multicast group number of devices requested. Returned after successful read."},"rfRegion":{"type":"string","description":"Multicast group LoRaWAN RF region"}},"type":"object","required":["dlClass","rfRegion"]},"aws-native:iotwireless:MulticastGroupTag":{"properties":{"key":{"type":"string","description":"The tag's key value."},"value":{"type":"string","description":"The tag's value."}},"type":"object"},"aws-native:iotwireless:NetworkAnalyzerConfigurationLogLevel":{"type":"string","enum":[{"name":"Info","value":"INFO"},{"name":"Error","value":"ERROR"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:iotwireless:NetworkAnalyzerConfigurationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:iotwireless:NetworkAnalyzerConfigurationWirelessDeviceFrameInfo":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:iotwireless:ServiceProfileLoRaWanServiceProfile":{"properties":{"addGwMetadata":{"type":"boolean","description":"The AddGWMetaData value."},"channelMask":{"type":"string","description":"The ChannelMask value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"devStatusReqFreq":{"type":"integer","description":"The DevStatusReqFreq value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"dlBucketSize":{"type":"integer","description":"The DLBucketSize value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"dlRate":{"type":"integer","description":"The DLRate value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"dlRatePolicy":{"type":"string","description":"The DLRatePolicy value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"drMax":{"type":"integer","description":"The DRMax value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"drMin":{"type":"integer","description":"The DRMin value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"hrAllowed":{"type":"boolean","description":"The HRAllowed value that describes whether handover roaming is allowed.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"minGwDiversity":{"type":"integer","description":"The MinGwDiversity value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"nwkGeoLoc":{"type":"boolean","description":"The NwkGeoLoc value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"prAllowed":{"type":"boolean","description":"The PRAllowed value that describes whether passive roaming is allowed.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"raAllowed":{"type":"boolean","description":"The RAAllowed value that describes whether roaming activation is allowed."},"reportDevStatusBattery":{"type":"boolean","description":"The ReportDevStatusBattery value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"reportDevStatusMargin":{"type":"boolean","description":"The ReportDevStatusMargin value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"targetPer":{"type":"integer","description":"The TargetPer value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"ulBucketSize":{"type":"integer","description":"The UlBucketSize value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"ulRate":{"type":"integer","description":"The ULRate value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"},"ulRatePolicy":{"type":"string","description":"The ULRatePolicy value.\n\nThis property is `ReadOnly` and can't be inputted for create. It's returned with `Fn::GetAtt`"}},"type":"object"},"aws-native:iotwireless:ServiceProfileTag":{"properties":{"key":{"type":"string","description":"The tag's key value."},"value":{"type":"string","description":"The tag's value."}},"type":"object"},"aws-native:iotwireless:TaskDefinitionLoRaWanGatewayVersion":{"properties":{"model":{"type":"string","description":"The model number of the wireless gateway."},"packageVersion":{"type":"string","description":"The version of the wireless gateway firmware."},"station":{"type":"string","description":"The basic station version of the wireless gateway."}},"type":"object"},"aws-native:iotwireless:TaskDefinitionLoRaWanUpdateGatewayTaskCreate":{"properties":{"currentVersion":{"$ref":"#/types/aws-native:iotwireless:TaskDefinitionLoRaWanGatewayVersion","description":"The version of the gateways that should receive the update."},"sigKeyCrc":{"type":"integer","description":"The CRC of the signature private key to check."},"updateSignature":{"type":"string","description":"The signature used to verify the update firmware."},"updateVersion":{"$ref":"#/types/aws-native:iotwireless:TaskDefinitionLoRaWanGatewayVersion","description":"The firmware version to update the gateway to."}},"type":"object"},"aws-native:iotwireless:TaskDefinitionLoRaWanUpdateGatewayTaskEntry":{"properties":{"currentVersion":{"$ref":"#/types/aws-native:iotwireless:TaskDefinitionLoRaWanGatewayVersion","description":"The version of the gateways that should receive the update."},"updateVersion":{"$ref":"#/types/aws-native:iotwireless:TaskDefinitionLoRaWanGatewayVersion","description":"The firmware version to update the gateway to."}},"type":"object"},"aws-native:iotwireless:TaskDefinitionTag":{"properties":{"key":{"type":"string","description":"The tag's key value."},"value":{"type":"string","description":"The tag's value."}},"type":"object"},"aws-native:iotwireless:TaskDefinitionType":{"description":"A filter to list only the wireless gateway task definitions that use this task definition type","type":"string","enum":[{"name":"Update","value":"UPDATE"}]},"aws-native:iotwireless:TaskDefinitionUpdateWirelessGatewayTaskCreate":{"properties":{"loRaWan":{"$ref":"#/types/aws-native:iotwireless:TaskDefinitionLoRaWanUpdateGatewayTaskCreate","description":"The properties that relate to the LoRaWAN wireless gateway."},"updateDataRole":{"type":"string","description":"The IAM role used to read data from the S3 bucket."},"updateDataSource":{"type":"string","description":"The link to the S3 bucket."}},"type":"object"},"aws-native:iotwireless:TraceContentProperties":{"description":"Trace content for your wireless gateway and wireless device resources","properties":{"logLevel":{"$ref":"#/types/aws-native:iotwireless:NetworkAnalyzerConfigurationLogLevel","description":"The log level for a log message. The log levels can be disabled, or set to `ERROR` to display less verbose logs containing only error information, or to `INFO` for more detailed logs"},"wirelessDeviceFrameInfo":{"$ref":"#/types/aws-native:iotwireless:NetworkAnalyzerConfigurationWirelessDeviceFrameInfo","description":"`FrameInfo` of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server."}},"type":"object"},"aws-native:iotwireless:WirelessDeviceAbpV10x":{"properties":{"devAddr":{"type":"string","description":"The DevAddr value."},"sessionKeys":{"$ref":"#/types/aws-native:iotwireless:WirelessDeviceSessionKeysAbpV10x","description":"Session keys for ABP v1.0.x."}},"type":"object","required":["devAddr","sessionKeys"]},"aws-native:iotwireless:WirelessDeviceAbpV11":{"properties":{"devAddr":{"type":"string","description":"The DevAddr value."},"sessionKeys":{"$ref":"#/types/aws-native:iotwireless:WirelessDeviceSessionKeysAbpV11","description":"Session keys for ABP v1.1."}},"type":"object","required":["devAddr","sessionKeys"]},"aws-native:iotwireless:WirelessDeviceApplication":{"description":"LoRaWAN application configuration, which can be used to perform geolocation.","properties":{"destinationName":{"type":"string","description":"The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN."},"fPort":{"type":"integer","description":"The Fport value."},"type":{"$ref":"#/types/aws-native:iotwireless:WirelessDeviceApplicationType","description":"Application type, which can be specified to obtain real-time position information of your LoRaWAN device."}},"type":"object"},"aws-native:iotwireless:WirelessDeviceApplicationType":{"description":"Application type, which can be specified to obtain real-time position information of your LoRaWAN device.","type":"string","enum":[{"name":"SemtechGeolocation","value":"SemtechGeolocation"},{"name":"SemtechGnss","value":"SemtechGNSS"},{"name":"SemtechGnssng","value":"SemtechGNSSNG"},{"name":"SemtechWiFi","value":"SemtechWiFi"}]},"aws-native:iotwireless:WirelessDeviceFPorts":{"properties":{"applications":{"type":"array","items":{"$ref":"#/types/aws-native:iotwireless:WirelessDeviceApplication"},"description":"A list of optional LoRaWAN application information, which can be used for geolocation."}},"type":"object"},"aws-native:iotwireless:WirelessDeviceLoRaWanDevice":{"properties":{"abpV10x":{"$ref":"#/types/aws-native:iotwireless:WirelessDeviceAbpV10x","description":"ABP device object for LoRaWAN specification v1.0.x."},"abpV11":{"$ref":"#/types/aws-native:iotwireless:WirelessDeviceAbpV11","description":"ABP device object for create APIs for v1.1."},"devEui":{"type":"string","description":"The DevEUI value."},"deviceProfileId":{"type":"string","description":"The ID of the device profile for the new wireless device."},"fPorts":{"$ref":"#/types/aws-native:iotwireless:WirelessDeviceFPorts","description":"List of FPort assigned for different LoRaWAN application packages to use."},"otaaV10x":{"$ref":"#/types/aws-native:iotwireless:WirelessDeviceOtaaV10x","description":"OTAA device object for create APIs for v1.0.x"},"otaaV11":{"$ref":"#/types/aws-native:iotwireless:WirelessDeviceOtaaV11","description":"OTAA device object for v1.1 for create APIs."},"serviceProfileId":{"type":"string","description":"The ID of the service profile."}},"type":"object"},"aws-native:iotwireless:WirelessDeviceOtaaV10x":{"properties":{"appEui":{"type":"string","description":"The AppEUI value. You specify this value when using LoRaWAN versions v1.0.2 or v1.0.3."},"appKey":{"type":"string","description":"The AppKey value."}},"type":"object","required":["appEui","appKey"]},"aws-native:iotwireless:WirelessDeviceOtaaV11":{"properties":{"appKey":{"type":"string","description":"The AppKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the AppKey value by storing it in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value."},"joinEui":{"type":"string","description":"The JoinEUI value."},"nwkKey":{"type":"string","description":"The NwkKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the NwkKey value by storing it in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value."}},"type":"object","required":["appKey","joinEui","nwkKey"]},"aws-native:iotwireless:WirelessDevicePositioning":{"description":"FPort values for the GNSS, stream, and ClockSync functions of the positioning information.","type":"string","enum":[{"name":"Enabled","value":"Enabled"},{"name":"Disabled","value":"Disabled"}]},"aws-native:iotwireless:WirelessDeviceSessionKeysAbpV10x":{"properties":{"appSKey":{"type":"string","description":"The AppSKey value."},"nwkSKey":{"type":"string","description":"The NwkKey value."}},"type":"object","required":["appSKey","nwkSKey"]},"aws-native:iotwireless:WirelessDeviceSessionKeysAbpV11":{"properties":{"appSKey":{"type":"string","description":"The AppSKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the AppSKey value by storing it in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value."},"fNwkSIntKey":{"type":"string","description":"The FNwkSIntKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the FNwkSIntKey value by storing it in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value."},"nwkSEncKey":{"type":"string","description":"The NwkSEncKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the NwkSEncKey value by storing it in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value."},"sNwkSIntKey":{"type":"string","description":"The SNwkSIntKey is a secret key, which you should handle in a similar way as you would an application password. You can protect the SNwkSIntKey value by storing it in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value."}},"type":"object","required":["appSKey","fNwkSIntKey","nwkSEncKey","sNwkSIntKey"]},"aws-native:iotwireless:WirelessDeviceTag":{"properties":{"key":{"type":"string","description":"The tag's key value."},"value":{"type":"string","description":"The tag's value."}},"type":"object"},"aws-native:iotwireless:WirelessDeviceType":{"description":"Wireless device type, currently only Sidewalk and LoRa","type":"string","enum":[{"name":"Sidewalk","value":"Sidewalk"},{"name":"LoRaWan","value":"LoRaWAN"}]},"aws-native:iotwireless:WirelessGatewayLoRaWanGateway":{"properties":{"gatewayEui":{"type":"string","description":"The gateway's EUI value."},"rfRegion":{"type":"string","description":"The frequency band (RFRegion) value."}},"type":"object","required":["gatewayEui","rfRegion"]},"aws-native:iotwireless:WirelessGatewayTag":{"properties":{"key":{"type":"string","description":"The tag's key value."},"value":{"type":"string","description":"The tag's value."}},"type":"object"},"aws-native:ivs:ChannelContainerFormat":{"description":"Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.","type":"string","enum":[{"name":"Ts","value":"TS"},{"name":"FragmentedMp4","value":"FRAGMENTED_MP4"}]},"aws-native:ivs:ChannelLatencyMode":{"description":"Channel latency mode.","type":"string","enum":[{"name":"Normal","value":"NORMAL"},{"name":"Low","value":"LOW"}]},"aws-native:ivs:ChannelMultitrackInputConfiguration":{"properties":{"enabled":{"type":"boolean","description":"Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false."},"maximumResolution":{"$ref":"#/types/aws-native:ivs:ChannelMultitrackInputConfigurationMaximumResolution","description":"Maximum resolution for multitrack input. Required if enabled is true."},"policy":{"$ref":"#/types/aws-native:ivs:ChannelMultitrackInputConfigurationPolicy","description":"Indicates whether multitrack input is allowed or required. Required if enabled is true."}},"type":"object"},"aws-native:ivs:ChannelMultitrackInputConfigurationMaximumResolution":{"description":"Maximum resolution for multitrack input. Required if enabled is true.","type":"string","enum":[{"name":"Sd","value":"SD"},{"name":"Hd","value":"HD"},{"name":"FullHd","value":"FULL_HD"}]},"aws-native:ivs:ChannelMultitrackInputConfigurationPolicy":{"description":"Indicates whether multitrack input is allowed or required. Required if enabled is true.","type":"string","enum":[{"name":"Allow","value":"ALLOW"},{"name":"Require","value":"REQUIRE"}]},"aws-native:ivs:ChannelPreset":{"description":"Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (\"\").","type":"string","enum":[{"name":"Empty","value":""},{"name":"HigherBandwidthDelivery","value":"HIGHER_BANDWIDTH_DELIVERY"},{"name":"ConstrainedBandwidthDelivery","value":"CONSTRAINED_BANDWIDTH_DELIVERY"}]},"aws-native:ivs:ChannelTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ivs:ChannelType":{"description":"Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.","type":"string","enum":[{"name":"Standard","value":"STANDARD"},{"name":"Basic","value":"BASIC"},{"name":"AdvancedSd","value":"ADVANCED_SD"},{"name":"AdvancedHd","value":"ADVANCED_HD"}]},"aws-native:ivs:EncoderConfigurationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ivs:IngestConfigurationIngestProtocol":{"description":"Ingest Protocol.","type":"string","enum":[{"name":"Rtmp","value":"RTMP"},{"name":"Rtmps","value":"RTMPS"}]},"aws-native:ivs:IngestConfigurationState":{"description":"State of IngestConfiguration which determines whether IngestConfiguration is in use or not.","type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Inactive","value":"INACTIVE"}]},"aws-native:ivs:IngestConfigurationTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ivs:PlaybackKeyPairTag":{"properties":{"key":{"type":"string","description":"One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor within a tag category (key)."}},"type":"object","required":["key","value"]},"aws-native:ivs:PlaybackRestrictionPolicyTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ivs:PublicKeyTag":{"properties":{"key":{"type":"string","description":"One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values."},"value":{"type":"string","description":"The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor within a tag category (key)."}},"type":"object","required":["key","value"]},"aws-native:ivs:RecordingConfigurationDestinationConfiguration":{"description":"Recording Destination Configuration.","properties":{"s3":{"$ref":"#/types/aws-native:ivs:RecordingConfigurationS3DestinationConfiguration","description":"An S3 destination configuration where recorded videos will be stored. See the [S3DestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-s3destinationconfiguration.html) property type for more information.","replaceOnChanges":true}},"type":"object"},"aws-native:ivs:RecordingConfigurationRenditionConfiguration":{"description":"Rendition Configuration describes which renditions should be recorded for a stream.","properties":{"renditionSelection":{"$ref":"#/types/aws-native:ivs:RecordingConfigurationRenditionConfigurationRenditionSelection","description":"Resolution Selection indicates which set of renditions are recorded for a stream.","replaceOnChanges":true},"renditions":{"type":"array","items":{"$ref":"#/types/aws-native:ivs:RecordingConfigurationRenditionConfigurationRenditionsItem"},"description":"Renditions indicates which renditions are recorded for a stream.","replaceOnChanges":true}},"type":"object"},"aws-native:ivs:RecordingConfigurationRenditionConfigurationRenditionSelection":{"description":"Resolution Selection indicates which set of renditions are recorded for a stream.","type":"string","enum":[{"name":"All","value":"ALL"},{"name":"None","value":"NONE"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:ivs:RecordingConfigurationRenditionConfigurationRenditionsItem":{"type":"string","enum":[{"name":"FullHd","value":"FULL_HD"},{"name":"Hd","value":"HD"},{"name":"Sd","value":"SD"},{"name":"LowestResolution","value":"LOWEST_RESOLUTION"}]},"aws-native:ivs:RecordingConfigurationS3DestinationConfiguration":{"description":"Recording S3 Destination Configuration.","properties":{"bucketName":{"type":"string","description":"Location (S3 bucket name) where recorded videos will be stored.","replaceOnChanges":true}},"type":"object","required":["bucketName"]},"aws-native:ivs:RecordingConfigurationState":{"description":"Recording Configuration State.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"Active","value":"ACTIVE"}]},"aws-native:ivs:RecordingConfigurationTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ivs:RecordingConfigurationThumbnailConfiguration":{"description":"Recording Thumbnail Configuration.","properties":{"recordingMode":{"$ref":"#/types/aws-native:ivs:RecordingConfigurationThumbnailConfigurationRecordingMode","description":"Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled.","replaceOnChanges":true},"resolution":{"$ref":"#/types/aws-native:ivs:RecordingConfigurationThumbnailConfigurationResolution","description":"Resolution indicates the desired resolution of recorded thumbnails.","replaceOnChanges":true},"storage":{"type":"array","items":{"$ref":"#/types/aws-native:ivs:RecordingConfigurationThumbnailConfigurationStorageItem"},"description":"Storage indicates the format in which thumbnails are recorded.","replaceOnChanges":true},"targetIntervalSeconds":{"type":"integer","description":"Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL.","replaceOnChanges":true}},"type":"object"},"aws-native:ivs:RecordingConfigurationThumbnailConfigurationRecordingMode":{"description":"Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled.","type":"string","enum":[{"name":"Interval","value":"INTERVAL"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:ivs:RecordingConfigurationThumbnailConfigurationResolution":{"description":"Resolution indicates the desired resolution of recorded thumbnails.","type":"string","enum":[{"name":"FullHd","value":"FULL_HD"},{"name":"Hd","value":"HD"},{"name":"Sd","value":"SD"},{"name":"LowestResolution","value":"LOWEST_RESOLUTION"}]},"aws-native:ivs:RecordingConfigurationThumbnailConfigurationStorageItem":{"type":"string","enum":[{"name":"Sequential","value":"SEQUENTIAL"},{"name":"Latest","value":"LATEST"}]},"aws-native:ivs:StageAutoParticipantRecordingConfiguration":{"description":"Configuration object for individual participant recording, to attach to the new stage.","properties":{"hlsConfiguration":{"$ref":"#/types/aws-native:ivs:StageHlsConfiguration","description":"HLS configuration object for individual participant recording."},"mediaTypes":{"type":"array","items":{"$ref":"#/types/aws-native:ivs:StageAutoParticipantRecordingConfigurationMediaTypesItem"},"description":"Types of media to be recorded. Default: AUDIO_VIDEO."},"recordingReconnectWindowSeconds":{"type":"integer","description":"If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together. The default value is 0, which disables merging."},"storageConfigurationArn":{"type":"string","description":"ARN of the StorageConfiguration resource to use for individual participant recording."},"thumbnailConfiguration":{"$ref":"#/types/aws-native:ivs:StageThumbnailConfiguration","description":"A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session."}},"type":"object","required":["storageConfigurationArn"]},"aws-native:ivs:StageAutoParticipantRecordingConfigurationMediaTypesItem":{"type":"string","enum":[{"name":"AudioVideo","value":"AUDIO_VIDEO"},{"name":"AudioOnly","value":"AUDIO_ONLY"}]},"aws-native:ivs:StageHlsConfiguration":{"description":"HLS configuration object for individual participant recording.","properties":{"participantRecordingHlsConfiguration":{"$ref":"#/types/aws-native:ivs:StageParticipantRecordingHlsConfiguration","description":"Object specifying a configuration of participant HLS recordings for individual participant recording."}},"type":"object"},"aws-native:ivs:StageParticipantRecordingHlsConfiguration":{"description":"An object representing a configuration of participant HLS recordings for individual participant recording.","properties":{"targetSegmentDurationSeconds":{"type":"integer","description":"Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6."}},"type":"object"},"aws-native:ivs:StageTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ivs:StageThumbnailConfiguration":{"description":"A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.","properties":{"participantThumbnailConfiguration":{"$ref":"#/types/aws-native:ivs:StageThumbnailConfigurationParticipantThumbnailConfigurationProperties","description":"An object representing a configuration of thumbnails for recorded video from an individual participant."}},"type":"object"},"aws-native:ivs:StageThumbnailConfigurationParticipantThumbnailConfigurationProperties":{"description":"An object representing a configuration of thumbnails for recorded video from an individual participant.","properties":{"recordingMode":{"$ref":"#/types/aws-native:ivs:StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesRecordingMode","description":"Thumbnail recording mode. Default: DISABLED."},"storage":{"type":"array","items":{"$ref":"#/types/aws-native:ivs:StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesStorageItem"},"description":"Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL."},"targetIntervalSeconds":{"type":"integer","description":"The targeted thumbnail-generation interval in seconds. This is configurable only if recordingMode is INTERVAL. Default: 60."}},"type":"object"},"aws-native:ivs:StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesRecordingMode":{"description":"Thumbnail recording mode. Default: DISABLED.","type":"string","enum":[{"name":"Interval","value":"INTERVAL"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:ivs:StageThumbnailConfigurationParticipantThumbnailConfigurationPropertiesStorageItem":{"type":"string","enum":[{"name":"Sequential","value":"SEQUENTIAL"},{"name":"Latest","value":"LATEST"}]},"aws-native:ivs:StorageConfigurationS3StorageConfiguration":{"description":"A complex type that describes an S3 location where recorded videos will be stored.","properties":{"bucketName":{"type":"string","description":"Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.","replaceOnChanges":true}},"type":"object","required":["bucketName"]},"aws-native:ivs:StorageConfigurationTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ivs:StreamKeyTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ivs:VideoProperties":{"description":"Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps","properties":{"bitrate":{"type":"integer","description":"Bitrate for generated output, in bps. Default: 2500000.","replaceOnChanges":true},"framerate":{"type":"number","description":"Video frame rate, in fps. Default: 30.","replaceOnChanges":true},"height":{"type":"integer","description":"Video-resolution height. This must be an even number. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.","replaceOnChanges":true},"width":{"type":"integer","description":"Video-resolution width. This must be an even number. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.","replaceOnChanges":true}},"type":"object"},"aws-native:ivschat:LoggingConfigurationCloudWatchLogsDestinationConfiguration":{"description":"CloudWatch destination configuration for IVS Chat logging.","properties":{"logGroupName":{"type":"string","description":"Name of the Amazon CloudWatch Logs log group where chat activity will be logged."}},"type":"object","required":["logGroupName"]},"aws-native:ivschat:LoggingConfigurationDestinationConfiguration":{"description":"Destination configuration for IVS Chat logging.","properties":{"cloudWatchLogs":{"$ref":"#/types/aws-native:ivschat:LoggingConfigurationCloudWatchLogsDestinationConfiguration","description":"An Amazon CloudWatch Logs destination configuration where chat activity will be logged."},"firehose":{"$ref":"#/types/aws-native:ivschat:LoggingConfigurationFirehoseDestinationConfiguration","description":"An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged."},"s3":{"$ref":"#/types/aws-native:ivschat:LoggingConfigurationS3DestinationConfiguration","description":"An Amazon S3 destination configuration where chat activity will be logged."}},"type":"object"},"aws-native:ivschat:LoggingConfigurationFirehoseDestinationConfiguration":{"description":"Kinesis Firehose destination configuration for IVS Chat logging.","properties":{"deliveryStreamName":{"type":"string","description":"Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged."}},"type":"object","required":["deliveryStreamName"]},"aws-native:ivschat:LoggingConfigurationS3DestinationConfiguration":{"description":"S3 destination configuration for IVS Chat logging.","properties":{"bucketName":{"type":"string","description":"Name of the Amazon S3 bucket where chat activity will be logged."}},"type":"object","required":["bucketName"]},"aws-native:ivschat:LoggingConfigurationState":{"description":"The state of the logging configuration. When the state is ACTIVE, the configuration is ready to log chat content.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"Deleting","value":"DELETING"},{"name":"DeleteFailed","value":"DELETE_FAILED"},{"name":"Updating","value":"UPDATING"},{"name":"UpdatingFailed","value":"UPDATING_FAILED"},{"name":"Active","value":"ACTIVE"}]},"aws-native:ivschat:LoggingConfigurationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:ivschat:RoomMessageReviewHandler":{"description":"Configuration information for optional review of messages.","properties":{"fallbackResult":{"$ref":"#/types/aws-native:ivschat:RoomMessageReviewHandlerFallbackResult","description":"Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out."},"uri":{"type":"string","description":"Identifier of the message review handler."}},"type":"object"},"aws-native:ivschat:RoomMessageReviewHandlerFallbackResult":{"description":"Specifies the fallback behavior if the handler does not return a valid response, encounters an error, or times out.","type":"string","enum":[{"name":"Allow","value":"ALLOW"},{"name":"Deny","value":"DENY"}]},"aws-native:ivschat:RoomTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:kafkaconnect:ConnectorApacheKafkaCluster":{"description":"Details of how to connect to an Apache Kafka cluster.","properties":{"bootstrapServers":{"type":"string","description":"The bootstrap servers string of the Apache Kafka cluster."},"vpc":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorVpc","description":"Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster."}},"type":"object","required":["bootstrapServers","vpc"]},"aws-native:kafkaconnect:ConnectorAutoScaling":{"description":"Details about auto scaling of a connector.","properties":{"maxAutoscalingTaskCount":{"type":"integer","description":"The maximum number of tasks allocated to the connector during autoscaling operations."},"maxWorkerCount":{"type":"integer","description":"The maximum number of workers for a connector."},"mcuCount":{"type":"integer","description":"Specifies how many MSK Connect Units (MCU) as the minimum scaling unit."},"minWorkerCount":{"type":"integer","description":"The minimum number of workers for a connector."},"scaleInPolicy":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorScaleInPolicy","description":"The sacle-in policy for the connector."},"scaleOutPolicy":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorScaleOutPolicy","description":"The sacle-out policy for the connector."}},"type":"object","required":["maxWorkerCount","mcuCount","minWorkerCount","scaleInPolicy","scaleOutPolicy"]},"aws-native:kafkaconnect:ConnectorCapacity":{"description":"Information about the capacity allocated to the connector.","properties":{"autoScaling":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorAutoScaling","description":"Information about the auto scaling parameters for the connector."},"provisionedCapacity":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorProvisionedCapacity","description":"Details about a fixed capacity allocated to a connector."}},"type":"object"},"aws-native:kafkaconnect:ConnectorCloudWatchLogsLogDelivery":{"description":"Details about delivering logs to Amazon CloudWatch Logs.","properties":{"enabled":{"type":"boolean","description":"Specifies whether the logs get sent to the specified CloudWatch Logs destination."},"logGroup":{"type":"string","description":"The CloudWatch log group that is the destination for log delivery."}},"type":"object","required":["enabled"]},"aws-native:kafkaconnect:ConnectorCustomPlugin":{"description":"Details about a custom plugin.","properties":{"customPluginArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the custom plugin to use."},"revision":{"type":"integer","description":"The revision of the custom plugin to use."}},"type":"object","required":["customPluginArn","revision"]},"aws-native:kafkaconnect:ConnectorFirehoseLogDelivery":{"description":"Details about delivering logs to Amazon Kinesis Data Firehose.","properties":{"deliveryStream":{"type":"string","description":"The Kinesis Data Firehose delivery stream that is the destination for log delivery."},"enabled":{"type":"boolean","description":"Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream."}},"type":"object","required":["enabled"]},"aws-native:kafkaconnect:ConnectorKafkaCluster":{"description":"Details of how to connect to the Kafka cluster.","properties":{"apacheKafkaCluster":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorApacheKafkaCluster","description":"The Apache Kafka cluster to which the connector is connected."}},"type":"object","required":["apacheKafkaCluster"]},"aws-native:kafkaconnect:ConnectorKafkaClusterClientAuthentication":{"description":"Details of the client authentication used by the Kafka cluster.","properties":{"authenticationType":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorKafkaClusterClientAuthenticationType","description":"The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used."}},"type":"object","required":["authenticationType"]},"aws-native:kafkaconnect:ConnectorKafkaClusterClientAuthenticationType":{"description":"The type of client authentication used to connect to the Kafka cluster. Value NONE means that no client authentication is used.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Iam","value":"IAM"}]},"aws-native:kafkaconnect:ConnectorKafkaClusterEncryptionInTransit":{"description":"Details of encryption in transit to the Kafka cluster.","properties":{"encryptionType":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorKafkaClusterEncryptionInTransitType","description":"The type of encryption in transit to the Apache Kafka cluster."}},"type":"object","required":["encryptionType"]},"aws-native:kafkaconnect:ConnectorKafkaClusterEncryptionInTransitType":{"description":"The type of encryption in transit to the Kafka cluster.","type":"string","enum":[{"name":"Plaintext","value":"PLAINTEXT"},{"name":"Tls","value":"TLS"}]},"aws-native:kafkaconnect:ConnectorLogDelivery":{"description":"Details of what logs are delivered and where they are delivered.","properties":{"workerLogDelivery":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorWorkerLogDelivery","description":"The workers can send worker logs to different destination types. This configuration specifies the details of these destinations."}},"type":"object","required":["workerLogDelivery"]},"aws-native:kafkaconnect:ConnectorNetworkType":{"description":"The network type of the Connector.","type":"string","enum":[{"name":"Ipv4","value":"IPV4"},{"name":"Dual","value":"DUAL"}]},"aws-native:kafkaconnect:ConnectorPlugin":{"description":"Details about a Kafka Connect plugin which will be used with the connector.","properties":{"customPlugin":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorCustomPlugin","description":"Details about a custom plugin."}},"type":"object","required":["customPlugin"]},"aws-native:kafkaconnect:ConnectorProvisionedCapacity":{"description":"Details about a fixed capacity allocated to a connector.","properties":{"mcuCount":{"type":"integer","description":"Specifies how many MSK Connect Units (MCU) are allocated to the connector."},"workerCount":{"type":"integer","description":"Number of workers for a connector."}},"type":"object","required":["workerCount"]},"aws-native:kafkaconnect:ConnectorS3LogDelivery":{"description":"Details about delivering logs to Amazon S3.","properties":{"bucket":{"type":"string","description":"The name of the S3 bucket that is the destination for log delivery."},"enabled":{"type":"boolean","description":"Specifies whether the logs get sent to the specified Amazon S3 destination."},"prefix":{"type":"string","description":"The S3 prefix that is the destination for log delivery."}},"type":"object","required":["enabled"]},"aws-native:kafkaconnect:ConnectorScaleInPolicy":{"description":"Information about the scale in policy of the connector.","properties":{"cpuUtilizationPercentage":{"type":"integer","description":"Specifies the CPU utilization percentage threshold at which connector scale in should trigger."}},"type":"object","required":["cpuUtilizationPercentage"]},"aws-native:kafkaconnect:ConnectorScaleOutPolicy":{"description":"Information about the scale out policy of the connector.","properties":{"cpuUtilizationPercentage":{"type":"integer","description":"Specifies the CPU utilization percentage threshold at which connector scale out should trigger."}},"type":"object","required":["cpuUtilizationPercentage"]},"aws-native:kafkaconnect:ConnectorTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:kafkaconnect:ConnectorVpc":{"description":"Information about a VPC used with the connector.","properties":{"securityGroups":{"type":"array","items":{"type":"string"},"description":"The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to."},"subnets":{"type":"array","items":{"type":"string"},"description":"The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets."}},"type":"object","required":["securityGroups","subnets"]},"aws-native:kafkaconnect:ConnectorWorkerConfiguration":{"description":"Specifies the worker configuration to use with the connector.","properties":{"revision":{"type":"integer","description":"The revision of the worker configuration to use."},"workerConfigurationArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the worker configuration to use."}},"type":"object","required":["revision","workerConfigurationArn"]},"aws-native:kafkaconnect:ConnectorWorkerLogDelivery":{"description":"Specifies where worker logs are delivered.","properties":{"cloudWatchLogs":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorCloudWatchLogsLogDelivery","description":"Details about delivering logs to Amazon CloudWatch Logs."},"firehose":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorFirehoseLogDelivery","description":"Details about delivering logs to Amazon Kinesis Data Firehose."},"s3":{"$ref":"#/types/aws-native:kafkaconnect:ConnectorS3LogDelivery","description":"Details about delivering logs to Amazon S3."}},"type":"object"},"aws-native:kafkaconnect:CustomPluginContentType":{"description":"The type of the plugin file.","type":"string","enum":[{"name":"Jar","value":"JAR"},{"name":"Zip","value":"ZIP"}]},"aws-native:kafkaconnect:CustomPluginFileDescription":{"description":"Details about the custom plugin file.","properties":{"fileMd5":{"type":"string","description":"The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file."},"fileSize":{"type":"integer","description":"The size in bytes of the custom plugin file. You can use it to validate the file."}},"type":"object"},"aws-native:kafkaconnect:CustomPluginLocation":{"description":"Information about the location of a custom plugin.","properties":{"s3Location":{"$ref":"#/types/aws-native:kafkaconnect:CustomPluginS3Location","description":"The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3."}},"type":"object","required":["s3Location"]},"aws-native:kafkaconnect:CustomPluginS3Location":{"description":"The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.","properties":{"bucketArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an S3 bucket."},"fileKey":{"type":"string","description":"The file key for an object in an S3 bucket."},"objectVersion":{"type":"string","description":"The version of an object in an S3 bucket."}},"type":"object","required":["bucketArn","fileKey"]},"aws-native:kafkaconnect:CustomPluginTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:kafkaconnect:WorkerConfigurationTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:kendra:DataSourceAccessControlListConfiguration":{"properties":{"keyPath":{"type":"string","description":"Path to the AWS S3 bucket that contains the access control list files."}},"type":"object"},"aws-native:kendra:DataSourceAclConfiguration":{"properties":{"allowedGroupsColumnName":{"type":"string","description":"A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the `UserContext` field of the [Query](https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html) operation."}},"type":"object","required":["allowedGroupsColumnName"]},"aws-native:kendra:DataSourceColumnConfiguration":{"properties":{"changeDetectingColumns":{"type":"array","items":{"type":"string"},"description":"One to five columns that indicate when a document in the database has changed."},"documentDataColumnName":{"type":"string","description":"The column that contains the contents of the document."},"documentIdColumnName":{"type":"string","description":"The column that provides the document's identifier."},"documentTitleColumnName":{"type":"string","description":"The column that contains the title of the document."},"fieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceToIndexFieldMapping"},"description":"An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateIndex.html) operation."}},"type":"object","required":["changeDetectingColumns","documentDataColumnName","documentIdColumnName"]},"aws-native:kendra:DataSourceConditionOperator":{"type":"string","enum":[{"name":"GreaterThan","value":"GreaterThan"},{"name":"GreaterThanOrEquals","value":"GreaterThanOrEquals"},{"name":"LessThan","value":"LessThan"},{"name":"LessThanOrEquals","value":"LessThanOrEquals"},{"name":"Equals","value":"Equals"},{"name":"NotEquals","value":"NotEquals"},{"name":"Contains","value":"Contains"},{"name":"NotContains","value":"NotContains"},{"name":"Exists","value":"Exists"},{"name":"NotExists","value":"NotExists"},{"name":"BeginsWith","value":"BeginsWith"}]},"aws-native:kendra:DataSourceConfiguration":{"properties":{"confluenceConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceConfluenceConfiguration","description":"Provides the configuration information to connect to Confluence as your data source."},"databaseConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceDatabaseConfiguration","description":"Provides the configuration information to connect to a database as your data source."},"googleDriveConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceGoogleDriveConfiguration","description":"Provides the configuration information to connect to Google Drive as your data source."},"oneDriveConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceOneDriveConfiguration","description":"Provides the configuration information to connect to Microsoft OneDrive as your data source."},"s3Configuration":{"$ref":"#/types/aws-native:kendra:DataSourceS3DataSourceConfiguration","description":"Provides the configuration information to connect to an Amazon S3 bucket as your data source.\n\n\u003e Amazon Kendra now supports an upgraded Amazon S3 connector.\n\u003e \n\u003e You must now use the [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the `S3DataSourceConfiguration` object to configure your connector.\n\u003e \n\u003e Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.\n\u003e \n\u003e We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024."},"salesforceConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceSalesforceConfiguration","description":"Provides the configuration information to connect to Salesforce as your data source."},"serviceNowConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceServiceNowConfiguration","description":"Provides the configuration information to connect to ServiceNow as your data source."},"sharePointConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceSharePointConfiguration","description":"Provides the configuration information to connect to Microsoft SharePoint as your data source."},"templateConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceTemplateConfiguration","description":"Provides a template for the configuration information to connect to your data source."},"webCrawlerConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceWebCrawlerConfiguration","description":"Provides the configuration information required for Amazon Kendra Web Crawler."},"workDocsConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceWorkDocsConfiguration","description":"Provides the configuration information to connect to WorkDocs as your data source."}},"type":"object"},"aws-native:kendra:DataSourceConfluenceAttachmentConfiguration":{"properties":{"attachmentFieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceConfluenceAttachmentToIndexFieldMapping"},"description":"Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Confluence data source field names must exist in your Confluence custom metadata.\n\nIf you specify the `AttachentFieldMappings` parameter, you must specify at least one field mapping."},"crawlAttachments":{"type":"boolean","description":"`TRUE` to index attachments of pages and blogs in Confluence."}},"type":"object"},"aws-native:kendra:DataSourceConfluenceAttachmentFieldName":{"type":"string","enum":[{"name":"Author","value":"AUTHOR"},{"name":"ContentType","value":"CONTENT_TYPE"},{"name":"CreatedDate","value":"CREATED_DATE"},{"name":"DisplayUrl","value":"DISPLAY_URL"},{"name":"FileSize","value":"FILE_SIZE"},{"name":"ItemType","value":"ITEM_TYPE"},{"name":"ParentId","value":"PARENT_ID"},{"name":"SpaceKey","value":"SPACE_KEY"},{"name":"SpaceName","value":"SPACE_NAME"},{"name":"Url","value":"URL"},{"name":"Version","value":"VERSION"}]},"aws-native:kendra:DataSourceConfluenceAttachmentToIndexFieldMapping":{"properties":{"dataSourceFieldName":{"$ref":"#/types/aws-native:kendra:DataSourceConfluenceAttachmentFieldName"},"dateFieldFormat":{"type":"string"},"indexFieldName":{"type":"string"}},"type":"object","required":["dataSourceFieldName","indexFieldName"]},"aws-native:kendra:DataSourceConfluenceBlogConfiguration":{"properties":{"blogFieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceConfluenceBlogToIndexFieldMapping"},"description":"Maps attributes or field names of Confluence blogs to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Confluence data source field names must exist in your Confluence custom metadata.\n\nIf you specify the `BlogFieldMappings` parameter, you must specify at least one field mapping."}},"type":"object"},"aws-native:kendra:DataSourceConfluenceBlogFieldName":{"type":"string","enum":[{"name":"Author","value":"AUTHOR"},{"name":"DisplayUrl","value":"DISPLAY_URL"},{"name":"ItemType","value":"ITEM_TYPE"},{"name":"Labels","value":"LABELS"},{"name":"PublishDate","value":"PUBLISH_DATE"},{"name":"SpaceKey","value":"SPACE_KEY"},{"name":"SpaceName","value":"SPACE_NAME"},{"name":"Url","value":"URL"},{"name":"Version","value":"VERSION"}]},"aws-native:kendra:DataSourceConfluenceBlogToIndexFieldMapping":{"properties":{"dataSourceFieldName":{"$ref":"#/types/aws-native:kendra:DataSourceConfluenceBlogFieldName"},"dateFieldFormat":{"type":"string"},"indexFieldName":{"type":"string"}},"type":"object","required":["dataSourceFieldName","indexFieldName"]},"aws-native:kendra:DataSourceConfluenceConfiguration":{"properties":{"attachmentConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceConfluenceAttachmentConfiguration","description":"Configuration information for indexing attachments to Confluence blogs and pages."},"blogConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceConfluenceBlogConfiguration","description":"Configuration information for indexing Confluence blogs."},"exclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index."},"inclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index."},"pageConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceConfluencePageConfiguration","description":"Configuration information for indexing Confluence pages."},"secretArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence Cloud, you use a generated API token as the password.\n\nYou can also provide authentication credentials in the form of a personal access token. For more information, see [Using a Confluence data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html) ."},"serverUrl":{"type":"string","description":"The URL of your Confluence instance. Use the full URL of the server. For example, *https://server.example.com:port/* . You can also use an IP address, for example, *https://192.168.1.113/* ."},"spaceConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceConfluenceSpaceConfiguration","description":"Configuration information for indexing Confluence spaces."},"version":{"$ref":"#/types/aws-native:kendra:DataSourceConfluenceVersion","description":"The version or the type of Confluence installation to connect to."},"vpcConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceVpcConfiguration","description":"Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) ."}},"type":"object","required":["secretArn","serverUrl","version"]},"aws-native:kendra:DataSourceConfluencePageConfiguration":{"properties":{"pageFieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceConfluencePageToIndexFieldMapping"},"description":"Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Confluence data source field names must exist in your Confluence custom metadata.\n\nIf you specify the `PageFieldMappings` parameter, you must specify at least one field mapping."}},"type":"object"},"aws-native:kendra:DataSourceConfluencePageFieldName":{"type":"string","enum":[{"name":"Author","value":"AUTHOR"},{"name":"ContentStatus","value":"CONTENT_STATUS"},{"name":"CreatedDate","value":"CREATED_DATE"},{"name":"DisplayUrl","value":"DISPLAY_URL"},{"name":"ItemType","value":"ITEM_TYPE"},{"name":"Labels","value":"LABELS"},{"name":"ModifiedDate","value":"MODIFIED_DATE"},{"name":"ParentId","value":"PARENT_ID"},{"name":"SpaceKey","value":"SPACE_KEY"},{"name":"SpaceName","value":"SPACE_NAME"},{"name":"Url","value":"URL"},{"name":"Version","value":"VERSION"}]},"aws-native:kendra:DataSourceConfluencePageToIndexFieldMapping":{"properties":{"dataSourceFieldName":{"$ref":"#/types/aws-native:kendra:DataSourceConfluencePageFieldName"},"dateFieldFormat":{"type":"string"},"indexFieldName":{"type":"string"}},"type":"object","required":["dataSourceFieldName","indexFieldName"]},"aws-native:kendra:DataSourceConfluenceSpaceConfiguration":{"properties":{"crawlArchivedSpaces":{"type":"boolean","description":"`TRUE` to index archived spaces."},"crawlPersonalSpaces":{"type":"boolean","description":"`TRUE` to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see [Filtering on user context](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) ."},"excludeSpaces":{"type":"array","items":{"type":"string"},"description":"A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the `ExcludeSpaces` and the `IncludeSpaces` list, the space is excluded."},"includeSpaces":{"type":"array","items":{"type":"string"},"description":"A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the `IncludeSpaces` and the `ExcludeSpaces` list, the space is excluded."},"spaceFieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceConfluenceSpaceToIndexFieldMapping"},"description":"Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Confluence data source field names must exist in your Confluence custom metadata.\n\nIf you specify the `SpaceFieldMappings` parameter, you must specify at least one field mapping."}},"type":"object"},"aws-native:kendra:DataSourceConfluenceSpaceFieldName":{"type":"string","enum":[{"name":"DisplayUrl","value":"DISPLAY_URL"},{"name":"ItemType","value":"ITEM_TYPE"},{"name":"SpaceKey","value":"SPACE_KEY"},{"name":"Url","value":"URL"}]},"aws-native:kendra:DataSourceConfluenceSpaceToIndexFieldMapping":{"properties":{"dataSourceFieldName":{"$ref":"#/types/aws-native:kendra:DataSourceConfluenceSpaceFieldName"},"dateFieldFormat":{"type":"string"},"indexFieldName":{"type":"string"}},"type":"object","required":["dataSourceFieldName","indexFieldName"]},"aws-native:kendra:DataSourceConfluenceVersion":{"type":"string","enum":[{"name":"Cloud","value":"CLOUD"},{"name":"Server","value":"SERVER"}]},"aws-native:kendra:DataSourceConnectionConfiguration":{"properties":{"databaseHost":{"type":"string","description":"The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address."},"databaseName":{"type":"string","description":"The name of the database containing the document data."},"databasePort":{"type":"integer","description":"The port that the database uses for connections."},"secretArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials. The credentials should be a user-password pair. For more information, see [Using a Database Data Source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html) . For more information about AWS Secrets Manager , see [What Is AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) in the *AWS Secrets Manager* user guide."},"tableName":{"type":"string","description":"The name of the table that contains the document data."}},"type":"object","required":["databaseHost","databaseName","databasePort","secretArn","tableName"]},"aws-native:kendra:DataSourceCustomDocumentEnrichmentConfiguration":{"properties":{"inlineConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceInlineCustomDocumentEnrichmentConfiguration"},"description":"Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra."},"postExtractionHookConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceHookConfiguration","description":"Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see [Advanced data manipulation](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation) ."},"preExtractionHookConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceHookConfiguration","description":"Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see [Advanced data manipulation](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation) ."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an IAM role with permission to run `PreExtractionHookConfiguration` and `PostExtractionHookConfiguration` for altering document metadata and content during the document ingestion process. For more information, see [an IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) ."}},"type":"object"},"aws-native:kendra:DataSourceDatabaseConfiguration":{"properties":{"aclConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceAclConfiguration","description":"Information about the database column that provides information for user context filtering."},"columnConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceColumnConfiguration","description":"Information about where the index should get the document information from the database."},"connectionConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceConnectionConfiguration","description":"Configuration information that's required to connect to a database."},"databaseEngineType":{"$ref":"#/types/aws-native:kendra:DataSourceDatabaseEngineType","description":"The type of database engine that runs the database."},"sqlConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceSqlConfiguration","description":"Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source."},"vpcConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceVpcConfiguration","description":"Provides information for connecting to an Amazon VPC."}},"type":"object","required":["columnConfiguration","connectionConfiguration","databaseEngineType"]},"aws-native:kendra:DataSourceDatabaseEngineType":{"type":"string","enum":[{"name":"RdsAuroraMysql","value":"RDS_AURORA_MYSQL"},{"name":"RdsAuroraPostgresql","value":"RDS_AURORA_POSTGRESQL"},{"name":"RdsMysql","value":"RDS_MYSQL"},{"name":"RdsPostgresql","value":"RDS_POSTGRESQL"}]},"aws-native:kendra:DataSourceDocumentAttributeCondition":{"properties":{"conditionDocumentAttributeKey":{"type":"string","description":"The identifier of the document attribute used for the condition.\n\nFor example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.\n\nAmazon Kendra currently does not support `_document_body` as an attribute key used for the condition."},"conditionOnValue":{"$ref":"#/types/aws-native:kendra:DataSourceDocumentAttributeValue","description":"The value used by the operator.\n\nFor example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value."},"operator":{"$ref":"#/types/aws-native:kendra:DataSourceConditionOperator","description":"The condition operator.\n\nFor example, you can use 'Contains' to partially match a string."}},"type":"object","required":["conditionDocumentAttributeKey","operator"]},"aws-native:kendra:DataSourceDocumentAttributeTarget":{"properties":{"targetDocumentAttributeKey":{"type":"string"},"targetDocumentAttributeValue":{"$ref":"#/types/aws-native:kendra:DataSourceDocumentAttributeValue"},"targetDocumentAttributeValueDeletion":{"type":"boolean"}},"type":"object","required":["targetDocumentAttributeKey"]},"aws-native:kendra:DataSourceDocumentAttributeValue":{"properties":{"dateValue":{"type":"string","description":"A date expressed as an ISO 8601 string.\n\nIt is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time."},"longValue":{"type":"integer","description":"A long integer value."},"stringListValue":{"type":"array","items":{"type":"string"},"description":"A list of strings. The default maximum length or number of strings is 10."},"stringValue":{"type":"string","description":"A string, such as \"department\"."}},"type":"object"},"aws-native:kendra:DataSourceDocumentsMetadataConfiguration":{"properties":{"s3Prefix":{"type":"string","description":"A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use `S3Prefix` to include only the desired metadata files."}},"type":"object"},"aws-native:kendra:DataSourceGoogleDriveConfiguration":{"properties":{"excludeMimeTypes":{"type":"array","items":{"type":"string"},"description":"A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.\n\nFor a list of MIME types, see [Using a Google Workspace Drive data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html) ."},"excludeSharedDrives":{"type":"array","items":{"type":"string"},"description":"A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded."},"excludeUserAccounts":{"type":"array","items":{"type":"string"},"description":"A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way."},"exclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index."},"fieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceToIndexFieldMapping"},"description":"Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Google Drive fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Google Drive data source field names must exist in your Google Drive custom metadata."},"inclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index."},"secretArn":{"type":"string","description":"The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive. For more information, see [Using a Google Workspace Drive data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html) ."}},"type":"object","required":["secretArn"]},"aws-native:kendra:DataSourceHookConfiguration":{"properties":{"invocationCondition":{"$ref":"#/types/aws-native:kendra:DataSourceDocumentAttributeCondition","description":"The condition used for when a Lambda function should be invoked.\n\nFor example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time."},"lambdaArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see [an IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) ."},"s3Bucket":{"type":"string","description":"Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see [Data contracts for Lambda functions](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda) ."}},"type":"object","required":["lambdaArn","s3Bucket"]},"aws-native:kendra:DataSourceInlineCustomDocumentEnrichmentConfiguration":{"properties":{"condition":{"$ref":"#/types/aws-native:kendra:DataSourceDocumentAttributeCondition"},"documentContentDeletion":{"type":"boolean"},"target":{"$ref":"#/types/aws-native:kendra:DataSourceDocumentAttributeTarget"}},"type":"object"},"aws-native:kendra:DataSourceOneDriveConfiguration":{"properties":{"disableLocalGroups":{"type":"boolean","description":"`TRUE` to disable local groups information."},"exclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.\n\nThe pattern is applied to the file name."},"fieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceToIndexFieldMapping"},"description":"A list of `DataSourceToIndexFieldMapping` objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to OneDrive fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The OneDrive data source field names must exist in your OneDrive custom metadata."},"inclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.\n\nThe pattern is applied to the file name."},"oneDriveUsers":{"$ref":"#/types/aws-native:kendra:DataSourceOneDriveUsers","description":"A list of user accounts whose documents should be indexed."},"secretArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application."},"tenantDomain":{"type":"string","description":"The Azure Active Directory domain of the organization."}},"type":"object","required":["oneDriveUsers","secretArn","tenantDomain"]},"aws-native:kendra:DataSourceOneDriveUsers":{"properties":{"oneDriveUserList":{"type":"array","items":{"type":"string"},"description":"A list of users whose documents should be indexed. Specify the user names in email format, for example, `username@tenantdomain` . If you need to index the documents of more than 10 users, use the `OneDriveUserS3Path` field to specify the location of a file containing a list of users."},"oneDriveUserS3Path":{"$ref":"#/types/aws-native:kendra:DataSourceS3Path","description":"The S3 bucket location of a file containing a list of users whose documents should be indexed."}},"type":"object"},"aws-native:kendra:DataSourceProxyConfiguration":{"properties":{"credentials":{"type":"string","description":"The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)\n\nThe credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials."},"host":{"type":"string","description":"The name of the website host you want to connect to via a web proxy server.\n\nFor example, the host name of https://a.example.com/page1.html is \"a.example.com\"."},"port":{"type":"integer","description":"The port number of the website host you want to connect to via a web proxy server.\n\nFor example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS."}},"type":"object","required":["host","port"]},"aws-native:kendra:DataSourceQueryIdentifiersEnclosingOption":{"type":"string","enum":[{"name":"DoubleQuotes","value":"DOUBLE_QUOTES"},{"name":"None","value":"NONE"}]},"aws-native:kendra:DataSourceS3DataSourceConfiguration":{"description":"S3 data source configuration","properties":{"accessControlListConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceAccessControlListConfiguration","description":"Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see [Access control for S3 data sources](https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html) ."},"bucketName":{"type":"string","description":"The name of the bucket that contains the documents."},"documentsMetadataConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceDocumentsMetadataConfiguration","description":"Specifies document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document."},"exclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:\n\n- */myapp/config/** —All files inside config directory.\n- ***/*.png* —All .png files in all directories.\n- ***/*.{png, ico, md}* —All .png, .ico or .md files in all directories.\n- */myapp/src/**/*.ts* —All .ts files inside src directory (and all its subdirectories).\n- ***/!(*.module).ts* —All .ts files but not .module.ts\n- **.png , *.jpg* —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).\n- **internal** —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.\n- ***/*internal** —All internal-related files in a directory and its subdirectories.\n\nFor more examples, see [Use of Exclude and Include Filters](https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) in the AWS CLI Command Reference."},"inclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:\n\n- */myapp/config/** —All files inside config directory.\n- ***/*.png* —All .png files in all directories.\n- ***/*.{png, ico, md}* —All .png, .ico or .md files in all directories.\n- */myapp/src/**/*.ts* —All .ts files inside src directory (and all its subdirectories).\n- ***/!(*.module).ts* —All .ts files but not .module.ts\n- **.png , *.jpg* —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).\n- **internal** —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.\n- ***/*internal** —All internal-related files in a directory and its subdirectories.\n\nFor more examples, see [Use of Exclude and Include Filters](https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) in the AWS CLI Command Reference."},"inclusionPrefixes":{"type":"array","items":{"type":"string"},"description":"A list of S3 prefixes for the documents that should be included in the index."}},"type":"object","required":["bucketName"]},"aws-native:kendra:DataSourceS3Path":{"properties":{"bucket":{"type":"string","description":"The name of the S3 bucket that contains the file."},"key":{"type":"string","description":"The name of the file."}},"type":"object","required":["bucket","key"]},"aws-native:kendra:DataSourceSalesforceChatterFeedConfiguration":{"properties":{"documentDataFieldName":{"type":"string","description":"The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the `Body` column."},"documentTitleFieldName":{"type":"string","description":"The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the `Title` column."},"fieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceToIndexFieldMapping"},"description":"Maps fields from a Salesforce chatter feed into Amazon Kendra index fields."},"includeFilterTypes":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceSalesforceChatterFeedIncludeFilterType"},"description":"Filters the documents in the feed based on status of the user. When you specify `ACTIVE_USERS` only documents from users who have an active account are indexed. When you specify `STANDARD_USER` only documents for Salesforce standard users are documented. You can specify both."}},"type":"object","required":["documentDataFieldName"]},"aws-native:kendra:DataSourceSalesforceChatterFeedIncludeFilterType":{"type":"string","enum":[{"name":"ActiveUser","value":"ACTIVE_USER"},{"name":"StandardUser","value":"STANDARD_USER"}]},"aws-native:kendra:DataSourceSalesforceConfiguration":{"properties":{"chatterFeedConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceSalesforceChatterFeedConfiguration","description":"Configuration information for Salesforce chatter feeds."},"crawlAttachments":{"type":"boolean","description":"Indicates whether Amazon Kendra should index attachments to Salesforce objects."},"excludeAttachmentFilePatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.\n\nThe pattern is applied to the name of the attached file."},"includeAttachmentFilePatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.\n\nThe pattern is applied to the name of the attached file."},"knowledgeArticleConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceSalesforceKnowledgeArticleConfiguration","description":"Configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both."},"secretArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:\n\n- authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.\n- consumerKey - The application public key generated when you created your Salesforce application.\n- consumerSecret - The application private key generated when you created your Salesforce application.\n- password - The password associated with the user logging in to the Salesforce instance.\n- securityToken - The token associated with the user logging in to the Salesforce instance.\n- username - The user name of the user logging in to the Salesforce instance."},"serverUrl":{"type":"string","description":"The instance URL for the Salesforce site that you want to index."},"standardObjectAttachmentConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceSalesforceStandardObjectAttachmentConfiguration","description":"Configuration information for processing attachments to Salesforce standard objects."},"standardObjectConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceSalesforceStandardObjectConfiguration"},"description":"Configuration of the Salesforce standard objects that Amazon Kendra indexes."}},"type":"object","required":["secretArn","serverUrl"]},"aws-native:kendra:DataSourceSalesforceCustomKnowledgeArticleTypeConfiguration":{"properties":{"documentDataFieldName":{"type":"string"},"documentTitleFieldName":{"type":"string"},"fieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceToIndexFieldMapping"}},"name":{"type":"string"}},"type":"object","required":["documentDataFieldName","name"]},"aws-native:kendra:DataSourceSalesforceKnowledgeArticleConfiguration":{"properties":{"customKnowledgeArticleTypeConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceSalesforceCustomKnowledgeArticleTypeConfiguration"},"description":"Configuration information for custom Salesforce knowledge articles."},"includedStates":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceSalesforceKnowledgeArticleState"},"description":"Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state."},"standardKnowledgeArticleTypeConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceSalesforceStandardKnowledgeArticleTypeConfiguration","description":"Configuration information for standard Salesforce knowledge articles."}},"type":"object","required":["includedStates"]},"aws-native:kendra:DataSourceSalesforceKnowledgeArticleState":{"type":"string","enum":[{"name":"Draft","value":"DRAFT"},{"name":"Published","value":"PUBLISHED"},{"name":"Archived","value":"ARCHIVED"}]},"aws-native:kendra:DataSourceSalesforceStandardKnowledgeArticleTypeConfiguration":{"properties":{"documentDataFieldName":{"type":"string","description":"The name of the field that contains the document data to index."},"documentTitleFieldName":{"type":"string","description":"The name of the field that contains the document title."},"fieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceToIndexFieldMapping"},"description":"Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Salesforce fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Salesforce data source field names must exist in your Salesforce custom metadata."}},"type":"object","required":["documentDataFieldName"]},"aws-native:kendra:DataSourceSalesforceStandardObjectAttachmentConfiguration":{"properties":{"documentTitleFieldName":{"type":"string","description":"The name of the field used for the document title."},"fieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceToIndexFieldMapping"},"description":"One or more objects that map fields in attachments to Amazon Kendra index fields."}},"type":"object"},"aws-native:kendra:DataSourceSalesforceStandardObjectConfiguration":{"properties":{"documentDataFieldName":{"type":"string"},"documentTitleFieldName":{"type":"string"},"fieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceToIndexFieldMapping"}},"name":{"$ref":"#/types/aws-native:kendra:DataSourceSalesforceStandardObjectName"}},"type":"object","required":["documentDataFieldName","name"]},"aws-native:kendra:DataSourceSalesforceStandardObjectName":{"type":"string","enum":[{"name":"Account","value":"ACCOUNT"},{"name":"Campaign","value":"CAMPAIGN"},{"name":"Case","value":"CASE"},{"name":"Contact","value":"CONTACT"},{"name":"Contract","value":"CONTRACT"},{"name":"Document","value":"DOCUMENT"},{"name":"Group","value":"GROUP"},{"name":"Idea","value":"IDEA"},{"name":"Lead","value":"LEAD"},{"name":"Opportunity","value":"OPPORTUNITY"},{"name":"Partner","value":"PARTNER"},{"name":"Pricebook","value":"PRICEBOOK"},{"name":"Product","value":"PRODUCT"},{"name":"Profile","value":"PROFILE"},{"name":"Solution","value":"SOLUTION"},{"name":"Task","value":"TASK"},{"name":"User","value":"USER"}]},"aws-native:kendra:DataSourceServiceNowAuthenticationType":{"type":"string","enum":[{"name":"HttpBasic","value":"HTTP_BASIC"},{"name":"Oauth2","value":"OAUTH2"}]},"aws-native:kendra:DataSourceServiceNowBuildVersionType":{"type":"string","enum":[{"name":"London","value":"LONDON"},{"name":"Others","value":"OTHERS"}]},"aws-native:kendra:DataSourceServiceNowConfiguration":{"properties":{"authenticationType":{"$ref":"#/types/aws-native:kendra:DataSourceServiceNowAuthenticationType","description":"The type of authentication used to connect to the ServiceNow instance. If you choose `HTTP_BASIC` , Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the `SecretArn` field. If you choose `OAUTH2` , Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.\n\nWhen you use `OAUTH2` authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html) ."},"hostUrl":{"type":"string","description":"The ServiceNow instance that the data source connects to. The host endpoint should look like the following: *{instance}.service-now.com.*"},"knowledgeArticleConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceServiceNowKnowledgeArticleConfiguration","description":"Configuration information for crawling knowledge articles in the ServiceNow site."},"secretArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html) ."},"serviceCatalogConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceServiceNowServiceCatalogConfiguration","description":"Configuration information for crawling service catalogs in the ServiceNow site."},"serviceNowBuildVersion":{"$ref":"#/types/aws-native:kendra:DataSourceServiceNowBuildVersionType","description":"The identifier of the release that the ServiceNow host is running. If the host is not running the `LONDON` release, use `OTHERS` ."}},"type":"object","required":["hostUrl","secretArn","serviceNowBuildVersion"]},"aws-native:kendra:DataSourceServiceNowKnowledgeArticleConfiguration":{"properties":{"crawlAttachments":{"type":"boolean","description":"`TRUE` to index attachments to knowledge articles."},"documentDataFieldName":{"type":"string","description":"The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index."},"documentTitleFieldName":{"type":"string","description":"The name of the ServiceNow field that is mapped to the index document title field."},"excludeAttachmentFilePatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns applied to exclude certain knowledge article attachments. Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index."},"fieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceToIndexFieldMapping"},"description":"Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to ServiceNow fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The ServiceNow data source field names must exist in your ServiceNow custom metadata."},"filterQuery":{"type":"string","description":"A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.\n\nThe query string must be one generated by the ServiceNow console. For more information, see [Specifying documents to index with a query](https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html) ."},"includeAttachmentFilePatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns applied to include knowledge article attachments. Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index."}},"type":"object","required":["documentDataFieldName"]},"aws-native:kendra:DataSourceServiceNowServiceCatalogConfiguration":{"properties":{"crawlAttachments":{"type":"boolean","description":"`TRUE` to index attachments to service catalog items."},"documentDataFieldName":{"type":"string","description":"The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index."},"documentTitleFieldName":{"type":"string","description":"The name of the ServiceNow field that is mapped to the index document title field."},"excludeAttachmentFilePatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.\n\nThe regex is applied to the file name of the attachment."},"fieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceToIndexFieldMapping"},"description":"Maps attributes or field names of catalogs to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to ServiceNow fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The ServiceNow data source field names must exist in your ServiceNow custom metadata."},"includeAttachmentFilePatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.\n\nThe regex is applied to the file name of the attachment."}},"type":"object","required":["documentDataFieldName"]},"aws-native:kendra:DataSourceSharePointConfiguration":{"description":"SharePoint configuration","properties":{"crawlAttachments":{"type":"boolean","description":"`TRUE` to index document attachments."},"disableLocalGroups":{"type":"boolean","description":"`TRUE` to disable local groups information."},"documentTitleFieldName":{"type":"string","description":"The Microsoft SharePoint attribute field that contains the title of the document."},"exclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.\n\nThe regex is applied to the display URL of the SharePoint document."},"fieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceToIndexFieldMapping"},"description":"A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields. You must first create the index fields using the [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateIndex.html) operation before you map SharePoint attributes. For more information, see [Mapping Data Source Fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) ."},"inclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.\n\nThe regex applies to the display URL of the SharePoint document."},"secretArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see [Microsoft SharePoint](https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html) ."},"sharePointVersion":{"$ref":"#/types/aws-native:kendra:DataSourceSharePointConfigurationSharePointVersion","description":"The version of Microsoft SharePoint that you use."},"sslCertificateS3Path":{"$ref":"#/types/aws-native:kendra:DataSourceS3Path","description":"Information required to find a specific file in an Amazon S3 bucket."},"urls":{"type":"array","items":{"type":"string"},"description":"The Microsoft SharePoint site URLs for the documents you want to index."},"useChangeLog":{"type":"boolean","description":"`TRUE` to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint."},"vpcConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceVpcConfiguration","description":"Provides information for connecting to an Amazon VPC."}},"type":"object","required":["secretArn","sharePointVersion","urls"]},"aws-native:kendra:DataSourceSharePointConfigurationSharePointVersion":{"description":"The version of Microsoft SharePoint that you use.","type":"string","enum":[{"name":"SharepointOnline","value":"SHAREPOINT_ONLINE"},{"name":"Sharepoint2013","value":"SHAREPOINT_2013"},{"name":"Sharepoint2016","value":"SHAREPOINT_2016"}]},"aws-native:kendra:DataSourceSqlConfiguration":{"properties":{"queryIdentifiersEnclosingOption":{"$ref":"#/types/aws-native:kendra:DataSourceQueryIdentifiersEnclosingOption","description":"Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (\") when making a database query. You can set the value to `DOUBLE_QUOTES` or `NONE` .\n\nBy default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.\n\nPostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.\n\nFor MySQL databases, you must enable the ansi_quotes option when you set this field to `DOUBLE_QUOTES` ."}},"type":"object"},"aws-native:kendra:DataSourceTag":{"description":"A label for tagging Kendra resources","properties":{"key":{"type":"string","description":"A string used to identify this tag"},"value":{"type":"string","description":"A string containing the value for the tag"}},"type":"object","required":["key","value"]},"aws-native:kendra:DataSourceTemplateConfiguration":{"properties":{"template":{"$ref":"pulumi.json#/Any","description":"The template schema used for the data source, where templates schemas are supported.\n\nSee [Data source template schemas](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html) ."}},"type":"object","required":["template"]},"aws-native:kendra:DataSourceToIndexFieldMapping":{"properties":{"dataSourceFieldName":{"type":"string"},"dateFieldFormat":{"type":"string"},"indexFieldName":{"type":"string"}},"type":"object","required":["dataSourceFieldName","indexFieldName"]},"aws-native:kendra:DataSourceType":{"description":"Data source type","type":"string","enum":[{"name":"S3","value":"S3"},{"name":"Sharepoint","value":"SHAREPOINT"},{"name":"Salesforce","value":"SALESFORCE"},{"name":"Onedrive","value":"ONEDRIVE"},{"name":"Servicenow","value":"SERVICENOW"},{"name":"Database","value":"DATABASE"},{"name":"Custom","value":"CUSTOM"},{"name":"Confluence","value":"CONFLUENCE"},{"name":"Googledrive","value":"GOOGLEDRIVE"},{"name":"Webcrawler","value":"WEBCRAWLER"},{"name":"Workdocs","value":"WORKDOCS"},{"name":"Template","value":"TEMPLATE"}]},"aws-native:kendra:DataSourceVpcConfiguration":{"properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device."}},"type":"object","required":["securityGroupIds","subnetIds"]},"aws-native:kendra:DataSourceWebCrawlerAuthenticationConfiguration":{"properties":{"basicAuthentication":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceWebCrawlerBasicAuthentication"},"description":"The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.\n\nThe list includes the name and port number of the website host."}},"type":"object"},"aws-native:kendra:DataSourceWebCrawlerBasicAuthentication":{"properties":{"credentials":{"type":"string"},"host":{"type":"string"},"port":{"type":"integer"}},"type":"object","required":["credentials","host","port"]},"aws-native:kendra:DataSourceWebCrawlerConfiguration":{"properties":{"authenticationConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceWebCrawlerAuthenticationConfiguration","description":"Configuration information required to connect to websites using authentication.\n\nYou can connect to websites using basic authentication of user name and password. You use a secret in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) to store your authentication credentials.\n\nYou must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the standard port for HTTPS."},"crawlDepth":{"type":"integer","description":"The 'depth' or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2."},"maxContentSizePerPageInMegaBytes":{"type":"number","description":"The maximum size (in MB) of a web page or attachment to crawl.\n\nFiles larger than this size (in MB) are skipped/not crawled.\n\nThe default maximum size of a web page or attachment is set to 50 MB."},"maxLinksPerPage":{"type":"integer","description":"The maximum number of URLs on a web page to include when crawling a website. This number is per web page.\n\nAs a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance.\n\nThe default maximum links per page is 100."},"maxUrlsPerMinuteCrawlRate":{"type":"integer","description":"The maximum number of URLs crawled per website host per minute.\n\nA minimum of one URL is required.\n\nThe default maximum number of URLs crawled per website host per minute is 300."},"proxyConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceProxyConfiguration","description":"Configuration information required to connect to your internal websites via a web proxy.\n\nYou must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the standard port for HTTPS.\n\nWeb proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) ."},"urlExclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index."},"urlInclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index."},"urls":{"$ref":"#/types/aws-native:kendra:DataSourceWebCrawlerUrls","description":"Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.\n\nYou can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.\n\nYou can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.\n\n*When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy](https://docs.aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.*"}},"type":"object","required":["urls"]},"aws-native:kendra:DataSourceWebCrawlerSeedUrlConfiguration":{"properties":{"seedUrls":{"type":"array","items":{"type":"string"},"description":"The list of seed or starting point URLs of the websites you want to crawl.\n\nThe list can include a maximum of 100 seed URLs."},"webCrawlerMode":{"$ref":"#/types/aws-native:kendra:DataSourceWebCrawlerSeedUrlConfigurationWebCrawlerMode","description":"You can choose one of the following modes:\n\n- `HOST_ONLY` —crawl only the website host names. For example, if the seed URL is \"abc.example.com\", then only URLs with host name \"abc.example.com\" are crawled.\n- `SUBDOMAINS` —crawl the website host names with subdomains. For example, if the seed URL is \"abc.example.com\", then \"a.abc.example.com\" and \"b.abc.example.com\" are also crawled.\n- `EVERYTHING` —crawl the website host names with subdomains and other domains that the web pages link to.\n\nThe default mode is set to `HOST_ONLY` ."}},"type":"object","required":["seedUrls"]},"aws-native:kendra:DataSourceWebCrawlerSeedUrlConfigurationWebCrawlerMode":{"description":"You can choose one of the following modes:\n\n- `HOST_ONLY` —crawl only the website host names. For example, if the seed URL is \"abc.example.com\", then only URLs with host name \"abc.example.com\" are crawled.\n- `SUBDOMAINS` —crawl the website host names with subdomains. For example, if the seed URL is \"abc.example.com\", then \"a.abc.example.com\" and \"b.abc.example.com\" are also crawled.\n- `EVERYTHING` —crawl the website host names with subdomains and other domains that the web pages link to.\n\nThe default mode is set to `HOST_ONLY` .","type":"string","enum":[{"name":"HostOnly","value":"HOST_ONLY"},{"name":"Subdomains","value":"SUBDOMAINS"},{"name":"Everything","value":"EVERYTHING"}]},"aws-native:kendra:DataSourceWebCrawlerSiteMapsConfiguration":{"properties":{"siteMaps":{"type":"array","items":{"type":"string"},"description":"The list of sitemap URLs of the websites you want to crawl.\n\nThe list can include a maximum of three sitemap URLs."}},"type":"object","required":["siteMaps"]},"aws-native:kendra:DataSourceWebCrawlerUrls":{"properties":{"seedUrlConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceWebCrawlerSeedUrlConfiguration","description":"Configuration of the seed or starting point URLs of the websites you want to crawl.\n\nYou can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to.\n\nYou can list up to 100 seed URLs."},"siteMapsConfiguration":{"$ref":"#/types/aws-native:kendra:DataSourceWebCrawlerSiteMapsConfiguration","description":"Configuration of the sitemap URLs of the websites you want to crawl.\n\nOnly URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs."}},"type":"object"},"aws-native:kendra:DataSourceWorkDocsConfiguration":{"properties":{"crawlComments":{"type":"boolean","description":"`TRUE` to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.\n\nThe default is set to `FALSE` ."},"exclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to exclude certain files in your WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index."},"fieldMappings":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:DataSourceToIndexFieldMapping"},"description":"A list of `DataSourceToIndexFieldMapping` objects that map WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to WorkDocs fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The WorkDocs data source field names must exist in your WorkDocs custom metadata."},"inclusionPatterns":{"type":"array","items":{"type":"string"},"description":"A list of regular expression patterns to include certain files in your WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index."},"organizationId":{"type":"string","description":"The identifier of the directory corresponding to your WorkDocs site repository.\n\nYou can find the organization ID in the [Directory Service](https://docs.aws.amazon.com/directoryservicev2/) by going to *Active Directory* , then *Directories* . Your WorkDocs site directory has an ID, which is the organization ID. You can also set up a new WorkDocs directory in the Directory Service console and enable a WorkDocs site for the directory in the WorkDocs console."},"useChangeLog":{"type":"boolean","description":"`TRUE` to use the WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in WorkDocs."}},"type":"object","required":["organizationId"]},"aws-native:kendra:FaqFileFormat":{"description":"Format of the input file","type":"string","enum":[{"name":"Csv","value":"CSV"},{"name":"CsvWithHeader","value":"CSV_WITH_HEADER"},{"name":"Json","value":"JSON"}]},"aws-native:kendra:FaqS3Path":{"properties":{"bucket":{"type":"string","description":"The name of the S3 bucket that contains the file."},"key":{"type":"string","description":"The name of the file."}},"type":"object","required":["bucket","key"]},"aws-native:kendra:FaqTag":{"description":"A label for tagging Kendra resources","properties":{"key":{"type":"string","description":"A string used to identify this tag"},"value":{"type":"string","description":"A string containing the value for the tag"}},"type":"object","required":["key","value"]},"aws-native:kendra:IndexCapacityUnitsConfiguration":{"properties":{"queryCapacityUnits":{"type":"integer","description":"The amount of extra query capacity for an index and [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) capacity.\n\nA single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.\n\n`GetQuerySuggestions` capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and `GetQuerySuggestions` capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the `GetQuerySuggestions` capacity is 2.5 calls per second (higher than five times 0.2 queries per second)."},"storageCapacityUnits":{"type":"integer","description":"The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units."}},"type":"object","required":["queryCapacityUnits","storageCapacityUnits"]},"aws-native:kendra:IndexDocumentAttributeValueType":{"type":"string","enum":[{"name":"StringValue","value":"STRING_VALUE"},{"name":"StringListValue","value":"STRING_LIST_VALUE"},{"name":"LongValue","value":"LONG_VALUE"},{"name":"DateValue","value":"DATE_VALUE"}]},"aws-native:kendra:IndexDocumentMetadataConfiguration":{"properties":{"name":{"type":"string"},"relevance":{"$ref":"#/types/aws-native:kendra:IndexRelevance"},"search":{"$ref":"#/types/aws-native:kendra:IndexSearch"},"type":{"$ref":"#/types/aws-native:kendra:IndexDocumentAttributeValueType"}},"type":"object","required":["name","type"]},"aws-native:kendra:IndexEdition":{"description":"Edition of index","type":"string","enum":[{"name":"DeveloperEdition","value":"DEVELOPER_EDITION"},{"name":"EnterpriseEdition","value":"ENTERPRISE_EDITION"},{"name":"GenAiEnterpriseEdition","value":"GEN_AI_ENTERPRISE_EDITION"}]},"aws-native:kendra:IndexJsonTokenTypeConfiguration":{"properties":{"groupAttributeField":{"type":"string"},"userNameAttributeField":{"type":"string"}},"type":"object","required":["groupAttributeField","userNameAttributeField"]},"aws-native:kendra:IndexJwtTokenTypeConfiguration":{"properties":{"claimRegex":{"type":"string"},"groupAttributeField":{"type":"string"},"issuer":{"type":"string"},"keyLocation":{"$ref":"#/types/aws-native:kendra:IndexKeyLocation"},"secretManagerArn":{"type":"string"},"url":{"type":"string"},"userNameAttributeField":{"type":"string"}},"type":"object","required":["keyLocation"]},"aws-native:kendra:IndexKeyLocation":{"type":"string","enum":[{"name":"Url","value":"URL"},{"name":"SecretManager","value":"SECRET_MANAGER"}]},"aws-native:kendra:IndexOrder":{"type":"string","enum":[{"name":"Ascending","value":"ASCENDING"},{"name":"Descending","value":"DESCENDING"}]},"aws-native:kendra:IndexRelevance":{"properties":{"duration":{"type":"string"},"freshness":{"type":"boolean"},"importance":{"type":"integer"},"rankOrder":{"$ref":"#/types/aws-native:kendra:IndexOrder"},"valueImportanceItems":{"type":"array","items":{"$ref":"#/types/aws-native:kendra:IndexValueImportanceItem"}}},"type":"object"},"aws-native:kendra:IndexSearch":{"properties":{"displayable":{"type":"boolean"},"facetable":{"type":"boolean"},"searchable":{"type":"boolean"},"sortable":{"type":"boolean"}},"type":"object"},"aws-native:kendra:IndexServerSideEncryptionConfiguration":{"properties":{"kmsKeyId":{"type":"string","description":"The identifier of the AWS KMS key . Amazon Kendra doesn't support asymmetric keys."}},"type":"object"},"aws-native:kendra:IndexTag":{"description":"A label for tagging Kendra resources","properties":{"key":{"type":"string","description":"A string used to identify this tag"},"value":{"type":"string","description":"A string containing the value for the tag"}},"type":"object","required":["key","value"]},"aws-native:kendra:IndexUserContextPolicy":{"type":"string","enum":[{"name":"AttributeFilter","value":"ATTRIBUTE_FILTER"},{"name":"UserToken","value":"USER_TOKEN"}]},"aws-native:kendra:IndexUserTokenConfiguration":{"properties":{"jsonTokenTypeConfiguration":{"$ref":"#/types/aws-native:kendra:IndexJsonTokenTypeConfiguration"},"jwtTokenTypeConfiguration":{"$ref":"#/types/aws-native:kendra:IndexJwtTokenTypeConfiguration"}},"type":"object"},"aws-native:kendra:IndexValueImportanceItem":{"properties":{"key":{"type":"string"},"value":{"type":"integer"}},"type":"object"},"aws-native:kendraranking:ExecutionPlanCapacityUnitsConfiguration":{"properties":{"rescoreCapacityUnits":{"type":"integer","description":"The amount of extra capacity for your rescore execution plan.\n\nA single extra capacity unit for a rescore execution plan provides 0.01 rescore requests per second. You can add up to 1000 extra capacity units."}},"type":"object","required":["rescoreCapacityUnits"]},"aws-native:kendraranking:ExecutionPlanTag":{"description":"A label for tagging KendraRanking resources","properties":{"key":{"type":"string","description":"A string used to identify this tag"},"value":{"type":"string","description":"A string containing the value for the tag"}},"type":"object","required":["key","value"]},"aws-native:kinesis:StreamConsumerTag":{"description":"An arbitrary set of tags (key-value pairs) to associate with the Kinesis consumer.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:kinesis:StreamEncryption":{"description":"When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.","properties":{"encryptionType":{"$ref":"#/types/aws-native:kinesis:StreamEncryptionEncryptionType","description":"The encryption type to use. The only valid value is KMS. "},"keyId":{"type":"string","description":"The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis."}},"type":"object","required":["encryptionType","keyId"]},"aws-native:kinesis:StreamEncryptionEncryptionType":{"description":"The encryption type to use. The only valid value is KMS. ","type":"string","enum":[{"name":"Kms","value":"KMS"}]},"aws-native:kinesis:StreamEnhancedMetric":{"description":"Value of an enhanced metric","type":"string","enum":[{"name":"IncomingBytes","value":"IncomingBytes"},{"name":"IncomingRecords","value":"IncomingRecords"},{"name":"OutgoingBytes","value":"OutgoingBytes"},{"name":"OutgoingRecords","value":"OutgoingRecords"},{"name":"WriteProvisionedThroughputExceeded","value":"WriteProvisionedThroughputExceeded"},{"name":"ReadProvisionedThroughputExceeded","value":"ReadProvisionedThroughputExceeded"},{"name":"IteratorAgeMilliseconds","value":"IteratorAgeMilliseconds"},{"name":"All","value":"ALL"}]},"aws-native:kinesis:StreamModeDetails":{"description":"When specified, enables or updates the mode of stream. Default is PROVISIONED.","properties":{"streamMode":{"$ref":"#/types/aws-native:kinesis:StreamModeDetailsStreamMode","description":"The mode of the stream"}},"type":"object","required":["streamMode"]},"aws-native:kinesis:StreamModeDetailsStreamMode":{"description":"The mode of the stream","type":"string","enum":[{"name":"OnDemand","value":"ON_DEMAND"},{"name":"Provisioned","value":"PROVISIONED"}]},"aws-native:kinesis:StreamTag":{"description":"An arbitrary set of tags (key-value pairs) to associate with the Kinesis stream.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:kinesis:StreamWarmThroughputObject":{"description":"Warm throughput configuration details for the stream. Only present for ON_DEMAND streams.","properties":{"currentMiBps":{"type":"integer","description":"Current warm throughput in MiB/s"},"targetMiBps":{"type":"integer","description":"Target warm throughput in MiB/s that a customer can write to a stream at any given time"}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationCatalogConfiguration":{"description":"The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.","properties":{"glueDataCatalogConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationGlueDataCatalogConfiguration","description":"The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationCheckpointConfiguration":{"description":"Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.","properties":{"checkpointInterval":{"type":"integer","description":"Describes the interval in milliseconds between checkpoint operations."},"checkpointingEnabled":{"type":"boolean","description":"Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application."},"configurationType":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationCheckpointConfigurationConfigurationType","description":"Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to `CUSTOM` in order to set the `CheckpointingEnabled`, `CheckpointInterval`, or `MinPauseBetweenCheckpoints` parameters."},"minPauseBetweenCheckpoints":{"type":"integer","description":"Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation."}},"type":"object","required":["configurationType"]},"aws-native:kinesisanalyticsv2:ApplicationCheckpointConfigurationConfigurationType":{"description":"Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to `CUSTOM` in order to set the `CheckpointingEnabled`, `CheckpointInterval`, or `MinPauseBetweenCheckpoints` parameters.","type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:kinesisanalyticsv2:ApplicationCodeConfiguration":{"description":"Describes code configuration for an application.","properties":{"codeContent":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationCodeContent","description":"The location and type of the application code."},"codeContentType":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationCodeConfigurationCodeContentType","description":"Specifies whether the code content is in text or zip format."}},"type":"object","required":["codeContent","codeContentType"]},"aws-native:kinesisanalyticsv2:ApplicationCodeConfigurationCodeContentType":{"description":"Specifies whether the code content is in text or zip format.","type":"string","enum":[{"name":"Plaintext","value":"PLAINTEXT"},{"name":"Zipfile","value":"ZIPFILE"}]},"aws-native:kinesisanalyticsv2:ApplicationCodeContent":{"description":"Specifies either the application code, or the location of the application code, for a Flink-based Kinesis Data Analytics application.","properties":{"s3ContentLocation":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationS3ContentLocation","description":"Information about the Amazon S3 bucket that contains the application code."},"textContent":{"type":"string","description":"The text-format code for a Flink-based Kinesis Data Analytics application."},"zipFileContent":{"type":"string","description":"The zip-format code for a Flink-based Kinesis Data Analytics application."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationConfiguration":{"description":"Specifies the creation parameters for a Kinesis Data Analytics application.","properties":{"applicationCodeConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationCodeConfiguration","description":"The code location and type parameters for a Flink-based Kinesis Data Analytics application."},"applicationEncryptionConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationEncryptionConfiguration","description":"Describes whether customer managed key is enabled and key details for customer data encryption"},"applicationSnapshotConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationSnapshotConfiguration","description":"Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application."},"applicationSystemRollbackConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationSystemRollbackConfiguration","description":"Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application."},"environmentProperties":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationEnvironmentProperties","description":"Describes execution properties for a Flink-based Kinesis Data Analytics application."},"flinkApplicationConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationFlinkApplicationConfiguration","description":"The creation and update parameters for a Flink-based Kinesis Data Analytics application."},"sqlApplicationConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationSqlApplicationConfiguration","description":"The creation and update parameters for a SQL-based Kinesis Data Analytics application."},"vpcConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationVpcConfiguration"},"description":"The array of descriptions of VPC configurations available to the application."},"zeppelinApplicationConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationZeppelinApplicationConfiguration","description":"The configuration parameters for a Kinesis Data Analytics Studio notebook."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationCsvMappingParameters":{"description":"For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the '\\n' as the row delimiter and a comma (\",\") as the column delimiter:\n`\"name1\", \"address1\"`\n`\"name2\", \"address2\"`","properties":{"recordColumnDelimiter":{"type":"string","description":"The column delimiter. For example, in a CSV format, a comma (\",\") is the typical column delimiter."},"recordRowDelimiter":{"type":"string","description":"The row delimiter. For example, in a CSV format, '\\n' is the typical row delimiter."}},"type":"object","required":["recordColumnDelimiter","recordRowDelimiter"]},"aws-native:kinesisanalyticsv2:ApplicationCustomArtifactConfiguration":{"description":"The configuration of connectors and user-defined functions.","properties":{"artifactType":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationCustomArtifactConfigurationArtifactType","description":"Set this to either `UDF` or `DEPENDENCY_JAR`. `UDF` stands for user-defined functions. This type of artifact must be in an S3 bucket. A `DEPENDENCY_JAR` can be in either Maven or an S3 bucket."},"mavenReference":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationMavenReference","description":"The parameters required to fully specify a Maven reference."},"s3ContentLocation":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationS3ContentLocation","description":"The location of the custom artifacts."}},"type":"object","required":["artifactType"]},"aws-native:kinesisanalyticsv2:ApplicationCustomArtifactConfigurationArtifactType":{"description":"Set this to either `UDF` or `DEPENDENCY_JAR`. `UDF` stands for user-defined functions. This type of artifact must be in an S3 bucket. A `DEPENDENCY_JAR` can be in either Maven or an S3 bucket.","type":"string","enum":[{"name":"DependencyJar","value":"DEPENDENCY_JAR"},{"name":"Udf","value":"UDF"}]},"aws-native:kinesisanalyticsv2:ApplicationDeployAsApplicationConfiguration":{"description":"The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.","properties":{"s3ContentLocation":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationS3ContentBaseLocation","description":"The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data."}},"type":"object","required":["s3ContentLocation"]},"aws-native:kinesisanalyticsv2:ApplicationEncryptionConfiguration":{"description":"Describes whether customer managed key is enabled and key details for customer data encryption","properties":{"keyId":{"type":"string","description":"KMS KeyId. Can be either key uuid or full key arn or key alias arn or short key alias"},"keyType":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationEncryptionConfigurationKeyType","description":"Specifies whether application data is encrypted using service key: AWS_OWNED_KEY or customer key: CUSTOMER_MANAGED_KEY"}},"type":"object","required":["keyType"]},"aws-native:kinesisanalyticsv2:ApplicationEncryptionConfigurationKeyType":{"description":"Specifies whether application data is encrypted using service key: AWS_OWNED_KEY or customer key: CUSTOMER_MANAGED_KEY","type":"string","enum":[{"name":"AwsOwnedKey","value":"AWS_OWNED_KEY"},{"name":"CustomerManagedKey","value":"CUSTOMER_MANAGED_KEY"}]},"aws-native:kinesisanalyticsv2:ApplicationEnvironmentProperties":{"description":"Describes execution properties for a Flink-based Kinesis Data Analytics application.","properties":{"propertyGroups":{"type":"array","items":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationPropertyGroup"},"description":"Describes the execution property groups."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationFlinkApplicationConfiguration":{"description":"Describes configuration parameters for a Flink-based Kinesis Data Analytics application or a Studio notebook.","properties":{"checkpointConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationCheckpointConfiguration","description":"Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation."},"monitoringConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationMonitoringConfiguration","description":"Describes configuration parameters for Amazon CloudWatch logging for an application."},"parallelismConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationParallelismConfiguration","description":"Describes parameters for how an application executes multiple tasks simultaneously."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationFlinkRunConfiguration":{"description":"Describes the starting parameters for a Flink-based Kinesis Data Analytics application.","properties":{"allowNonRestoredState":{"type":"boolean","description":"When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. Defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationGlueDataCatalogConfiguration":{"description":"The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.","properties":{"databaseArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the database."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationInput":{"description":"When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.","properties":{"inputParallelism":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationInputParallelism","description":"Describes the number of in-application streams to create."},"inputProcessingConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationInputProcessingConfiguration","description":"The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor."},"inputSchema":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationInputSchema","description":"Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created."},"kinesisFirehoseInput":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationKinesisFirehoseInput","description":"If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN."},"kinesisStreamsInput":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationKinesisStreamsInput","description":"If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN)."},"namePrefix":{"type":"string","description":"The name prefix to use when creating an in-application stream. Suppose that you specify a prefix `\"MyInApplicationStream\"`. Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names `\"MyInApplicationStream_001\"`, `\"MyInApplicationStream_002\"`, and so on."}},"type":"object","required":["inputSchema","namePrefix"]},"aws-native:kinesisanalyticsv2:ApplicationInputLambdaProcessor":{"description":"An object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.","properties":{"resourceArn":{"type":"string","description":"The ARN of the Amazon Lambda function that operates on records in the stream."}},"type":"object","required":["resourceArn"]},"aws-native:kinesisanalyticsv2:ApplicationInputParallelism":{"description":"For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.","properties":{"count":{"type":"integer","description":"The number of in-application streams to create."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationInputProcessingConfiguration":{"description":"For an SQL-based Amazon Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is Amazon Lambda.","properties":{"inputLambdaProcessor":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationInputLambdaProcessor","description":"The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationInputSchema":{"description":"For a SQL-based Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.","properties":{"recordColumns":{"type":"array","items":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationRecordColumn"},"description":"A list of `RecordColumn` objects."},"recordEncoding":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationInputSchemaRecordEncoding","description":"Specifies the encoding of the records in the streaming source. For example, UTF-8."},"recordFormat":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationRecordFormat","description":"Specifies the format of the records on the streaming source."}},"type":"object","required":["recordColumns","recordFormat"]},"aws-native:kinesisanalyticsv2:ApplicationInputSchemaRecordEncoding":{"description":"Specifies the encoding of the records in the streaming source. For example, UTF-8.","type":"string","enum":[{"name":"Utf8","value":"UTF-8"}]},"aws-native:kinesisanalyticsv2:ApplicationJsonMappingParameters":{"description":"For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.","properties":{"recordRowPath":{"type":"string","description":"The path to the top-level parent that contains the records."}},"type":"object","required":["recordRowPath"]},"aws-native:kinesisanalyticsv2:ApplicationKinesisFirehoseInput":{"description":"For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN).","properties":{"resourceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the delivery stream."}},"type":"object","required":["resourceArn"]},"aws-native:kinesisanalyticsv2:ApplicationKinesisStreamsInput":{"description":"Identifies a Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN).","properties":{"resourceArn":{"type":"string","description":"The ARN of the input Kinesis data stream to read."}},"type":"object","required":["resourceArn"]},"aws-native:kinesisanalyticsv2:ApplicationMaintenanceConfiguration":{"description":"Describes the maintenance configuration for the application.","properties":{"applicationMaintenanceWindowStartTime":{"type":"string","description":"The start time for the maintenance window."}},"type":"object","required":["applicationMaintenanceWindowStartTime"]},"aws-native:kinesisanalyticsv2:ApplicationMappingParameters":{"description":"When you configure a SQL-based Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.","properties":{"csvMappingParameters":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationCsvMappingParameters","description":"Provides additional mapping information when the record format uses delimiters (for example, CSV)."},"jsonMappingParameters":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationJsonMappingParameters","description":"Provides additional mapping information when JSON is the record format on the streaming source."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationMavenReference":{"description":"The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.","properties":{"artifactId":{"type":"string","description":"The artifact ID of the Maven reference."},"groupId":{"type":"string","description":"The group ID of the Maven reference."},"version":{"type":"string","description":"The version of the Maven reference."}},"type":"object","required":["artifactId","groupId","version"]},"aws-native:kinesisanalyticsv2:ApplicationMode":{"description":"To create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.","type":"string","enum":[{"name":"Interactive","value":"INTERACTIVE"},{"name":"Streaming","value":"STREAMING"}]},"aws-native:kinesisanalyticsv2:ApplicationMonitoringConfiguration":{"description":"Describes configuration parameters for Amazon CloudWatch logging for a Java-based Kinesis Data Analytics application. For more information about CloudWatch logging, see Monitoring.","properties":{"configurationType":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationMonitoringConfigurationConfigurationType","description":"Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters."},"logLevel":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationMonitoringConfigurationLogLevel","description":"Describes the verbosity of the CloudWatch Logs for an application."},"metricsLevel":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationMonitoringConfigurationMetricsLevel","description":"Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs."}},"type":"object","required":["configurationType"]},"aws-native:kinesisanalyticsv2:ApplicationMonitoringConfigurationConfigurationType":{"description":"Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.","type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:kinesisanalyticsv2:ApplicationMonitoringConfigurationLogLevel":{"description":"Describes the verbosity of the CloudWatch Logs for an application.","type":"string","enum":[{"name":"Debug","value":"DEBUG"},{"name":"Info","value":"INFO"},{"name":"Warn","value":"WARN"},{"name":"Error","value":"ERROR"}]},"aws-native:kinesisanalyticsv2:ApplicationMonitoringConfigurationMetricsLevel":{"description":"Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.","type":"string","enum":[{"name":"Application","value":"APPLICATION"},{"name":"Operator","value":"OPERATOR"},{"name":"Parallelism","value":"PARALLELISM"},{"name":"Task","value":"TASK"}]},"aws-native:kinesisanalyticsv2:ApplicationParallelismConfiguration":{"description":"Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation","properties":{"autoScalingEnabled":{"type":"boolean","description":"Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput."},"configurationType":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationParallelismConfigurationConfigurationType","description":"Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to `CUSTOM` in order to change your application's `AutoScalingEnabled`, `Parallelism`, or `ParallelismPerKPU` properties."},"parallelism":{"type":"integer","description":"Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration:AutoScalingEnabled is set to true."},"parallelismPerKpu":{"type":"integer","description":"Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing."}},"type":"object","required":["configurationType"]},"aws-native:kinesisanalyticsv2:ApplicationParallelismConfigurationConfigurationType":{"description":"Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to `CUSTOM` in order to change your application's `AutoScalingEnabled`, `Parallelism`, or `ParallelismPerKPU` properties.","type":"string","enum":[{"name":"Custom","value":"CUSTOM"},{"name":"Default","value":"DEFAULT"}]},"aws-native:kinesisanalyticsv2:ApplicationPropertyGroup":{"description":"Property key-value pairs passed into an application.","properties":{"propertyGroupId":{"type":"string","description":"Describes the key of an application execution property key-value pair."},"propertyMap":{"type":"object","additionalProperties":{"type":"string"},"description":"Describes the value of an application execution property key-value pair."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationRecordColumn":{"description":"For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.\nAlso used to describe the format of the reference data source.","properties":{"mapping":{"type":"string","description":"A reference to the data element in the streaming input or the reference data source."},"name":{"type":"string","description":"The name of the column that is created in the in-application input stream or reference table."},"sqlType":{"type":"string","description":"The type of column created in the in-application input stream or reference table."}},"type":"object","required":["name","sqlType"]},"aws-native:kinesisanalyticsv2:ApplicationRecordFormat":{"description":"For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.","properties":{"mappingParameters":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationMappingParameters","description":"When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source."},"recordFormatType":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationRecordFormatRecordFormatType","description":"The type of record format."}},"type":"object","required":["recordFormatType"]},"aws-native:kinesisanalyticsv2:ApplicationRecordFormatRecordFormatType":{"description":"The type of record format.","type":"string","enum":[{"name":"Csv","value":"CSV"},{"name":"Json","value":"JSON"}]},"aws-native:kinesisanalyticsv2:ApplicationRestoreConfiguration":{"description":"Describes the restore behavior of a restarting application.","properties":{"applicationRestoreType":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationRestoreConfigurationApplicationRestoreType","description":"Specifies how the application should be restored."},"snapshotName":{"type":"string","description":"The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType."}},"type":"object","required":["applicationRestoreType"]},"aws-native:kinesisanalyticsv2:ApplicationRestoreConfigurationApplicationRestoreType":{"description":"Specifies how the application should be restored.","type":"string","enum":[{"name":"SkipRestoreFromSnapshot","value":"SKIP_RESTORE_FROM_SNAPSHOT"},{"name":"RestoreFromLatestSnapshot","value":"RESTORE_FROM_LATEST_SNAPSHOT"},{"name":"RestoreFromCustomSnapshot","value":"RESTORE_FROM_CUSTOM_SNAPSHOT"}]},"aws-native:kinesisanalyticsv2:ApplicationRunConfiguration":{"description":"Identifies the run configuration (start parameters) of a Kinesis Data Analytics application. This section is evaluated only on stack updates for applications in running RUNNING state and has no effect during manual application start.","properties":{"applicationRestoreConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationRestoreConfiguration","description":"Describes the restore behavior of a restarting application."},"flinkRunConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationFlinkRunConfiguration","description":"Describes the starting parameters for a Flink-based Kinesis Data Analytics application."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationS3ContentBaseLocation":{"description":"The base location of the Amazon Data Analytics application.","properties":{"basePath":{"type":"string","description":"The base path for the S3 bucket."},"bucketArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the S3 bucket."}},"type":"object","required":["bucketArn"]},"aws-native:kinesisanalyticsv2:ApplicationS3ContentLocation":{"description":"The location of an application or a custom artifact.","properties":{"bucketArn":{"type":"string","description":"The Amazon Resource Name (ARN) for the S3 bucket containing the application code."},"fileKey":{"type":"string","description":"The file key for the object containing the application code."},"objectVersion":{"type":"string","description":"The version of the object containing the application code."}},"type":"object","required":["bucketArn","fileKey"]},"aws-native:kinesisanalyticsv2:ApplicationSnapshotConfiguration":{"description":"Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.","properties":{"snapshotsEnabled":{"type":"boolean","description":"Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application."}},"type":"object","required":["snapshotsEnabled"]},"aws-native:kinesisanalyticsv2:ApplicationSqlApplicationConfiguration":{"description":"Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.","properties":{"inputs":{"type":"array","items":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationInput"},"description":"The array of Input objects describing the input streams used by the application."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationSystemRollbackConfiguration":{"description":"Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application.","properties":{"rollbackEnabled":{"type":"boolean","description":"Describes whether system initiated rollbacks are enabled for a Flink-based Kinesis Data Analytics application."}},"type":"object","required":["rollbackEnabled"]},"aws-native:kinesisanalyticsv2:ApplicationTag":{"description":"A key-value pair that identifies an application.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that's 0 to 256 characters in length."}},"type":"object","required":["key","value"]},"aws-native:kinesisanalyticsv2:ApplicationVpcConfiguration":{"description":"Describes the parameters of a VPC used by the application.","properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The array of SecurityGroup IDs used by the VPC configuration."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The array of Subnet IDs used by the VPC configuration."}},"type":"object","required":["securityGroupIds","subnetIds"]},"aws-native:kinesisanalyticsv2:ApplicationZeppelinApplicationConfiguration":{"description":"The configuration of a Kinesis Data Analytics Studio notebook.","properties":{"catalogConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationCatalogConfiguration","description":"The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook."},"customArtifactsConfiguration":{"type":"array","items":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationCustomArtifactConfiguration"},"description":"A list of CustomArtifactConfiguration objects."},"deployAsApplicationConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationDeployAsApplicationConfiguration","description":"The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state."},"monitoringConfiguration":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationZeppelinMonitoringConfiguration","description":"The monitoring configuration of a Kinesis Data Analytics Studio notebook."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationZeppelinMonitoringConfiguration":{"description":"Describes configuration parameters for Amazon CloudWatch logging for a Kinesis Data Analytics Studio notebook. For more information about CloudWatch logging, see Monitoring.","properties":{"logLevel":{"$ref":"#/types/aws-native:kinesisanalyticsv2:ApplicationZeppelinMonitoringConfigurationLogLevel","description":"The verbosity of the CloudWatch Logs for an application. You can set it to `INFO`, `WARN`, `ERROR`, or `DEBUG`."}},"type":"object"},"aws-native:kinesisanalyticsv2:ApplicationZeppelinMonitoringConfigurationLogLevel":{"description":"The verbosity of the CloudWatch Logs for an application. You can set it to `INFO`, `WARN`, `ERROR`, or `DEBUG`.","type":"string","enum":[{"name":"Debug","value":"DEBUG"},{"name":"Info","value":"INFO"},{"name":"Warn","value":"WARN"},{"name":"Error","value":"ERROR"}]},"aws-native:kinesisfirehose:DeliveryStreamAmazonOpenSearchServerlessBufferingHints":{"properties":{"intervalInSeconds":{"type":"integer","description":"Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes)."},"sizeInMbs":{"type":"integer","description":"Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.\n\nWe recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamAmazonOpenSearchServerlessDestinationConfiguration":{"properties":{"bufferingHints":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamAmazonOpenSearchServerlessBufferingHints","description":"The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used."},"cloudWatchLoggingOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamCloudWatchLoggingOptions"},"collectionEndpoint":{"type":"string","description":"The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service."},"indexName":{"type":"string","description":"The Serverless offering for Amazon OpenSearch Service index name."},"processingConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamProcessingConfiguration"},"retryOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamAmazonOpenSearchServerlessRetryOptions","description":"The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes)."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents."},"s3BackupMode":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamAmazonOpenSearchServerlessDestinationConfigurationS3BackupMode","description":"Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix."},"s3Configuration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfiguration"},"vpcConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamVpcConfiguration","replaceOnChanges":true}},"type":"object","required":["indexName","roleArn","s3Configuration"]},"aws-native:kinesisfirehose:DeliveryStreamAmazonOpenSearchServerlessDestinationConfigurationS3BackupMode":{"description":"Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.","type":"string","enum":[{"name":"FailedDocumentsOnly","value":"FailedDocumentsOnly"},{"name":"AllDocuments","value":"AllDocuments"}]},"aws-native:kinesisfirehose:DeliveryStreamAmazonOpenSearchServerlessRetryOptions":{"properties":{"durationInSeconds":{"type":"integer","description":"After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamAmazonopensearchserviceBufferingHints":{"properties":{"intervalInSeconds":{"type":"integer","description":"Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes)."},"sizeInMbs":{"type":"integer","description":"Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamAmazonopensearchserviceDestinationConfiguration":{"properties":{"bufferingHints":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamAmazonopensearchserviceBufferingHints","description":"The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used."},"cloudWatchLoggingOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamCloudWatchLoggingOptions","description":"Describes the Amazon CloudWatch logging options for your delivery stream."},"clusterEndpoint":{"type":"string","description":"The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field."},"documentIdOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDocumentIdOptions","description":"Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID."},"domainArn":{"type":"string","description":"The ARN of the Amazon OpenSearch Service domain."},"indexName":{"type":"string","description":"The Amazon OpenSearch Service index name."},"indexRotationPeriod":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamAmazonopensearchserviceDestinationConfigurationIndexRotationPeriod","description":"The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data."},"processingConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamProcessingConfiguration","description":"Describes a data processing configuration."},"retryOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamAmazonopensearchserviceRetryOptions","description":"The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes)."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents."},"s3BackupMode":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamAmazonopensearchserviceDestinationConfigurationS3BackupMode","description":"Defines how documents should be delivered to Amazon S3."},"s3Configuration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfiguration","description":"Describes the configuration of a destination in Amazon S3."},"typeName":{"type":"string","description":"The Amazon OpenSearch Service type name."},"vpcConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamVpcConfiguration","description":"The details of the VPC of the Amazon OpenSearch Service destination.","replaceOnChanges":true}},"type":"object","required":["indexName","roleArn","s3Configuration"]},"aws-native:kinesisfirehose:DeliveryStreamAmazonopensearchserviceDestinationConfigurationIndexRotationPeriod":{"description":"The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.","type":"string","enum":[{"name":"NoRotation","value":"NoRotation"},{"name":"OneHour","value":"OneHour"},{"name":"OneDay","value":"OneDay"},{"name":"OneWeek","value":"OneWeek"},{"name":"OneMonth","value":"OneMonth"}]},"aws-native:kinesisfirehose:DeliveryStreamAmazonopensearchserviceDestinationConfigurationS3BackupMode":{"description":"Defines how documents should be delivered to Amazon S3.","type":"string","enum":[{"name":"FailedDocumentsOnly","value":"FailedDocumentsOnly"},{"name":"AllDocuments","value":"AllDocuments"}]},"aws-native:kinesisfirehose:DeliveryStreamAmazonopensearchserviceRetryOptions":{"properties":{"durationInSeconds":{"type":"integer","description":"After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamAuthenticationConfiguration":{"properties":{"connectivity":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamAuthenticationConfigurationConnectivity","description":"The type of connectivity used to access the Amazon MSK cluster."},"roleArn":{"type":"string","description":"The ARN of the role used to access the Amazon MSK cluster."}},"type":"object","required":["connectivity","roleArn"]},"aws-native:kinesisfirehose:DeliveryStreamAuthenticationConfigurationConnectivity":{"description":"The type of connectivity used to access the Amazon MSK cluster.","type":"string","enum":[{"name":"Public","value":"PUBLIC"},{"name":"Private","value":"PRIVATE"}]},"aws-native:kinesisfirehose:DeliveryStreamBufferingHints":{"properties":{"intervalInSeconds":{"type":"integer","description":"The length of time, in seconds, that Kinesis Data Firehose buffers incoming data before delivering it to the destination. For valid values, see the `IntervalInSeconds` content for the [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html) data type in the *Amazon Kinesis Data Firehose API Reference* ."},"sizeInMbs":{"type":"integer","description":"The size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data before delivering it to the destination. For valid values, see the `SizeInMBs` content for the [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html) data type in the *Amazon Kinesis Data Firehose API Reference* ."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamCatalogConfiguration":{"properties":{"catalogArn":{"type":"string","description":"Specifies the Glue catalog ARN identifier of the destination Apache Iceberg Tables. You must specify the ARN in the format `arn:aws:glue:region:account-id:catalog` ."},"warehouseLocation":{"type":"string","description":"The warehouse location for Apache Iceberg tables. You must configure this when schema evolution and table creation is enabled.\n\nAmazon Data Firehose is in preview release and is subject to change."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamCloudWatchLoggingOptions":{"properties":{"enabled":{"type":"boolean","description":"Indicates whether CloudWatch Logs logging is enabled."},"logGroupName":{"type":"string","description":"The name of the CloudWatch Logs log group that contains the log stream that Kinesis Data Firehose will use.\n\nConditional. If you enable logging, you must specify this property."},"logStreamName":{"type":"string","description":"The name of the CloudWatch Logs log stream that Kinesis Data Firehose uses to send logs about data delivery.\n\nConditional. If you enable logging, you must specify this property."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamCopyCommand":{"properties":{"copyOptions":{"type":"string","description":"Parameters to use with the Amazon Redshift `COPY` command. For examples, see the `CopyOptions` content for the [CopyCommand](https://docs.aws.amazon.com/firehose/latest/APIReference/API_CopyCommand.html) data type in the *Amazon Kinesis Data Firehose API Reference* ."},"dataTableColumns":{"type":"string","description":"A comma-separated list of column names."},"dataTableName":{"type":"string","description":"The name of the target table. The table must already exist in the database."}},"type":"object","required":["dataTableName"]},"aws-native:kinesisfirehose:DeliveryStreamDataFormatConversionConfiguration":{"properties":{"enabled":{"type":"boolean","description":"Defaults to `true` . Set it to `false` if you want to disable format conversion while preserving the configuration details."},"inputFormatConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamInputFormatConfiguration","description":"Specifies the deserializer that you want Firehose to use to convert the format of your data from JSON. This parameter is required if `Enabled` is set to true."},"outputFormatConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamOutputFormatConfiguration","description":"Specifies the serializer that you want Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if `Enabled` is set to true."},"schemaConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSchemaConfiguration","description":"Specifies the AWS Glue Data Catalog table that contains the column information. This parameter is required if `Enabled` is set to true."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamDatabaseColumns":{"properties":{"exclude":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamDatabaseSourceAuthenticationConfiguration":{"properties":{"secretsManagerConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSecretsManagerConfiguration"}},"type":"object","required":["secretsManagerConfiguration"]},"aws-native:kinesisfirehose:DeliveryStreamDatabaseSourceConfiguration":{"properties":{"columns":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDatabaseColumns","description":"The list of column patterns in source database endpoint for Firehose to read from.\n\nAmazon Data Firehose is in preview release and is subject to change."},"databaseSourceAuthenticationConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDatabaseSourceAuthenticationConfiguration","description":"The structure to configure the authentication methods for Firehose to connect to source database endpoint.\n\nAmazon Data Firehose is in preview release and is subject to change."},"databaseSourceVpcConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDatabaseSourceVpcConfiguration","description":"The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.\n\nAmazon Data Firehose is in preview release and is subject to change."},"databases":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDatabases","description":"The list of database patterns in source database endpoint for Firehose to read from.\n\nAmazon Data Firehose is in preview release and is subject to change."},"digest":{"type":"string"},"endpoint":{"type":"string","description":"The endpoint of the database server.\n\nAmazon Data Firehose is in preview release and is subject to change."},"port":{"type":"integer","description":"The port of the database. This can be one of the following values.\n\n- 3306 for MySQL database type\n- 5432 for PostgreSQL database type\n\nAmazon Data Firehose is in preview release and is subject to change."},"publicCertificate":{"type":"string"},"snapshotWatermarkTable":{"type":"string","description":"The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.\n\nAmazon Data Firehose is in preview release and is subject to change."},"sslMode":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDatabaseSourceConfigurationSslMode","description":"The mode to enable or disable SSL when Firehose connects to the database endpoint.\n\nAmazon Data Firehose is in preview release and is subject to change."},"surrogateKeys":{"type":"array","items":{"type":"string"},"description":"The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.\n\nAmazon Data Firehose is in preview release and is subject to change."},"tables":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDatabaseTables","description":"The list of table patterns in source database endpoint for Firehose to read from.\n\nAmazon Data Firehose is in preview release and is subject to change."},"type":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDatabaseSourceConfigurationType","description":"The type of database engine. This can be one of the following values.\n\n- MySQL\n- PostgreSQL\n\nAmazon Data Firehose is in preview release and is subject to change."}},"type":"object","required":["databaseSourceAuthenticationConfiguration","databaseSourceVpcConfiguration","databases","endpoint","port","snapshotWatermarkTable","tables","type"]},"aws-native:kinesisfirehose:DeliveryStreamDatabaseSourceConfigurationSslMode":{"description":"The mode to enable or disable SSL when Firehose connects to the database endpoint.\n\nAmazon Data Firehose is in preview release and is subject to change.","type":"string","enum":[{"name":"Disabled","value":"Disabled"},{"name":"Enabled","value":"Enabled"}]},"aws-native:kinesisfirehose:DeliveryStreamDatabaseSourceConfigurationType":{"description":"The type of database engine. This can be one of the following values.\n\n- MySQL\n- PostgreSQL\n\nAmazon Data Firehose is in preview release and is subject to change.","type":"string","enum":[{"name":"MySql","value":"MySQL"},{"name":"PostgreSql","value":"PostgreSQL"}]},"aws-native:kinesisfirehose:DeliveryStreamDatabaseSourceVpcConfiguration":{"properties":{"vpcEndpointServiceName":{"type":"string","description":"The VPC endpoint service name which Firehose uses to create a PrivateLink to the database. The endpoint service must have the Firehose service principle `firehose.amazonaws.com` as an allowed principal on the VPC endpoint service. The VPC endpoint service name is a string that looks like `com.amazonaws.vpce.\u003cregion\u003e.\u003cvpc-endpoint-service-id\u003e` .\n\nAmazon Data Firehose is in preview release and is subject to change."}},"type":"object","required":["vpcEndpointServiceName"]},"aws-native:kinesisfirehose:DeliveryStreamDatabaseTables":{"properties":{"exclude":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamDatabases":{"properties":{"exclude":{"type":"array","items":{"type":"string"}},"include":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamDeserializer":{"properties":{"hiveJsonSerDe":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamHiveJsonSerDe","description":"The native Hive / HCatalog JsonSerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe."},"openXJsonSerDe":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamOpenXJsonSerDe","description":"The OpenX SerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamDestinationTableConfiguration":{"properties":{"destinationDatabaseName":{"type":"string"},"destinationTableName":{"type":"string"},"partitionSpec":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDestinationTableConfigurationPartitionSpecProperties"},"s3ErrorOutputPrefix":{"type":"string"},"uniqueKeys":{"type":"array","items":{"type":"string"}}},"type":"object","required":["destinationDatabaseName","destinationTableName"]},"aws-native:kinesisfirehose:DeliveryStreamDestinationTableConfigurationPartitionSpecProperties":{"properties":{"identity":{"type":"array","items":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamPartitionField"}}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamDirectPutSourceConfiguration":{"properties":{"throughputHintInMbs":{"type":"integer","description":"The value that you configure for this parameter is for information purpose only and does not affect Firehose delivery throughput limit. You can use the [Firehose Limits form](https://docs.aws.amazon.com/https://support.console.aws.amazon.com/support/home#/case/create%3FissueType=service-limit-increase%26limitType=kinesis-firehose-limits) to request a throughput limit increase."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamDocumentIdOptions":{"properties":{"defaultDocumentIdFormat":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDocumentIdOptionsDefaultDocumentIdFormat","description":"When the `FIREHOSE_DEFAULT` option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.\n\nWhen the `NO_DOCUMENT_ID` option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance."}},"type":"object","required":["defaultDocumentIdFormat"]},"aws-native:kinesisfirehose:DeliveryStreamDocumentIdOptionsDefaultDocumentIdFormat":{"description":"When the `FIREHOSE_DEFAULT` option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.\n\nWhen the `NO_DOCUMENT_ID` option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.","type":"string","enum":[{"name":"FirehoseDefault","value":"FIREHOSE_DEFAULT"},{"name":"NoDocumentId","value":"NO_DOCUMENT_ID"}]},"aws-native:kinesisfirehose:DeliveryStreamDynamicPartitioningConfiguration":{"properties":{"enabled":{"type":"boolean","description":"Specifies whether dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream."},"retryOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamRetryOptions","description":"Specifies the retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamElasticsearchBufferingHints":{"properties":{"intervalInSeconds":{"type":"integer","description":"The length of time, in seconds, that Kinesis Data Firehose buffers incoming data before delivering it to the destination. For valid values, see the `IntervalInSeconds` content for the [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html) data type in the *Amazon Kinesis Data Firehose API Reference* ."},"sizeInMbs":{"type":"integer","description":"The size of the buffer, in MBs, that Kinesis Data Firehose uses for incoming data before delivering it to the destination. For valid values, see the `SizeInMBs` content for the [BufferingHints](https://docs.aws.amazon.com/firehose/latest/APIReference/API_BufferingHints.html) data type in the *Amazon Kinesis Data Firehose API Reference* ."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamElasticsearchDestinationConfiguration":{"properties":{"bufferingHints":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamElasticsearchBufferingHints","description":"Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain."},"cloudWatchLoggingOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamCloudWatchLoggingOptions","description":"The Amazon CloudWatch Logs logging options for the delivery stream."},"clusterEndpoint":{"type":"string","description":"The endpoint to use when communicating with the cluster. Specify either this `ClusterEndpoint` or the `DomainARN` field."},"documentIdOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDocumentIdOptions","description":"Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID."},"domainArn":{"type":"string","description":"The ARN of the Amazon ES domain. The IAM role must have permissions for `DescribeElasticsearchDomain` , `DescribeElasticsearchDomains` , and `DescribeElasticsearchDomainConfig` after assuming the role specified in *RoleARN* .\n\nSpecify either `ClusterEndpoint` or `DomainARN` ."},"indexName":{"type":"string","description":"The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing."},"indexRotationPeriod":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamElasticsearchDestinationConfigurationIndexRotationPeriod","description":"The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see [Index Rotation for the Amazon ES Destination](https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation) in the *Amazon Kinesis Data Firehose Developer Guide* ."},"processingConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamProcessingConfiguration","description":"The data processing configuration for the Kinesis Data Firehose delivery stream."},"retryOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamElasticsearchRetryOptions","description":"The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see [Controlling Access with Amazon Kinesis Data Firehose](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html) ."},"s3BackupMode":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamElasticsearchDestinationConfigurationS3BackupMode","description":"The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3). You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the `S3BackupMode` content for the [ElasticsearchDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchDestinationConfiguration.html) data type in the *Amazon Kinesis Data Firehose API Reference* ."},"s3Configuration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfiguration","description":"The S3 bucket where Kinesis Data Firehose backs up incoming data."},"typeName":{"type":"string","description":"The Elasticsearch type name that Amazon ES adds to documents when indexing data."},"vpcConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamVpcConfiguration","description":"The details of the VPC of the Amazon ES destination.","replaceOnChanges":true}},"type":"object","required":["indexName","roleArn","s3Configuration"]},"aws-native:kinesisfirehose:DeliveryStreamElasticsearchDestinationConfigurationIndexRotationPeriod":{"description":"The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see [Index Rotation for the Amazon ES Destination](https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation) in the *Amazon Kinesis Data Firehose Developer Guide* .","type":"string","enum":[{"name":"NoRotation","value":"NoRotation"},{"name":"OneHour","value":"OneHour"},{"name":"OneDay","value":"OneDay"},{"name":"OneWeek","value":"OneWeek"},{"name":"OneMonth","value":"OneMonth"}]},"aws-native:kinesisfirehose:DeliveryStreamElasticsearchDestinationConfigurationS3BackupMode":{"description":"The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3). You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the `S3BackupMode` content for the [ElasticsearchDestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchDestinationConfiguration.html) data type in the *Amazon Kinesis Data Firehose API Reference* .","type":"string","enum":[{"name":"FailedDocumentsOnly","value":"FailedDocumentsOnly"},{"name":"AllDocuments","value":"AllDocuments"}]},"aws-native:kinesisfirehose:DeliveryStreamElasticsearchRetryOptions":{"properties":{"durationInSeconds":{"type":"integer","description":"After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose re-attempts delivery (including the first attempt). If Kinesis Data Firehose can't deliver the data within the specified time, it writes the data to the backup S3 bucket. For valid values, see the `DurationInSeconds` content for the [ElasticsearchRetryOptions](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ElasticsearchRetryOptions.html) data type in the *Amazon Kinesis Data Firehose API Reference* ."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamEncryptionConfiguration":{"properties":{"kmsEncryptionConfig":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamKmsEncryptionConfig","description":"The AWS Key Management Service ( AWS KMS) encryption key that Amazon S3 uses to encrypt your data."},"noEncryptionConfig":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamEncryptionConfigurationNoEncryptionConfig","description":"Disables encryption. For valid values, see the `NoEncryptionConfig` content for the [EncryptionConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_EncryptionConfiguration.html) data type in the *Amazon Kinesis Data Firehose API Reference* ."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamEncryptionConfigurationInput":{"properties":{"keyArn":{"type":"string","description":"If you set `KeyType` to `CUSTOMER_MANAGED_CMK` , you must specify the Amazon Resource Name (ARN) of the CMK. If you set `KeyType` to `AWS _OWNED_CMK` , Firehose uses a service-account CMK."},"keyType":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamEncryptionConfigurationInputKeyType","description":"Indicates the type of customer master key (CMK) to use for encryption. The default setting is `AWS_OWNED_CMK` . For more information about CMKs, see [Customer Master Keys (CMKs)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys) .\n\nYou can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams.\n\n\u003e To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see [About Symmetric and Asymmetric CMKs](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html) in the AWS Key Management Service developer guide."}},"type":"object","required":["keyType"]},"aws-native:kinesisfirehose:DeliveryStreamEncryptionConfigurationInputKeyType":{"description":"Indicates the type of customer master key (CMK) to use for encryption. The default setting is `AWS_OWNED_CMK` . For more information about CMKs, see [Customer Master Keys (CMKs)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys) .\n\nYou can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams.\n\n\u003e To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see [About Symmetric and Asymmetric CMKs](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html) in the AWS Key Management Service developer guide.","type":"string","enum":[{"name":"AwsOwnedCmk","value":"AWS_OWNED_CMK"},{"name":"CustomerManagedCmk","value":"CUSTOMER_MANAGED_CMK"}]},"aws-native:kinesisfirehose:DeliveryStreamEncryptionConfigurationNoEncryptionConfig":{"description":"Disables encryption. For valid values, see the `NoEncryptionConfig` content for the [EncryptionConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_EncryptionConfiguration.html) data type in the *Amazon Kinesis Data Firehose API Reference* .","type":"string","enum":[{"name":"NoEncryption","value":"NoEncryption"}]},"aws-native:kinesisfirehose:DeliveryStreamExtendedS3DestinationConfiguration":{"properties":{"bucketArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon S3 bucket. For constraints, see [ExtendedS3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html) in the *Amazon Kinesis Data Firehose API Reference* ."},"bufferingHints":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamBufferingHints","description":"The buffering option."},"cloudWatchLoggingOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamCloudWatchLoggingOptions","description":"The Amazon CloudWatch logging options for your Firehose stream."},"compressionFormat":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamExtendedS3DestinationConfigurationCompressionFormat","description":"The compression format. If no value is specified, the default is `UNCOMPRESSED` ."},"customTimeZone":{"type":"string","description":"The time zone you prefer. UTC is the default."},"dataFormatConversionConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDataFormatConversionConfiguration","description":"The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3."},"dynamicPartitioningConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDynamicPartitioningConfiguration","description":"The configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys."},"encryptionConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamEncryptionConfiguration","description":"The encryption configuration for the Kinesis Data Firehose delivery stream. The default value is `NoEncryption` ."},"errorOutputPrefix":{"type":"string","description":"A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see [Custom Prefixes for Amazon S3 Objects](https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) ."},"fileExtension":{"type":"string","description":"Specify a file extension. It will override the default file extension"},"prefix":{"type":"string","description":"The `YYYY/MM/DD/HH` time format prefix is automatically used for delivered Amazon S3 files. For more information, see [ExtendedS3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html) in the *Amazon Kinesis Data Firehose API Reference* ."},"processingConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamProcessingConfiguration","description":"The data processing configuration for the Kinesis Data Firehose delivery stream."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the AWS credentials. For constraints, see [ExtendedS3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_ExtendedS3DestinationConfiguration.html) in the *Amazon Kinesis Data Firehose API Reference* ."},"s3BackupConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfiguration","description":"The configuration for backup in Amazon S3."},"s3BackupMode":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamExtendedS3DestinationConfigurationS3BackupMode","description":"The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it."}},"type":"object","required":["bucketArn","roleArn"]},"aws-native:kinesisfirehose:DeliveryStreamExtendedS3DestinationConfigurationCompressionFormat":{"description":"The compression format. If no value is specified, the default is `UNCOMPRESSED` .","type":"string","enum":[{"name":"Uncompressed","value":"UNCOMPRESSED"},{"name":"Gzip","value":"GZIP"},{"name":"Zip","value":"ZIP"},{"name":"Snappy","value":"Snappy"},{"name":"HadoopSnappy","value":"HADOOP_SNAPPY"}]},"aws-native:kinesisfirehose:DeliveryStreamExtendedS3DestinationConfigurationS3BackupMode":{"description":"The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.","type":"string","enum":[{"name":"Disabled","value":"Disabled"},{"name":"Enabled","value":"Enabled"}]},"aws-native:kinesisfirehose:DeliveryStreamHiveJsonSerDe":{"properties":{"timestampFormats":{"type":"array","items":{"type":"string"},"description":"Indicates how you want Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see [Class DateTimeFormat](https://docs.aws.amazon.com/https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html) . You can also use the special value `millis` to parse timestamps in epoch milliseconds. If you don't specify a format, Firehose uses `java.sql.Timestamp::valueOf` by default."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamHttpEndpointCommonAttribute":{"properties":{"attributeName":{"type":"string","description":"The name of the HTTP endpoint common attribute."},"attributeValue":{"type":"string","description":"The value of the HTTP endpoint common attribute."}},"type":"object","required":["attributeName","attributeValue"]},"aws-native:kinesisfirehose:DeliveryStreamHttpEndpointConfiguration":{"properties":{"accessKey":{"type":"string","description":"The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination."},"name":{"type":"string","description":"The name of the HTTP endpoint selected as the destination."},"url":{"type":"string","description":"The URL of the HTTP endpoint selected as the destination."}},"type":"object","required":["url"]},"aws-native:kinesisfirehose:DeliveryStreamHttpEndpointDestinationConfiguration":{"properties":{"bufferingHints":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamBufferingHints","description":"The buffering options that can be used before data is delivered to the specified destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other."},"cloudWatchLoggingOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamCloudWatchLoggingOptions","description":"Describes the Amazon CloudWatch logging options for your delivery stream."},"endpointConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamHttpEndpointConfiguration","description":"The configuration of the HTTP endpoint selected as the destination."},"processingConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamProcessingConfiguration","description":"Describes the data processing configuration."},"requestConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamHttpEndpointRequestConfiguration","description":"The configuration of the request sent to the HTTP endpoint specified as the destination."},"retryOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamRetryOptions","description":"Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination."},"roleArn":{"type":"string","description":"Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs."},"s3BackupMode":{"type":"string","description":"Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly)."},"s3Configuration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfiguration","description":"Describes the configuration of a destination in Amazon S3."},"secretsManagerConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSecretsManagerConfiguration","description":"The configuration that defines how you access secrets for HTTP Endpoint destination."}},"type":"object","required":["endpointConfiguration","s3Configuration"]},"aws-native:kinesisfirehose:DeliveryStreamHttpEndpointRequestConfiguration":{"properties":{"commonAttributes":{"type":"array","items":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamHttpEndpointCommonAttribute"},"description":"Describes the metadata sent to the HTTP endpoint destination."},"contentEncoding":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamHttpEndpointRequestConfigurationContentEncoding","description":"Kinesis Data Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamHttpEndpointRequestConfigurationContentEncoding":{"description":"Kinesis Data Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Gzip","value":"GZIP"}]},"aws-native:kinesisfirehose:DeliveryStreamIcebergDestinationConfiguration":{"properties":{"appendOnly":{"type":"boolean","description":"Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables.\n\nThe default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery."},"bufferingHints":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamBufferingHints"},"catalogConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamCatalogConfiguration","description":"Configuration describing where the destination Apache Iceberg Tables are persisted.","replaceOnChanges":true},"cloudWatchLoggingOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamCloudWatchLoggingOptions"},"destinationTableConfigurationList":{"type":"array","items":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDestinationTableConfiguration"},"description":"Provides a list of `DestinationTableConfigurations` which Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here."},"processingConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamProcessingConfiguration"},"retryOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamRetryOptions"},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables."},"s3BackupMode":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamIcebergDestinationConfigurations3BackupMode","description":"Describes how Firehose will backup records. Currently,S3 backup only supports `FailedDataOnly` ."},"s3Configuration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfiguration"},"schemaEvolutionConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSchemaEvolutionConfiguration","description":"The configuration to enable automatic schema evolution.\n\nAmazon Data Firehose is in preview release and is subject to change."},"tableCreationConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamTableCreationConfiguration","description":"The configuration to enable automatic table creation.\n\nAmazon Data Firehose is in preview release and is subject to change."}},"type":"object","required":["catalogConfiguration","roleArn","s3Configuration"]},"aws-native:kinesisfirehose:DeliveryStreamIcebergDestinationConfigurations3BackupMode":{"description":"Describes how Firehose will backup records. Currently,S3 backup only supports `FailedDataOnly` .","type":"string","enum":[{"name":"AllData","value":"AllData"},{"name":"FailedDataOnly","value":"FailedDataOnly"}]},"aws-native:kinesisfirehose:DeliveryStreamInputFormatConfiguration":{"properties":{"deserializer":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamDeserializer","description":"Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamKinesisStreamSourceConfiguration":{"properties":{"kinesisStreamArn":{"type":"string","description":"The ARN of the source Kinesis data stream."},"roleArn":{"type":"string","description":"The ARN of the role that provides access to the source Kinesis data stream."}},"type":"object","required":["kinesisStreamArn","roleArn"]},"aws-native:kinesisfirehose:DeliveryStreamKmsEncryptionConfig":{"properties":{"awskmsKeyArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the AWS KMS encryption key that Amazon S3 uses to encrypt data delivered by the Kinesis Data Firehose stream. The key must belong to the same region as the destination S3 bucket."}},"type":"object","required":["awskmsKeyArn"]},"aws-native:kinesisfirehose:DeliveryStreamMskSourceConfiguration":{"properties":{"authenticationConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamAuthenticationConfiguration","description":"The authentication configuration of the Amazon MSK cluster."},"mskClusterArn":{"type":"string","description":"The ARN of the Amazon MSK cluster."},"readFromTimestamp":{"type":"string","description":"The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.\n\nIf you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the `ReadFromTimestamp` parameter to Epoch (1970-01-01T00:00:00Z)."},"topicName":{"type":"string","description":"The topic name within the Amazon MSK cluster."}},"type":"object","required":["authenticationConfiguration","mskClusterArn","topicName"]},"aws-native:kinesisfirehose:DeliveryStreamOpenXJsonSerDe":{"properties":{"caseInsensitive":{"type":"boolean","description":"When set to `true` , which is the default, Firehose converts JSON keys to lowercase before deserializing them."},"columnToJsonKeyMappings":{"type":"object","additionalProperties":{"type":"string"},"description":"Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, `timestamp` is a Hive keyword. If you have a JSON key named `timestamp` , set this parameter to `{\"ts\": \"timestamp\"}` to map this key to a column named `ts` ."},"convertDotsInJsonKeysToUnderscores":{"type":"boolean","description":"When set to `true` , specifies that the names of the keys include dots and that you want Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is \"a.b\", you can define the column name to be \"a_b\" when using this option.\n\nThe default is `false` ."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamOrcSerDe":{"properties":{"blockSizeBytes":{"type":"integer","description":"The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations."},"bloomFilterColumns":{"type":"array","items":{"type":"string"},"description":"The column names for which you want Firehose to create bloom filters. The default is `null` ."},"bloomFilterFalsePositiveProbability":{"type":"number","description":"The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1."},"compression":{"type":"string","description":"The compression code to use over data blocks. The default is `SNAPPY` ."},"dictionaryKeyThreshold":{"type":"number","description":"Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1."},"enablePadding":{"type":"boolean","description":"Set this to `true` to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is `false` ."},"formatVersion":{"type":"string","description":"The version of the file to write. The possible values are `V0_11` and `V0_12` . The default is `V0_12` ."},"paddingTolerance":{"type":"number","description":"A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.\n\nFor the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.\n\nKinesis Data Firehose ignores this parameter when `EnablePadding` is `false` ."},"rowIndexStride":{"type":"integer","description":"The number of rows between index entries. The default is 10,000 and the minimum is 1,000."},"stripeSizeBytes":{"type":"integer","description":"The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamOutputFormatConfiguration":{"properties":{"serializer":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSerializer","description":"Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamParquetSerDe":{"properties":{"blockSizeBytes":{"type":"integer","description":"The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations."},"compression":{"type":"string","description":"The compression code to use over data blocks. The possible values are `UNCOMPRESSED` , `SNAPPY` , and `GZIP` , with the default being `SNAPPY` . Use `SNAPPY` for higher decompression speed. Use `GZIP` if the compression ratio is more important than speed."},"enableDictionaryCompression":{"type":"boolean","description":"Indicates whether to enable dictionary compression."},"maxPaddingBytes":{"type":"integer","description":"The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0."},"pageSizeBytes":{"type":"integer","description":"The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB."},"writerVersion":{"type":"string","description":"Indicates the version of row format to output. The possible values are `V1` and `V2` . The default is `V1` ."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamPartitionField":{"properties":{"sourceName":{"type":"string"}},"type":"object","required":["sourceName"]},"aws-native:kinesisfirehose:DeliveryStreamProcessingConfiguration":{"properties":{"enabled":{"type":"boolean","description":"Indicates whether data processing is enabled (true) or disabled (false)."},"processors":{"type":"array","items":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamProcessor"},"description":"The data processors."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamProcessor":{"properties":{"parameters":{"type":"array","items":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamProcessorParameter"},"description":"The processor parameters."},"type":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamProcessorType","description":"The type of processor. Valid values: `Lambda` ."}},"type":"object","required":["type"]},"aws-native:kinesisfirehose:DeliveryStreamProcessorParameter":{"properties":{"parameterName":{"type":"string","description":"The name of the parameter. Currently the following default values are supported: 3 for `NumberOfRetries` and 60 for the `BufferIntervalInSeconds` . The `BufferSizeInMBs` ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB."},"parameterValue":{"type":"string","description":"The parameter value."}},"type":"object","required":["parameterName","parameterValue"]},"aws-native:kinesisfirehose:DeliveryStreamProcessorType":{"description":"The type of processor. Valid values: `Lambda` .","type":"string","enum":[{"name":"RecordDeAggregation","value":"RecordDeAggregation"},{"name":"Decompression","value":"Decompression"},{"name":"CloudWatchLogProcessing","value":"CloudWatchLogProcessing"},{"name":"Lambda","value":"Lambda"},{"name":"MetadataExtraction","value":"MetadataExtraction"},{"name":"AppendDelimiterToRecord","value":"AppendDelimiterToRecord"}]},"aws-native:kinesisfirehose:DeliveryStreamRedshiftDestinationConfiguration":{"properties":{"cloudWatchLoggingOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamCloudWatchLoggingOptions","description":"The CloudWatch logging options for your Firehose stream."},"clusterJdbcurl":{"type":"string","description":"The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster."},"copyCommand":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamCopyCommand","description":"Configures the Amazon Redshift `COPY` command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket."},"password":{"type":"string","description":"The password for the Amazon Redshift user that you specified in the `Username` property."},"processingConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamProcessingConfiguration","description":"The data processing configuration for the Kinesis Data Firehose delivery stream."},"retryOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamRedshiftRetryOptions","description":"The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes)."},"roleArn":{"type":"string","description":"The ARN of the AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption). For more information, see [Grant Kinesis Data Firehose Access to an Amazon Redshift Destination](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-rs) in the *Amazon Kinesis Data Firehose Developer Guide* ."},"s3BackupConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfiguration","description":"The configuration for backup in Amazon S3."},"s3BackupMode":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamRedshiftDestinationConfigurationS3BackupMode","description":"The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it."},"s3Configuration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfiguration","description":"The S3 bucket where Kinesis Data Firehose first delivers data. After the data is in the bucket, Kinesis Data Firehose uses the `COPY` command to load the data into the Amazon Redshift cluster. For the Amazon S3 bucket's compression format, don't specify `SNAPPY` or `ZIP` because the Amazon Redshift `COPY` command doesn't support them."},"secretsManagerConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSecretsManagerConfiguration","description":"The configuration that defines how you access secrets for Amazon Redshift."},"username":{"type":"string","description":"The Amazon Redshift user that has permission to access the Amazon Redshift cluster. This user must have `INSERT` privileges for copying data from the Amazon S3 bucket to the cluster."}},"type":"object","required":["clusterJdbcurl","copyCommand","roleArn","s3Configuration"]},"aws-native:kinesisfirehose:DeliveryStreamRedshiftDestinationConfigurationS3BackupMode":{"description":"The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.","type":"string","enum":[{"name":"Disabled","value":"Disabled"},{"name":"Enabled","value":"Enabled"}]},"aws-native:kinesisfirehose:DeliveryStreamRedshiftRetryOptions":{"properties":{"durationInSeconds":{"type":"integer","description":"The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of `DurationInSeconds` is 0 (zero) or if the first delivery attempt takes longer than the current value."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamRetryOptions":{"properties":{"durationInSeconds":{"type":"integer","description":"The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfiguration":{"properties":{"bucketArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon S3 bucket to send data to."},"bufferingHints":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamBufferingHints","description":"Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket."},"cloudWatchLoggingOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamCloudWatchLoggingOptions","description":"The CloudWatch logging options for your Firehose stream."},"compressionFormat":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfigurationCompressionFormat","description":"The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket. For valid values, see the `CompressionFormat` content for the [S3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_S3DestinationConfiguration.html) data type in the *Amazon Kinesis Data Firehose API Reference* ."},"encryptionConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamEncryptionConfiguration","description":"Configures Amazon Simple Storage Service (Amazon S3) server-side encryption. Kinesis Data Firehose uses AWS Key Management Service ( AWS KMS) to encrypt the data that it delivers to your Amazon S3 bucket."},"errorOutputPrefix":{"type":"string","description":"A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see [Custom Prefixes for Amazon S3 Objects](https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html) ."},"prefix":{"type":"string","description":"A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket. The prefix helps you identify the files that Kinesis Data Firehose delivered."},"roleArn":{"type":"string","description":"The ARN of an AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption). For more information, see [Grant Kinesis Data Firehose Access to an Amazon S3 Destination](https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) in the *Amazon Kinesis Data Firehose Developer Guide* ."}},"type":"object","required":["bucketArn","roleArn"]},"aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfigurationCompressionFormat":{"description":"The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket. For valid values, see the `CompressionFormat` content for the [S3DestinationConfiguration](https://docs.aws.amazon.com/firehose/latest/APIReference/API_S3DestinationConfiguration.html) data type in the *Amazon Kinesis Data Firehose API Reference* .","type":"string","enum":[{"name":"Uncompressed","value":"UNCOMPRESSED"},{"name":"Gzip","value":"GZIP"},{"name":"Zip","value":"ZIP"},{"name":"Snappy","value":"Snappy"},{"name":"HadoopSnappy","value":"HADOOP_SNAPPY"}]},"aws-native:kinesisfirehose:DeliveryStreamSchemaConfiguration":{"properties":{"catalogId":{"type":"string","description":"The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default."},"databaseName":{"type":"string","description":"Specifies the name of the AWS Glue database that contains the schema for the output data.\n\n\u003e If the `SchemaConfiguration` request parameter is used as part of invoking the `CreateDeliveryStream` API, then the `DatabaseName` property is required and its value must be specified."},"region":{"type":"string","description":"If you don't specify an AWS Region, the default is the current Region."},"roleArn":{"type":"string","description":"The role that Firehose can use to access AWS Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.\n\n\u003e If the `SchemaConfiguration` request parameter is used as part of invoking the `CreateDeliveryStream` API, then the `RoleARN` property is required and its value must be specified."},"tableName":{"type":"string","description":"Specifies the AWS Glue table that contains the column information that constitutes your data schema.\n\n\u003e If the `SchemaConfiguration` request parameter is used as part of invoking the `CreateDeliveryStream` API, then the `TableName` property is required and its value must be specified."},"versionId":{"type":"string","description":"Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to `LATEST` , Firehose uses the most recent version. This means that any updates to the table are automatically picked up."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamSchemaEvolutionConfiguration":{"properties":{"enabled":{"type":"boolean","description":"Specify whether you want to enable schema evolution.\n\nAmazon Data Firehose is in preview release and is subject to change."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamSecretsManagerConfiguration":{"properties":{"enabled":{"type":"boolean","description":"Specifies whether you want to use the secrets manager feature. When set as `True` the secrets manager configuration overwrites the existing secrets in the destination configuration. When it's set to `False` Firehose falls back to the credentials in the destination configuration."},"roleArn":{"type":"string","description":"Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk."},"secretArn":{"type":"string","description":"The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the role. The secret ARN can reside in a different account than the Firehose stream and role as Firehose supports cross-account secret access. This parameter is required when *Enabled* is set to `True` ."}},"type":"object","required":["enabled"]},"aws-native:kinesisfirehose:DeliveryStreamSerializer":{"properties":{"orcSerDe":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamOrcSerDe","description":"A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see [Apache ORC](https://docs.aws.amazon.com/https://orc.apache.org/docs/) ."},"parquetSerDe":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamParquetSerDe","description":"A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see [Apache Parquet](https://docs.aws.amazon.com/https://parquet.apache.org/docs/contribution-guidelines/) ."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamSnowflakeBufferingHints":{"properties":{"intervalInSeconds":{"type":"integer","description":"Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 0."},"sizeInMbs":{"type":"integer","description":"Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 128."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamSnowflakeDestinationConfiguration":{"properties":{"accountUrl":{"type":"string","description":"URL for accessing your Snowflake account. This URL must include your [account identifier](https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/admin-account-identifier) . Note that the protocol (https://) and port number are optional."},"bufferingHints":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSnowflakeBufferingHints","description":"Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values."},"cloudWatchLoggingOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamCloudWatchLoggingOptions"},"contentColumnName":{"type":"string","description":"The name of the record content column."},"dataLoadingOption":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSnowflakeDestinationConfigurationDataLoadingOption","description":"Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column."},"database":{"type":"string","description":"All data in Snowflake is maintained in databases."},"keyPassphrase":{"type":"string","description":"Passphrase to decrypt the private key when the key is encrypted. For information, see [Using Key Pair Authentication \u0026 Key Rotation](https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation) ."},"metaDataColumnName":{"type":"string","description":"Specify a column name in the table, where the metadata information has to be loaded. When you enable this field, you will see the following column in the snowflake table, which differs based on the source type.\n\nFor Direct PUT as source\n\n`{ \"firehoseDeliveryStreamName\" : \"streamname\", \"IngestionTime\" : \"timestamp\" }`\n\nFor Kinesis Data Stream as source\n\n`\"kinesisStreamName\" : \"streamname\", \"kinesisShardId\" : \"Id\", \"kinesisPartitionKey\" : \"key\", \"kinesisSequenceNumber\" : \"1234\", \"subsequenceNumber\" : \"2334\", \"IngestionTime\" : \"timestamp\" }`"},"privateKey":{"type":"string","description":"The private key used to encrypt your Snowflake client. For information, see [Using Key Pair Authentication \u0026 Key Rotation](https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation) ."},"processingConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamProcessingConfiguration"},"retryOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSnowflakeRetryOptions","description":"The time period where Firehose will retry sending data to the chosen HTTP endpoint."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Snowflake role"},"s3BackupMode":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSnowflakeDestinationConfigurationS3BackupMode","description":"Choose an S3 backup mode"},"s3Configuration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfiguration"},"schema":{"type":"string","description":"Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views"},"secretsManagerConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSecretsManagerConfiguration","description":"The configuration that defines how you access secrets for Snowflake."},"snowflakeRoleConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSnowflakeRoleConfiguration","description":"Optionally configure a Snowflake role. Otherwise the default user role will be used."},"snowflakeVpcConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSnowflakeVpcConfiguration","description":"The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-\u003c[id]\u003e. For more information, see [Amazon PrivateLink \u0026 Snowflake](https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/admin-security-privatelink)","replaceOnChanges":true},"table":{"type":"string","description":"All data in Snowflake is stored in database tables, logically structured as collections of columns and rows."},"user":{"type":"string","description":"User login name for the Snowflake account."}},"type":"object","required":["accountUrl","database","roleArn","s3Configuration","schema","table"]},"aws-native:kinesisfirehose:DeliveryStreamSnowflakeDestinationConfigurationDataLoadingOption":{"description":"Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.","type":"string","enum":[{"name":"JsonMapping","value":"JSON_MAPPING"},{"name":"VariantContentMapping","value":"VARIANT_CONTENT_MAPPING"},{"name":"VariantContentAndMetadataMapping","value":"VARIANT_CONTENT_AND_METADATA_MAPPING"}]},"aws-native:kinesisfirehose:DeliveryStreamSnowflakeDestinationConfigurationS3BackupMode":{"description":"Choose an S3 backup mode","type":"string","enum":[{"name":"FailedDataOnly","value":"FailedDataOnly"},{"name":"AllData","value":"AllData"}]},"aws-native:kinesisfirehose:DeliveryStreamSnowflakeRetryOptions":{"properties":{"durationInSeconds":{"type":"integer","description":"the time period where Firehose will retry sending data to the chosen HTTP endpoint."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamSnowflakeRoleConfiguration":{"properties":{"enabled":{"type":"boolean","description":"Enable Snowflake role"},"snowflakeRole":{"type":"string","description":"The Snowflake role you wish to configure"}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamSnowflakeVpcConfiguration":{"properties":{"privateLinkVpceId":{"type":"string","description":"The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-\u003c[id]\u003e. For more information, see [Amazon PrivateLink \u0026 Snowflake](https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/admin-security-privatelink)"}},"type":"object","required":["privateLinkVpceId"]},"aws-native:kinesisfirehose:DeliveryStreamSplunkBufferingHints":{"properties":{"intervalInSeconds":{"type":"integer","description":"Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 60 (1 minute)."},"sizeInMbs":{"type":"integer","description":"Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamSplunkDestinationConfiguration":{"properties":{"bufferingHints":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSplunkBufferingHints","description":"The buffering options. If no value is specified, the default values for Splunk are used."},"cloudWatchLoggingOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamCloudWatchLoggingOptions","description":"The Amazon CloudWatch logging options for your Firehose stream."},"hecAcknowledgmentTimeoutInSeconds":{"type":"integer","description":"The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings."},"hecEndpoint":{"type":"string","description":"The HTTP Event Collector (HEC) endpoint to which Firehose sends your data."},"hecEndpointType":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSplunkDestinationConfigurationHecEndpointType","description":"This type can be either `Raw` or `Event` ."},"hecToken":{"type":"string","description":"This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint."},"processingConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamProcessingConfiguration","description":"The data processing configuration."},"retryOptions":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSplunkRetryOptions","description":"The retry behavior in case Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk."},"s3BackupMode":{"type":"string","description":"Defines how documents should be delivered to Amazon S3. When set to `FailedEventsOnly` , Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to `AllEvents` , Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is `FailedEventsOnly` .\n\nYou can update this backup mode from `FailedEventsOnly` to `AllEvents` . You can't update it from `AllEvents` to `FailedEventsOnly` ."},"s3Configuration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamS3DestinationConfiguration","description":"The configuration for the backup Amazon S3 location."},"secretsManagerConfiguration":{"$ref":"#/types/aws-native:kinesisfirehose:DeliveryStreamSecretsManagerConfiguration","description":"The configuration that defines how you access secrets for Splunk."}},"type":"object","required":["hecEndpoint","hecEndpointType","s3Configuration"]},"aws-native:kinesisfirehose:DeliveryStreamSplunkDestinationConfigurationHecEndpointType":{"description":"This type can be either `Raw` or `Event` .","type":"string","enum":[{"name":"Raw","value":"Raw"},{"name":"Event","value":"Event"}]},"aws-native:kinesisfirehose:DeliveryStreamSplunkRetryOptions":{"properties":{"durationInSeconds":{"type":"integer","description":"The total amount of time that Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Firehose waits for acknowledgment from Splunk after each attempt."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamTableCreationConfiguration":{"properties":{"enabled":{"type":"boolean","description":"Specify whether you want to enable automatic table creation.\n\nAmazon Data Firehose is in preview release and is subject to change."}},"type":"object"},"aws-native:kinesisfirehose:DeliveryStreamTag":{"properties":{"key":{"type":"string","description":"A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @"},"value":{"type":"string","description":"An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @"}},"type":"object","required":["key"]},"aws-native:kinesisfirehose:DeliveryStreamType":{"description":"The Firehose stream type. This can be one of the following values:\n\n- `DirectPut` : Provider applications access the Firehose stream directly.\n- `KinesisStreamAsSource` : The Firehose stream uses a Kinesis data stream as a source.","type":"string","enum":[{"name":"DatabaseAsSource","value":"DatabaseAsSource"},{"name":"DirectPut","value":"DirectPut"},{"name":"KinesisStreamAsSource","value":"KinesisStreamAsSource"},{"name":"MskasSource","value":"MSKAsSource"}]},"aws-native:kinesisfirehose:DeliveryStreamVpcConfiguration":{"properties":{"roleArn":{"type":"string","description":"The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data Firehose service principal and that it grants the following permissions:\n\n- `ec2:DescribeVpcs`\n- `ec2:DescribeVpcAttribute`\n- `ec2:DescribeSubnets`\n- `ec2:DescribeSecurityGroups`\n- `ec2:DescribeNetworkInterfaces`\n- `ec2:CreateNetworkInterface`\n- `ec2:CreateNetworkInterfacePermission`\n- `ec2:DeleteNetworkInterface`\n\nIf you revoke these permissions after you create the delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance."},"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The IDs of the security groups that you want Kinesis Data Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.\n\nThe number of ENIs that Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here."}},"type":"object","required":["roleArn","securityGroupIds","subnetIds"]},"aws-native:kinesisvideo:SignalingChannelTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.  The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:kinesisvideo:SignalingChannelType":{"description":"The type of the Kinesis Video Signaling Channel to create. Currently, SINGLE_MASTER is the only supported channel type.","type":"string","enum":[{"name":"SingleMaster","value":"SINGLE_MASTER"}]},"aws-native:kinesisvideo:StreamStorageConfiguration":{"description":"Configuration for the storage tier of the Kinesis Video Stream.","properties":{"defaultStorageTier":{"$ref":"#/types/aws-native:kinesisvideo:StreamStorageConfigurationDefaultStorageTier","description":"The storage tier for the Kinesis Video Stream. Determines the storage class used for stream data."}},"type":"object"},"aws-native:kinesisvideo:StreamStorageConfigurationDefaultStorageTier":{"description":"The storage tier for the Kinesis Video Stream. Determines the storage class used for stream data.","type":"string","enum":[{"name":"Hot","value":"HOT"},{"name":"Warm","value":"WARM"}]},"aws-native:kinesisvideo:StreamTag":{"description":"A key-value pair to associated with the Kinesis Video Stream.","properties":{"key":{"type":"string","description":"The key name of the tag. Specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. Specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. The following characters can be used: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:kms:KeyOrigin":{"description":"The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material.\n To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*.\n You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. \n   +  CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values.\n  +  ``EXTERNAL`` is not supported for ML-DSA keys.","type":"string","enum":[{"name":"AwsKms","value":"AWS_KMS"},{"name":"External","value":"EXTERNAL"}]},"aws-native:kms:KeySpec":{"description":"Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*.\n The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*.\n  If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n   [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*.\n  KMS supports the following key specs for KMS keys:\n  +  Symmetric encryption key (default)\n  +  ``SYMMETRIC_DEFAULT`` (AES-256-GCM)\n  \n  +  HMAC keys (symmetric)\n  +   ``HMAC_224`` \n  +   ``HMAC_256`` \n  +   ``HMAC_384`` \n  +   ``HMAC_512`` \n  \n  +  Asymmetric RSA key pairs (encryption and decryption *or* signing and verification)\n  +   ``RSA_2048`` \n  +   ``RSA_3072`` \n  +   ``RSA_4096`` \n  \n  +  Asymmetric NIST-recommended elliptic curve key pairs (signing and verification *or* deriving shared secrets)\n  +  ``ECC_NIST_P256`` (secp256r1)\n  +  ``ECC_NIST_P384`` (secp384r1)\n  +  ``ECC_NIST_P521`` (secp521r1)\n  +  ``ECC_NIST_EDWARDS25519`` (ed25519) - signing and verification only\n  +  *Note:* For ECC_NIST_EDWARDS25519 KMS keys, the ED25519_SHA_512 signing algorithm requires [MessageType:RAW](https://docs.aws.amazon.com/kms/latest/APIReference/API_Sign.html#KMS-Sign-request-MessageType), while ED25519_PH_SHA_512 requires [MessageType:DIGEST](https://docs.aws.amazon.com/kms/latest/APIReference/API_Sign.html#KMS-Sign-request-MessageType). These message types cannot be used interchangeably.\n  \n  \n  +  Other asymmetric elliptic curve key pairs (signing and verification)\n  +  ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies.\n  \n  +  Asymmetric ML-DSA key pairs (signing and verification)\n  +   ``ML_DSA_44`` \n  +   ``ML_DSA_65`` \n  +   ``ML_DSA_87`` \n  \n  +  SM2 key pairs (encryption and decryption *or* signing and verification *or* deriving shared secrets)\n  +  ``SM2`` (China Regions only)","type":"string","enum":[{"name":"SymmetricDefault","value":"SYMMETRIC_DEFAULT"},{"name":"Rsa2048","value":"RSA_2048"},{"name":"Rsa3072","value":"RSA_3072"},{"name":"Rsa4096","value":"RSA_4096"},{"name":"EccNistP256","value":"ECC_NIST_P256"},{"name":"EccNistP384","value":"ECC_NIST_P384"},{"name":"EccNistP521","value":"ECC_NIST_P521"},{"name":"EccSecgP256k1","value":"ECC_SECG_P256K1"},{"name":"Hmac224","value":"HMAC_224"},{"name":"Hmac256","value":"HMAC_256"},{"name":"Hmac384","value":"HMAC_384"},{"name":"Hmac512","value":"HMAC_512"},{"name":"Sm2","value":"SM2"},{"name":"MlDsa44","value":"ML_DSA_44"},{"name":"MlDsa65","value":"ML_DSA_65"},{"name":"MlDsa87","value":"ML_DSA_87"},{"name":"EccNistEdwards25519","value":"ECC_NIST_EDWARDS25519"}]},"aws-native:kms:KeyTag":{"description":"A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.\n  Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.\n  For information about the rules that apply to tag keys and tag values, see [User-Defined Tag Restrictions](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) in the *Billing and Cost Management User Guide*.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with ``aws:``. digits, whitespace, ``_``, ``.``, ``:``, ``/``, ``=``, ``+``, ``@``, ``-``, and ``\"``.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)."},"value":{"type":"string","description":"The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, ``_``, ``.``, ``/``, ``=``, ``+``, and ``-``.\n For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)."}},"type":"object","required":["key","value"]},"aws-native:kms:KeyUsage":{"description":"Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created.\n  If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value.\n  Select only one valid value.\n  +  For symmetric encryption KMS keys, omit the parameter or specify ``ENCRYPT_DECRYPT``.\n  +  For HMAC KMS keys (symmetric), specify ``GENERATE_VERIFY_MAC``.\n  +  For asymmetric KMS keys with RSA key pairs, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``.\n  +  For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify ``SIGN_VERIFY`` or ``KEY_AGREEMENT``.\n  +  For asymmetric KMS keys with ``ECC_SECG_P256K1`` key pairs, specify ``SIGN_VERIFY``.\n  +  For asymmetric KMS keys with ML-DSA key pairs, specify ``SIGN_VERIFY``.\n  +  For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ``ENCRYPT_DECRYPT``, ``SIGN_VERIFY``, or ``KEY_AGREEMENT``.","type":"string","enum":[{"name":"EncryptDecrypt","value":"ENCRYPT_DECRYPT"},{"name":"SignVerify","value":"SIGN_VERIFY"},{"name":"GenerateVerifyMac","value":"GENERATE_VERIFY_MAC"},{"name":"KeyAgreement","value":"KEY_AGREEMENT"}]},"aws-native:kms:ReplicaKeyTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:lakeformation:DataCellsFilterColumnWildcard":{"description":"An object representing the Data Cells Filter's Columns. Either Column Names or a Wildcard is required.","properties":{"excludedColumnNames":{"type":"array","items":{"type":"string"},"description":"A list of column names to be excluded from the Data Cells Filter."}},"type":"object"},"aws-native:lakeformation:DataCellsFilterRowFilter":{"description":"An object representing the Data Cells Filter's Row Filter. Either a Filter Expression or a Wildcard is required.","properties":{"allRowsWildcard":{"$ref":"pulumi.json#/Any","description":"An empty object representing a row wildcard."},"filterExpression":{"type":"string","description":"A PartiQL predicate."}},"type":"object"},"aws-native:lakeformation:PrincipalPermissionsCatalogResource":{"type":"object"},"aws-native:lakeformation:PrincipalPermissionsColumnWildcard":{"description":"A wildcard object, consisting of an optional list of excluded column names or indexes.","properties":{"excludedColumnNames":{"type":"array","items":{"type":"string"},"description":"Excludes column names. Any column with this name will be excluded."}},"type":"object"},"aws-native:lakeformation:PrincipalPermissionsDataCellsFilterResource":{"description":"A structure that describes certain columns on certain rows.","properties":{"databaseName":{"type":"string","description":"A database in the GLUDC."},"name":{"type":"string","description":"The name given by the user to the data filter cell."},"tableCatalogId":{"type":"string","description":"The ID of the catalog to which the table belongs."},"tableName":{"type":"string","description":"The name of the table."}},"type":"object","required":["databaseName","name","tableCatalogId","tableName"]},"aws-native:lakeformation:PrincipalPermissionsDataLakePrincipal":{"description":"The LFlong principal.","properties":{"dataLakePrincipalIdentifier":{"type":"string","description":"An identifier for the LFlong principal."}},"type":"object"},"aws-native:lakeformation:PrincipalPermissionsDataLocationResource":{"description":"A structure for a data location object where permissions are granted or revoked.","properties":{"catalogId":{"type":"string","description":"The identifier for the GLUDC where the location is registered with LFlong."},"resourceArn":{"type":"string","description":"The Amazon Resource Name (ARN) that uniquely identifies the data location resource."}},"type":"object","required":["catalogId","resourceArn"]},"aws-native:lakeformation:PrincipalPermissionsDatabaseResource":{"description":"A structure for the database object.","properties":{"catalogId":{"type":"string","description":"The identifier for the Data Catalog. By default, it is the account ID of the caller."},"name":{"type":"string","description":"The name of the database resource. Unique to the Data Catalog."}},"type":"object","required":["catalogId","name"]},"aws-native:lakeformation:PrincipalPermissionsLfTag":{"description":"The LF-tag key and values attached to a resource.","properties":{"tagKey":{"type":"string","description":"The key-name for the LF-tag."},"tagValues":{"type":"array","items":{"type":"string"},"description":"A list of possible values of the corresponding ``TagKey`` of an LF-tag key-value pair."}},"type":"object"},"aws-native:lakeformation:PrincipalPermissionsLfTagKeyResource":{"description":"A structure containing an LF-tag key and values for a resource.","properties":{"catalogId":{"type":"string","description":"The identifier for the GLUDC where the location is registered with GLUDC."},"tagKey":{"type":"string","description":"The key-name for the LF-tag."},"tagValues":{"type":"array","items":{"type":"string"},"description":"A list of possible values for the corresponding ``TagKey`` of an LF-tag key-value pair."}},"type":"object","required":["catalogId","tagKey","tagValues"]},"aws-native:lakeformation:PrincipalPermissionsLfTagPolicyResource":{"description":"A list of LF-tag conditions that define a resource's LF-tag policy.\n A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag 'PII' in tables that have the LF-tag 'Prod'.","properties":{"catalogId":{"type":"string","description":"The identifier for the GLUDC. The GLUDC is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your LFlong environment."},"expression":{"type":"array","items":{"$ref":"#/types/aws-native:lakeformation:PrincipalPermissionsLfTag"},"description":"A list of LF-tag conditions that apply to the resource's LF-tag policy."},"resourceType":{"$ref":"#/types/aws-native:lakeformation:PrincipalPermissionsResourceType","description":"The resource type for which the LF-tag policy applies."}},"type":"object","required":["catalogId","expression","resourceType"]},"aws-native:lakeformation:PrincipalPermissionsPermission":{"type":"string","enum":[{"name":"All","value":"ALL"},{"name":"Select","value":"SELECT"},{"name":"Alter","value":"ALTER"},{"name":"Drop","value":"DROP"},{"name":"Delete","value":"DELETE"},{"name":"Insert","value":"INSERT"},{"name":"Describe","value":"DESCRIBE"},{"name":"CreateDatabase","value":"CREATE_DATABASE"},{"name":"CreateTable","value":"CREATE_TABLE"},{"name":"DataLocationAccess","value":"DATA_LOCATION_ACCESS"},{"name":"CreateLfTag","value":"CREATE_LF_TAG"},{"name":"Associate","value":"ASSOCIATE"},{"name":"GrantWithLfTagExpression","value":"GRANT_WITH_LF_TAG_EXPRESSION"}]},"aws-native:lakeformation:PrincipalPermissionsResource":{"description":"A structure for the resource.","properties":{"catalog":{"$ref":"#/types/aws-native:lakeformation:PrincipalPermissionsCatalogResource","description":"The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your LFlong environment."},"dataCellsFilter":{"$ref":"#/types/aws-native:lakeformation:PrincipalPermissionsDataCellsFilterResource","description":"A data cell filter."},"dataLocation":{"$ref":"#/types/aws-native:lakeformation:PrincipalPermissionsDataLocationResource","description":"The location of an Amazon S3 path where permissions are granted or revoked."},"database":{"$ref":"#/types/aws-native:lakeformation:PrincipalPermissionsDatabaseResource","description":"The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal."},"lfTag":{"$ref":"#/types/aws-native:lakeformation:PrincipalPermissionsLfTagKeyResource","description":"The LF-tag key and values attached to a resource."},"lfTagPolicy":{"$ref":"#/types/aws-native:lakeformation:PrincipalPermissionsLfTagPolicyResource","description":"A list of LF-tag conditions that define a resource's LF-tag policy."},"table":{"$ref":"#/types/aws-native:lakeformation:PrincipalPermissionsTableResource","description":"The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal."},"tableWithColumns":{"$ref":"#/types/aws-native:lakeformation:PrincipalPermissionsTableWithColumnsResource","description":"The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3."}},"type":"object"},"aws-native:lakeformation:PrincipalPermissionsResourceType":{"type":"string","enum":[{"name":"Database","value":"DATABASE"},{"name":"Table","value":"TABLE"}]},"aws-native:lakeformation:PrincipalPermissionsTableResource":{"description":"A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.","properties":{"catalogId":{"type":"string","description":"The identifier for the Data Catalog. By default, it is the account ID of the caller."},"databaseName":{"type":"string","description":"The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal."},"name":{"type":"string","description":"The name of the table."},"tableWildcard":{"$ref":"#/types/aws-native:lakeformation:PrincipalPermissionsTableWildcard","description":"A wildcard object representing every table under a database.\n At least one of ``TableResource$Name`` or ``TableResource$TableWildcard`` is required."}},"type":"object","required":["catalogId","databaseName"]},"aws-native:lakeformation:PrincipalPermissionsTableWildcard":{"type":"object"},"aws-native:lakeformation:PrincipalPermissionsTableWithColumnsResource":{"description":"A structure for a table with columns object. This object is only used when granting a SELECT permission.\n This object must take a value for at least one of ``ColumnsNames``, ``ColumnsIndexes``, or ``ColumnsWildcard``.","properties":{"catalogId":{"type":"string","description":"The identifier for the GLUDC where the location is registered with LFlong."},"columnNames":{"type":"array","items":{"type":"string"},"description":"The list of column names for the table. At least one of ``ColumnNames`` or ``ColumnWildcard`` is required."},"columnWildcard":{"$ref":"#/types/aws-native:lakeformation:PrincipalPermissionsColumnWildcard","description":"A wildcard specified by a ``ColumnWildcard`` object. At least one of ``ColumnNames`` or ``ColumnWildcard`` is required."},"databaseName":{"type":"string","description":"The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal."},"name":{"type":"string","description":"The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal."}},"type":"object","required":["catalogId","databaseName","name"]},"aws-native:lakeformation:TagAssociationCatalogResource":{"type":"object"},"aws-native:lakeformation:TagAssociationDatabaseResource":{"properties":{"catalogId":{"type":"string","description":"The identifier for the Data Catalog . By default, it should be the account ID of the caller."},"name":{"type":"string","description":"The name of the database resource. Unique to the Data Catalog."}},"type":"object","required":["catalogId","name"]},"aws-native:lakeformation:TagAssociationLfTagPair":{"properties":{"catalogId":{"type":"string"},"tagKey":{"type":"string"},"tagValues":{"type":"array","items":{"type":"string"}}},"type":"object","required":["catalogId","tagKey","tagValues"]},"aws-native:lakeformation:TagAssociationResource":{"properties":{"catalog":{"$ref":"#/types/aws-native:lakeformation:TagAssociationCatalogResource","description":"The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment."},"database":{"$ref":"#/types/aws-native:lakeformation:TagAssociationDatabaseResource","description":"The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal."},"table":{"$ref":"#/types/aws-native:lakeformation:TagAssociationTableResource","description":"The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal."},"tableWithColumns":{"$ref":"#/types/aws-native:lakeformation:TagAssociationTableWithColumnsResource","description":"The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3."}},"type":"object"},"aws-native:lakeformation:TagAssociationTableResource":{"properties":{"catalogId":{"type":"string","description":"The identifier for the Data Catalog . By default, it is the account ID of the caller."},"databaseName":{"type":"string","description":"The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal."},"name":{"type":"string","description":"The name of the table."},"tableWildcard":{"$ref":"#/types/aws-native:lakeformation:TagAssociationTableWildcard","description":"A wildcard object representing every table under a database.This is an object with no properties that effectively behaves as a true or false depending on whether not it is passed as a parameter. The valid inputs for a property with this type in either yaml or json is null or {}.\n\nAt least one of `TableResource$Name` or `TableResource$TableWildcard` is required."}},"type":"object","required":["catalogId","databaseName"]},"aws-native:lakeformation:TagAssociationTableWildcard":{"type":"object"},"aws-native:lakeformation:TagAssociationTableWithColumnsResource":{"properties":{"catalogId":{"type":"string","description":"A wildcard object representing every table under a database.\n\nAt least one of TableResource$Name or TableResource$TableWildcard is required."},"columnNames":{"type":"array","items":{"type":"string"},"description":"The list of column names for the table. At least one of `ColumnNames` or `ColumnWildcard` is required."},"databaseName":{"type":"string","description":"The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal."},"name":{"type":"string","description":"The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal."}},"type":"object","required":["catalogId","columnNames","databaseName","name"]},"aws-native:lambda:AliasProvisionedConcurrencyConfiguration":{"description":"A provisioned concurrency configuration for a function's alias.","properties":{"provisionedConcurrentExecutions":{"type":"integer","description":"The amount of provisioned concurrency to allocate for the alias."}},"type":"object","required":["provisionedConcurrentExecutions"]},"aws-native:lambda:AliasRoutingConfiguration":{"description":"The traffic-shifting configuration of a Lambda function alias.","properties":{"additionalVersionWeights":{"type":"array","items":{"$ref":"#/types/aws-native:lambda:AliasVersionWeight"},"description":"The second version, and the percentage of traffic that's routed to it."}},"type":"object"},"aws-native:lambda:AliasVersionWeight":{"description":"The traffic-shifting configuration of a Lambda function alias.","properties":{"functionVersion":{"type":"string","description":"The qualifier of the second version."},"functionWeight":{"type":"number","description":"The percentage of traffic that the alias routes to the second version."}},"type":"object","required":["functionVersion","functionWeight"]},"aws-native:lambda:CapacityProviderArchitecture":{"description":"Specifications for the types of EC2 instances that the capacity provider can use.","type":"string","enum":[{"name":"X8664","value":"x86_64"},{"name":"Arm64","value":"arm64"}]},"aws-native:lambda:CapacityProviderInstanceRequirements":{"description":"Specifications that define the characteristics and constraints for compute instances used by the capacity provider.","properties":{"allowedInstanceTypes":{"type":"array","items":{"type":"string"},"description":"A list of EC2 instance types that the capacity provider is allowed to use. If not specified, all compatible instance types are allowed."},"architectures":{"type":"array","items":{"$ref":"#/types/aws-native:lambda:CapacityProviderArchitecture"},"description":"A list of supported CPU architectures for compute instances. Valid values include ``x86_64`` and ``arm64``."},"excludedInstanceTypes":{"type":"array","items":{"type":"string"},"description":"A list of EC2 instance types that the capacity provider should not use, even if they meet other requirements."}},"type":"object"},"aws-native:lambda:CapacityProviderPermissionsConfig":{"description":"Configuration that specifies the permissions required for the capacity provider to manage compute resources.","properties":{"capacityProviderOperatorRoleArn":{"type":"string","description":"The ARN of the IAM role that the capacity provider uses to manage compute instances and other AWS resources."}},"type":"object","required":["capacityProviderOperatorRoleArn"]},"aws-native:lambda:CapacityProviderPredefinedMetricType":{"description":"The predefined metric for target tracking.","type":"string","enum":[{"name":"LambdaCapacityProviderAverageCpuUtilization","value":"LambdaCapacityProviderAverageCPUUtilization"}]},"aws-native:lambda:CapacityProviderScalingConfig":{"description":"Configuration that defines how the capacity provider scales compute instances based on demand and policies.","properties":{"maxVCpuCount":{"type":"integer","description":"The maximum number of vCPUs that the capacity provider can provision across all compute instances."},"scalingMode":{"$ref":"#/types/aws-native:lambda:CapacityProviderScalingMode","description":"The scaling mode that determines how the capacity provider responds to changes in demand."},"scalingPolicies":{"type":"array","items":{"$ref":"#/types/aws-native:lambda:CapacityProviderTargetTrackingScalingPolicy"},"description":"A list of target tracking scaling policies for the capacity provider."}},"type":"object"},"aws-native:lambda:CapacityProviderScalingMode":{"description":"The scaling mode for the capacity provider.","type":"string","enum":[{"name":"Auto","value":"Auto"},{"name":"Manual","value":"Manual"}]},"aws-native:lambda:CapacityProviderState":{"description":"The current state of the capacity provider. Indicates whether the provider is being created, is active and ready for use, has failed, or is being deleted.","type":"string","enum":[{"name":"Pending","value":"Pending"},{"name":"Active","value":"Active"},{"name":"Failed","value":"Failed"},{"name":"Deleting","value":"Deleting"}]},"aws-native:lambda:CapacityProviderTag":{"description":"A key-value pair that provides metadata for the capacity provider.","properties":{"key":{"type":"string","description":"The key name of the tag."},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key"]},"aws-native:lambda:CapacityProviderTargetTrackingScalingPolicy":{"description":"A scaling policy for the capacity provider that automatically adjusts capacity to maintain a target value for a specific metric.","properties":{"predefinedMetricType":{"$ref":"#/types/aws-native:lambda:CapacityProviderPredefinedMetricType","description":"The predefined metric type to track for scaling decisions."},"targetValue":{"type":"number","description":"The target value for the metric that the scaling policy attempts to maintain through scaling actions."}},"type":"object","required":["predefinedMetricType","targetValue"]},"aws-native:lambda:CapacityProviderVpcConfig":{"description":"VPC configuration that specifies the network settings for compute instances managed by the capacity provider.","properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"A list of security group IDs that control network access for compute instances managed by the capacity provider."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"A list of subnet IDs where the capacity provider launches compute instances."}},"type":"object","required":["securityGroupIds","subnetIds"]},"aws-native:lambda:CodeSigningConfigAllowedPublishers":{"description":"When the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list","properties":{"signingProfileVersionArns":{"type":"array","items":{"type":"string"},"description":"List of Signing profile version Arns"}},"type":"object","required":["signingProfileVersionArns"]},"aws-native:lambda:CodeSigningConfigCodeSigningPolicies":{"description":"Policies to control how to act if a signature is invalid","properties":{"untrustedArtifactOnDeployment":{"$ref":"#/types/aws-native:lambda:CodeSigningConfigCodeSigningPoliciesUntrustedArtifactOnDeployment","description":"Indicates how Lambda operations involve updating the code artifact will operate. Default to Warn if not provided"}},"type":"object","required":["untrustedArtifactOnDeployment"]},"aws-native:lambda:CodeSigningConfigCodeSigningPoliciesUntrustedArtifactOnDeployment":{"description":"Indicates how Lambda operations involve updating the code artifact will operate. Default to Warn if not provided","type":"string","enum":[{"name":"Warn","value":"Warn"},{"name":"Enforce","value":"Enforce"}]},"aws-native:lambda:CodeSigningConfigTag":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:lambda:EventInvokeConfigDestinationConfig":{"description":"A destination for events after they have been sent to a function for processing.","properties":{"onFailure":{"$ref":"#/types/aws-native:lambda:EventInvokeConfigOnFailure","description":"The destination configuration for failed invocations.\n\n\u003e When using an Amazon SQS queue as a destination, FIFO queues cannot be used."},"onSuccess":{"$ref":"#/types/aws-native:lambda:EventInvokeConfigOnSuccess","description":"The destination configuration for successful invocations.\n\n\u003e When using an Amazon SQS queue as a destination, FIFO queues cannot be used."}},"type":"object"},"aws-native:lambda:EventInvokeConfigOnFailure":{"description":"The destination configuration for failed invocations.","properties":{"destination":{"type":"string","description":"The Amazon Resource Name (ARN) of the destination resource."}},"type":"object","required":["destination"]},"aws-native:lambda:EventInvokeConfigOnSuccess":{"description":"The destination configuration for successful invocations.","properties":{"destination":{"type":"string","description":"The Amazon Resource Name (ARN) of the destination resource."}},"type":"object","required":["destination"]},"aws-native:lambda:EventSourceMappingAmazonManagedKafkaEventSourceConfig":{"description":"Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.","properties":{"consumerGroupId":{"type":"string","description":"The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id)."},"schemaRegistryConfig":{"$ref":"#/types/aws-native:lambda:EventSourceMappingSchemaRegistryConfig","description":"Specific configuration settings for a Kafka schema registry."}},"type":"object"},"aws-native:lambda:EventSourceMappingDestinationConfig":{"description":"A configuration object that specifies the destination of an event after Lambda processes it. For more information, see [Adding a destination](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-async-destinations).","properties":{"onFailure":{"$ref":"#/types/aws-native:lambda:EventSourceMappingOnFailure","description":"The destination configuration for failed invocations."}},"type":"object"},"aws-native:lambda:EventSourceMappingDocumentDbEventSourceConfig":{"description":"Specific configuration settings for a DocumentDB event source.","properties":{"collectionName":{"type":"string","description":"The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections."},"databaseName":{"type":"string","description":"The name of the database to consume within the DocumentDB cluster."},"fullDocument":{"$ref":"#/types/aws-native:lambda:EventSourceMappingDocumentDbEventSourceConfigFullDocument","description":"Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes."}},"type":"object"},"aws-native:lambda:EventSourceMappingDocumentDbEventSourceConfigFullDocument":{"description":"Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.","type":"string","enum":[{"name":"UpdateLookup","value":"UpdateLookup"},{"name":"Default","value":"Default"}]},"aws-native:lambda:EventSourceMappingEndpoints":{"description":"The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``.","properties":{"kafkaBootstrapServers":{"type":"array","items":{"type":"string"},"description":"The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``."}},"type":"object"},"aws-native:lambda:EventSourceMappingFilter":{"description":"A structure within a ``FilterCriteria`` object that defines an event filtering pattern.","properties":{"pattern":{"type":"string","description":"A filter pattern. For more information on the syntax of a filter pattern, see [Filter rule syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax)."}},"type":"object"},"aws-native:lambda:EventSourceMappingFilterCriteria":{"description":"An object that contains the filters for an event source.","properties":{"filters":{"type":"array","items":{"$ref":"#/types/aws-native:lambda:EventSourceMappingFilter"},"description":"A list of filters."}},"type":"object"},"aws-native:lambda:EventSourceMappingFunctionResponseTypesItem":{"type":"string","enum":[{"name":"ReportBatchItemFailures","value":"ReportBatchItemFailures"}]},"aws-native:lambda:EventSourceMappingLoggingConfig":{"description":"The function's Amazon CloudWatch Logs configuration settings.","properties":{"systemLogLevel":{"$ref":"#/types/aws-native:lambda:EventSourceMappingLoggingConfigSystemLogLevel","description":"Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest."}},"type":"object"},"aws-native:lambda:EventSourceMappingLoggingConfigSystemLogLevel":{"description":"Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest.","type":"string","enum":[{"name":"Debug","value":"DEBUG"},{"name":"Info","value":"INFO"},{"name":"Warn","value":"WARN"}]},"aws-native:lambda:EventSourceMappingMetricsConfig":{"description":"The metrics configuration for your event source. Use this configuration object to define which metrics you want your event source mapping to produce.","properties":{"metrics":{"type":"array","items":{"$ref":"#/types/aws-native:lambda:EventSourceMappingMetricsConfigMetricsItem"},"description":"The metrics you want your event source mapping to produce. Include ``EventCount`` to receive event source mapping metrics related to the number of events processed by your event source mapping. For more information about these metrics, see [Event source mapping metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics-types.html#event-source-mapping-metrics)."}},"type":"object"},"aws-native:lambda:EventSourceMappingMetricsConfigMetricsItem":{"type":"string","enum":[{"name":"EventCount","value":"EventCount"},{"name":"ErrorCount","value":"ErrorCount"},{"name":"KafkaMetrics","value":"KafkaMetrics"}]},"aws-native:lambda:EventSourceMappingOnFailure":{"description":"A destination for events that failed processing. For more information, see [Adding a destination](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-async-destinations).","properties":{"destination":{"type":"string","description":"The Amazon Resource Name (ARN) of the destination resource.\n To retain records of unsuccessful [asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations), you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function, or Amazon EventBridge event bus as the destination.\n  Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending ``OnFailure`` event to the destination. For details on this behavior, refer to [Retaining records of asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html).\n  To retain records of failed invocations from [Kinesis](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html), [DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html), [self-managed Kafka](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination) or [Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination), you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination."}},"type":"object"},"aws-native:lambda:EventSourceMappingProvisionedPollerConfig":{"description":"The [provisioned mode](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-provisioned-mode) configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers for your event source.","properties":{"maximumPollers":{"type":"integer","description":"The maximum number of event pollers this event source can scale up to. For Amazon SQS events source mappings, default is 200, and minimum value allowed is 2. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 200, and minimum value allowed is 1."},"minimumPollers":{"type":"integer","description":"The minimum number of event pollers this event source can scale down to. For Amazon SQS events source mappings, default is 2, and minimum 2 required. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 1."},"pollerGroupName":{"type":"string","description":"(Amazon MSK and self-managed Apache Kafka) The name of the provisioned poller group. Use this option to group multiple ESMs within the event source's VPC to share Event Poller Unit (EPU) capacity. You can use this option to optimize Provisioned mode costs for your ESMs. You can group up to 100 ESMs per poller group and aggregate maximum pollers across all ESMs in a group cannot exceed 2000."}},"type":"object"},"aws-native:lambda:EventSourceMappingScalingConfig":{"description":"(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.","properties":{"maximumConcurrency":{"type":"integer","description":"Limits the number of concurrent instances that the SQS event source can invoke."}},"type":"object"},"aws-native:lambda:EventSourceMappingSchemaRegistryAccessConfig":{"description":"Specific access configuration settings that tell Lambda how to authenticate with your schema registry.\n If you're working with an GLU schema registry, don't provide authentication details in this object. Instead, ensure that your execution role has the required permissions for Lambda to access your cluster.\n If you're working with a Confluent schema registry, choose the authentication method in the ``Type`` field, and provide the ASMlong secret ARN in the ``URI`` field.","properties":{"type":{"$ref":"#/types/aws-native:lambda:EventSourceMappingSchemaRegistryAccessConfigType","description":"The type of authentication Lambda uses to access your schema registry."},"uri":{"type":"string","description":"The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry."}},"type":"object"},"aws-native:lambda:EventSourceMappingSchemaRegistryAccessConfigType":{"description":"The type of authentication Lambda uses to access your schema registry.","type":"string","enum":[{"name":"BasicAuth","value":"BASIC_AUTH"},{"name":"ClientCertificateTlsAuth","value":"CLIENT_CERTIFICATE_TLS_AUTH"},{"name":"ServerRootCaCertificate","value":"SERVER_ROOT_CA_CERTIFICATE"}]},"aws-native:lambda:EventSourceMappingSchemaRegistryConfig":{"description":"Specific configuration settings for a Kafka schema registry.","properties":{"accessConfigs":{"type":"array","items":{"$ref":"#/types/aws-native:lambda:EventSourceMappingSchemaRegistryAccessConfig"},"description":"An array of access configuration objects that tell Lambda how to authenticate with your schema registry."},"eventRecordFormat":{"$ref":"#/types/aws-native:lambda:EventSourceMappingSchemaRegistryConfigEventRecordFormat","description":"The record format that Lambda delivers to your function after schema validation.\n  +  Choose ``JSON`` to have Lambda deliver the record to your function as a standard JSON object.\n  +  Choose ``SOURCE`` to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function."},"schemaRegistryUri":{"type":"string","description":"The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.\n  +  For GLU schema registries, use the ARN of the registry.\n  +  For Confluent schema registries, use the URL of the registry."},"schemaValidationConfigs":{"type":"array","items":{"$ref":"#/types/aws-native:lambda:EventSourceMappingSchemaValidationConfig"},"description":"An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry."}},"type":"object"},"aws-native:lambda:EventSourceMappingSchemaRegistryConfigEventRecordFormat":{"description":"The record format that Lambda delivers to your function after schema validation.\n  +  Choose ``JSON`` to have Lambda deliver the record to your function as a standard JSON object.\n  +  Choose ``SOURCE`` to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.","type":"string","enum":[{"name":"Json","value":"JSON"},{"name":"Source","value":"SOURCE"}]},"aws-native:lambda:EventSourceMappingSchemaValidationConfig":{"description":"Specific schema validation configuration settings that tell Lambda the message attributes you want to validate and filter using your schema registry.","properties":{"attribute":{"$ref":"#/types/aws-native:lambda:EventSourceMappingSchemaValidationConfigAttribute","description":"The attributes you want your schema registry to validate and filter for. If you selected ``JSON`` as the ``EventRecordFormat``, Lambda also deserializes the selected message attributes."}},"type":"object"},"aws-native:lambda:EventSourceMappingSchemaValidationConfigAttribute":{"description":"The attributes you want your schema registry to validate and filter for. If you selected ``JSON`` as the ``EventRecordFormat``, Lambda also deserializes the selected message attributes.","type":"string","enum":[{"name":"Key","value":"KEY"},{"name":"Value","value":"VALUE"}]},"aws-native:lambda:EventSourceMappingSelfManagedEventSource":{"description":"The self-managed Apache Kafka cluster for your event source.","properties":{"endpoints":{"$ref":"#/types/aws-native:lambda:EventSourceMappingEndpoints","description":"The list of bootstrap servers for your Kafka brokers in the following format: ``\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]``."}},"type":"object"},"aws-native:lambda:EventSourceMappingSelfManagedKafkaEventSourceConfig":{"description":"Specific configuration settings for a self-managed Apache Kafka event source.","properties":{"consumerGroupId":{"type":"string","description":"The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka-process.html#services-smaa-topic-add)."},"schemaRegistryConfig":{"$ref":"#/types/aws-native:lambda:EventSourceMappingSchemaRegistryConfig","description":"Specific configuration settings for a Kafka schema registry."}},"type":"object"},"aws-native:lambda:EventSourceMappingSourceAccessConfiguration":{"description":"An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.","properties":{"type":{"$ref":"#/types/aws-native:lambda:EventSourceMappingSourceAccessConfigurationType","description":"The type of authentication protocol, VPC components, or virtual host for your event source. For example: ``\"Type\":\"SASL_SCRAM_512_AUTH\"``.\n  +  ``BASIC_AUTH`` – (Amazon MQ) The ASMlong secret that stores your broker credentials.\n  +  ``BASIC_AUTH`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.\n  +  ``VPC_SUBNET`` – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.\n  +  ``VPC_SECURITY_GROUP`` – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.\n  +  ``SASL_SCRAM_256_AUTH`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.\n  +  ``SASL_SCRAM_512_AUTH`` – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.\n  +  ``VIRTUAL_HOST`` –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.\n  +  ``CLIENT_CERTIFICATE_TLS_AUTH`` – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.\n  +  ``SERVER_ROOT_CA_CERTIFICATE`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers."},"uri":{"type":"string","description":"The value for your chosen configuration in ``Type``. For example: ``\"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\"``."}},"type":"object"},"aws-native:lambda:EventSourceMappingSourceAccessConfigurationType":{"description":"The type of authentication protocol, VPC components, or virtual host for your event source. For example: ``\"Type\":\"SASL_SCRAM_512_AUTH\"``.\n  +  ``BASIC_AUTH`` – (Amazon MQ) The ASMlong secret that stores your broker credentials.\n  +  ``BASIC_AUTH`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.\n  +  ``VPC_SUBNET`` – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.\n  +  ``VPC_SECURITY_GROUP`` – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.\n  +  ``SASL_SCRAM_256_AUTH`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.\n  +  ``SASL_SCRAM_512_AUTH`` – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.\n  +  ``VIRTUAL_HOST`` –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.\n  +  ``CLIENT_CERTIFICATE_TLS_AUTH`` – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.\n  +  ``SERVER_ROOT_CA_CERTIFICATE`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.","type":"string","enum":[{"name":"BasicAuth","value":"BASIC_AUTH"},{"name":"VpcSubnet","value":"VPC_SUBNET"},{"name":"VpcSecurityGroup","value":"VPC_SECURITY_GROUP"},{"name":"SaslScram512Auth","value":"SASL_SCRAM_512_AUTH"},{"name":"SaslScram256Auth","value":"SASL_SCRAM_256_AUTH"},{"name":"VirtualHost","value":"VIRTUAL_HOST"},{"name":"ClientCertificateTlsAuth","value":"CLIENT_CERTIFICATE_TLS_AUTH"},{"name":"ServerRootCaCertificate","value":"SERVER_ROOT_CA_CERTIFICATE"}]},"aws-native:lambda:EventSourceMappingTag":{"description":"A [tag](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the event source mapping.","properties":{"key":{"type":"string","description":"The key for this tag."},"value":{"type":"string","description":"The value for this tag."}},"type":"object","required":["key"]},"aws-native:lambda:FunctionArchitecturesItem":{"type":"string","enum":[{"name":"X8664","value":"x86_64"},{"name":"Arm64","value":"arm64"}]},"aws-native:lambda:FunctionCapacityProviderConfig":{"description":"Configuration for the capacity provider that manages compute resources for Lambda functions.","properties":{"lambdaManagedInstancesCapacityProviderConfig":{"$ref":"#/types/aws-native:lambda:FunctionLambdaManagedInstancesCapacityProviderConfig","description":"Configuration for Lambda-managed instances used by the capacity provider."}},"type":"object","required":["lambdaManagedInstancesCapacityProviderConfig"]},"aws-native:lambda:FunctionCode":{"description":"The [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template.\n  When you specify source code inline for a Node.js function, the ``index`` file that CFN creates uses the extension ``.js``. This means that Node.js treats the file as a CommonJS module.\n  Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template.","properties":{"imageUri":{"type":"string","description":"URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry."},"s3Bucket":{"type":"string","description":"An Amazon S3 bucket in the same AWS-Region as your function. The bucket can be in a different AWS-account."},"s3Key":{"type":"string","description":"The Amazon S3 key of the deployment package."},"s3ObjectVersion":{"type":"string","description":"For versioned objects, the version of the deployment package object to use."},"sourceKmsKeyArn":{"type":"string","description":"The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an [owned key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk)."},"zipFile":{"type":"string","description":"(Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, CFN places it in a file named ``index`` and zips it to create a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html). This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index``. For example, ``index.handler``.\n  When you specify source code inline for a Node.js function, the ``index`` file that CFN creates uses the extension ``.js``. This means that Node.js treats the file as a CommonJS module.\n When using Node.js 24 or later, Node.js can automatically detect if a ``.js`` file should be treated as CommonJS or as an ES module. To enable auto-detection, add the ``--experimental-detect-module`` flag to the ``NODE_OPTIONS`` environment variable. For more information, see [Experimental Node.js features](https://docs.aws.amazon.com//lambda/latest/dg/lambda-nodejs.html#nodejs-experimental-features).\n   For JSON, you must escape quotes and special characters such as newline (``\\n``) with a backslash.\n If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ([cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Lambda with CloudFormation](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html) for details."}},"type":"object"},"aws-native:lambda:FunctionDeadLetterConfig":{"description":"The [dead-letter queue](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async-retain-records.html#invocation-dlq) for failed asynchronous invocations.","properties":{"targetArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic."}},"type":"object"},"aws-native:lambda:FunctionDurableConfig":{"description":"Configuration settings for [durable functions](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html), including execution timeout and retention period for execution history.","properties":{"executionTimeout":{"type":"integer","description":"The maximum time (in seconds) that a durable execution can run before timing out. This timeout applies to the entire durable execution, not individual function invocations."},"retentionPeriodInDays":{"type":"integer","description":"The number of days to retain execution history after a durable execution completes. After this period, execution history is no longer available through the GetDurableExecutionHistory API."}},"type":"object","required":["executionTimeout"]},"aws-native:lambda:FunctionEnvironment":{"description":"A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.","properties":{"variables":{"type":"object","additionalProperties":{"type":"string"},"description":"Environment variable key-value pairs. For more information, see [Using Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html).\n If the value of the environment variable is a time or a duration, enclose the value in quotes."}},"type":"object"},"aws-native:lambda:FunctionEphemeralStorage":{"description":"The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.","properties":{"size":{"type":"integer","description":"The size of the function's ``/tmp`` directory."}},"type":"object","required":["size"]},"aws-native:lambda:FunctionFileSystemConfig":{"description":"Details about the connection between a Lambda function and an [Amazon EFS file system](https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html).","properties":{"arn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system."},"localMountPath":{"type":"string","description":"The path where the function can access the file system, starting with ``/mnt/``."}},"type":"object","required":["arn","localMountPath"]},"aws-native:lambda:FunctionImageConfig":{"description":"Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).","properties":{"command":{"type":"array","items":{"type":"string"},"description":"Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list."},"entryPoint":{"type":"array","items":{"type":"string"},"description":"Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list."},"workingDirectory":{"type":"string","description":"Specifies the working directory. The length of the directory string cannot exceed 1,000 characters."}},"type":"object"},"aws-native:lambda:FunctionLambdaManagedInstancesCapacityProviderConfig":{"description":"Configuration for Lambda-managed instances used by the capacity provider.","properties":{"capacityProviderArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the capacity provider."},"executionEnvironmentMemoryGiBPerVCpu":{"type":"number","description":"The amount of memory in GiB allocated per vCPU for execution environments."},"perExecutionEnvironmentMaxConcurrency":{"type":"integer","description":"The maximum number of concurrent executions that can run on each execution environment."}},"type":"object","required":["capacityProviderArn"]},"aws-native:lambda:FunctionLoggingConfig":{"description":"The function's Amazon CloudWatch Logs configuration settings.","properties":{"applicationLogLevel":{"$ref":"#/types/aws-native:lambda:FunctionLoggingConfigApplicationLogLevel","description":"Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where ``TRACE`` is the highest level and ``FATAL`` is the lowest."},"logFormat":{"$ref":"#/types/aws-native:lambda:FunctionLoggingConfigLogFormat","description":"The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON."},"logGroup":{"type":"string","description":"The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named ``/aws/lambda/\u003cfunction name\u003e``. To use a different log group, enter an existing log group or enter a new log group name."},"systemLogLevel":{"$ref":"#/types/aws-native:lambda:FunctionLoggingConfigSystemLogLevel","description":"Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest."}},"type":"object"},"aws-native:lambda:FunctionLoggingConfigApplicationLogLevel":{"description":"Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where ``TRACE`` is the highest level and ``FATAL`` is the lowest.","type":"string","enum":[{"name":"Trace","value":"TRACE"},{"name":"Debug","value":"DEBUG"},{"name":"Info","value":"INFO"},{"name":"Warn","value":"WARN"},{"name":"Error","value":"ERROR"},{"name":"Fatal","value":"FATAL"}]},"aws-native:lambda:FunctionLoggingConfigLogFormat":{"description":"The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.","type":"string","enum":[{"name":"Text","value":"Text"},{"name":"Json","value":"JSON"}]},"aws-native:lambda:FunctionLoggingConfigSystemLogLevel":{"description":"Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest.","type":"string","enum":[{"name":"Debug","value":"DEBUG"},{"name":"Info","value":"INFO"},{"name":"Warn","value":"WARN"}]},"aws-native:lambda:FunctionPackageType":{"description":"The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.","type":"string","enum":[{"name":"Image","value":"Image"},{"name":"Zip","value":"Zip"}]},"aws-native:lambda:FunctionRecursiveLoop":{"description":"The function recursion configuration.","type":"string","enum":[{"name":"Allow","value":"Allow"},{"name":"Terminate","value":"Terminate"}]},"aws-native:lambda:FunctionRuntimeManagementConfig":{"description":"Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).","properties":{"runtimeVersionArn":{"type":"string","description":"The ARN of the runtime version you want the function to use.\n  This is only required if you're using the *Manual* runtime update mode."},"updateRuntimeOn":{"$ref":"#/types/aws-native:lambda:FunctionRuntimeManagementConfigUpdateRuntimeOn","description":"Specify the runtime update mode.\n  +  *Auto (default)* - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best choice for most customers to ensure they always benefit from runtime updates.\n  +  *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.\n  +  *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback).\n  \n *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual``"}},"type":"object","required":["updateRuntimeOn"]},"aws-native:lambda:FunctionRuntimeManagementConfigUpdateRuntimeOn":{"description":"Specify the runtime update mode.\n  +  *Auto (default)* - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best choice for most customers to ensure they always benefit from runtime updates.\n  +  *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.\n  +  *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback).\n  \n *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual``","type":"string","enum":[{"name":"Auto","value":"Auto"},{"name":"FunctionUpdate","value":"FunctionUpdate"},{"name":"Manual","value":"Manual"}]},"aws-native:lambda:FunctionScalingConfig":{"description":"Configuration that defines the scaling behavior for a Lambda Managed Instances function, including the minimum and maximum number of execution environments that can be provisioned.","properties":{"maxExecutionEnvironments":{"type":"integer","description":"The maximum number of execution environments that can be provisioned for the function."},"minExecutionEnvironments":{"type":"integer","description":"The minimum number of execution environments to maintain for the function."}},"type":"object"},"aws-native:lambda:FunctionSnapStart":{"description":"The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.","properties":{"applyOn":{"$ref":"#/types/aws-native:lambda:FunctionSnapStartApplyOn","description":"Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version."}},"type":"object","required":["applyOn"]},"aws-native:lambda:FunctionSnapStartApplyOn":{"description":"Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version.","type":"string","enum":[{"name":"PublishedVersions","value":"PublishedVersions"},{"name":"None","value":"None"}]},"aws-native:lambda:FunctionSnapStartResponse":{"description":"The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.","properties":{"applyOn":{"$ref":"#/types/aws-native:lambda:FunctionSnapStartResponseApplyOn","description":"When set to ``PublishedVersions``, Lambda creates a snapshot of the execution environment when you publish a function version."},"optimizationStatus":{"$ref":"#/types/aws-native:lambda:FunctionSnapStartResponseOptimizationStatus","description":"When you provide a [qualified Amazon Resource Name (ARN)](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using), this response element indicates whether SnapStart is activated for the specified function version."}},"type":"object"},"aws-native:lambda:FunctionSnapStartResponseApplyOn":{"description":"When set to ``PublishedVersions``, Lambda creates a snapshot of the execution environment when you publish a function version.","type":"string","enum":[{"name":"PublishedVersions","value":"PublishedVersions"},{"name":"None","value":"None"}]},"aws-native:lambda:FunctionSnapStartResponseOptimizationStatus":{"description":"When you provide a [qualified Amazon Resource Name (ARN)](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using), this response element indicates whether SnapStart is activated for the specified function version.","type":"string","enum":[{"name":"On","value":"On"},{"name":"Off","value":"Off"}]},"aws-native:lambda:FunctionTag":{"description":"A [tag](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.","properties":{"key":{"type":"string","description":"The key for this tag."},"value":{"type":"string","description":"The value for this tag."}},"type":"object","required":["key"]},"aws-native:lambda:FunctionTenancyConfig":{"description":"Specifies the tenant isolation mode configuration for a Lambda function. This allows you to configure specific tenant isolation strategies for your function invocations. Tenant isolation configuration cannot be modified after function creation.","properties":{"tenantIsolationMode":{"$ref":"#/types/aws-native:lambda:FunctionTenancyConfigTenantIsolationMode","description":"Tenant isolation mode allows for invocation to be sent to a corresponding execution environment dedicated to a specific tenant ID."}},"type":"object","required":["tenantIsolationMode"]},"aws-native:lambda:FunctionTenancyConfigTenantIsolationMode":{"description":"Tenant isolation mode allows for invocation to be sent to a corresponding execution environment dedicated to a specific tenant ID.","type":"string","enum":[{"name":"PerTenant","value":"PER_TENANT"}]},"aws-native:lambda:FunctionTracingConfig":{"description":"The function's [](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration. To sample and record incoming requests, set ``Mode`` to ``Active``.","properties":{"mode":{"$ref":"#/types/aws-native:lambda:FunctionTracingConfigMode","description":"The tracing mode."}},"type":"object"},"aws-native:lambda:FunctionTracingConfigMode":{"description":"The tracing mode.","type":"string","enum":[{"name":"Active","value":"Active"},{"name":"PassThrough","value":"PassThrough"}]},"aws-native:lambda:FunctionVpcConfig":{"description":"The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see [VPC Settings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).\n  When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources.\n To monitor network interfaces, CFN needs the ``ec2:DescribeNetworkInterfaces`` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted.","properties":{"ipv6AllowedForDualStack":{"type":"boolean","description":"Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets."},"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"A list of VPC security group IDs."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"A list of VPC subnet IDs."}},"type":"object"},"aws-native:lambda:LayerVersionContent":{"properties":{"s3Bucket":{"type":"string","description":"The Amazon S3 bucket of the layer archive."},"s3Key":{"type":"string","description":"The Amazon S3 key of the layer archive."},"s3ObjectVersion":{"type":"string","description":"For versioned objects, the version of the layer archive object to use."}},"type":"object","required":["s3Bucket","s3Key"]},"aws-native:lambda:PermissionFunctionUrlAuthType":{"description":"The type of authentication that your function URL uses. Set to ``AWS_IAM`` if you want to restrict access to authenticated users only. Set to ``NONE`` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Control access to Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).","type":"string","enum":[{"name":"AwsIam","value":"AWS_IAM"},{"name":"None","value":"NONE"}]},"aws-native:lambda:UrlAllowMethodsItem":{"type":"string","enum":[{"name":"Get","value":"GET"},{"name":"Put","value":"PUT"},{"name":"Head","value":"HEAD"},{"name":"Post","value":"POST"},{"name":"Patch","value":"PATCH"},{"name":"Delete","value":"DELETE"},{"value":"*"}]},"aws-native:lambda:UrlAuthType":{"description":"Can be either AWS_IAM if the requests are authorized via IAM, or NONE if no authorization is configured on the Function URL.","type":"string","enum":[{"name":"AwsIam","value":"AWS_IAM"},{"name":"None","value":"NONE"}]},"aws-native:lambda:UrlCors":{"properties":{"allowCredentials":{"type":"boolean","description":"Specifies whether credentials are included in the CORS request."},"allowHeaders":{"type":"array","items":{"type":"string"},"description":"Represents a collection of allowed headers."},"allowMethods":{"type":"array","items":{"$ref":"#/types/aws-native:lambda:UrlAllowMethodsItem"},"description":"Represents a collection of allowed HTTP methods."},"allowOrigins":{"type":"array","items":{"type":"string"},"description":"Represents a collection of allowed origins."},"exposeHeaders":{"type":"array","items":{"type":"string"},"description":"Represents a collection of exposed headers."},"maxAge":{"type":"integer","description":"The maximum amount of time, in seconds, that browsers can cache results of a preflight request. By default, this is set to `0` , which means the browser will not cache results."}},"type":"object"},"aws-native:lambda:UrlInvokeMode":{"description":"The invocation mode for the function's URL. Set to BUFFERED if you want to buffer responses before returning them to the client. Set to RESPONSE_STREAM if you want to stream responses, allowing faster time to first byte and larger response payload sizes. If not set, defaults to BUFFERED.","type":"string","enum":[{"name":"Buffered","value":"BUFFERED"},{"name":"ResponseStream","value":"RESPONSE_STREAM"}]},"aws-native:lambda:VersionFunctionScalingConfig":{"description":"Configuration that defines the scaling behavior for a Lambda Managed Instances function, including the minimum and maximum number of execution environments that can be provisioned.","properties":{"maxExecutionEnvironments":{"type":"integer","description":"The maximum number of execution environments that can be provisioned for the function."},"minExecutionEnvironments":{"type":"integer","description":"The minimum number of execution environments to maintain for the function."}},"type":"object"},"aws-native:lambda:VersionProvisionedConcurrencyConfiguration":{"description":"A provisioned concurrency configuration for a function's version.","properties":{"provisionedConcurrentExecutions":{"type":"integer","description":"The amount of provisioned concurrency to allocate for the version."}},"type":"object","required":["provisionedConcurrentExecutions"]},"aws-native:lambda:VersionRuntimePolicy":{"description":"Runtime Management Config of a function.","properties":{"runtimeVersionArn":{"type":"string","description":"The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null is returned."},"updateRuntimeOn":{"type":"string","description":"The runtime update mode."}},"type":"object","required":["updateRuntimeOn"]},"aws-native:launchwizard:DeploymentStatus":{"type":"string","enum":[{"name":"Completed","value":"COMPLETED"},{"name":"Creating","value":"CREATING"},{"name":"DeleteInProgress","value":"DELETE_IN_PROGRESS"},{"name":"DeleteInitiating","value":"DELETE_INITIATING"},{"name":"DeleteFailed","value":"DELETE_FAILED"},{"name":"Deleted","value":"DELETED"},{"name":"Failed","value":"FAILED"},{"name":"InProgress","value":"IN_PROGRESS"},{"name":"Validating","value":"VALIDATING"}]},"aws-native:launchwizard:DeploymentTags":{"properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key"]},"aws-native:lex:BotAdvancedRecognitionSetting":{"properties":{"audioRecognitionStrategy":{"$ref":"#/types/aws-native:lex:BotAudioRecognitionStrategy","description":"Enables using the slot values as a custom vocabulary for recognizing user utterances."}},"type":"object"},"aws-native:lex:BotAliasAudioLogDestination":{"description":"The location of audio log files collected when conversation logging is enabled for a bot.","properties":{"s3Bucket":{"$ref":"#/types/aws-native:lex:BotAliasS3BucketLogDestination"}},"type":"object","required":["s3Bucket"]},"aws-native:lex:BotAliasAudioLogSetting":{"description":"Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.","properties":{"destination":{"$ref":"#/types/aws-native:lex:BotAliasAudioLogDestination"},"enabled":{"type":"boolean"}},"type":"object","required":["destination","enabled"]},"aws-native:lex:BotAliasCloudWatchLogGroupLogDestination":{"properties":{"cloudWatchLogGroupArn":{"type":"string","description":"A string used to identify the groupArn for the Cloudwatch Log Group"},"logPrefix":{"type":"string","description":"A string containing the value for the Log Prefix"}},"type":"object","required":["cloudWatchLogGroupArn","logPrefix"]},"aws-native:lex:BotAliasCodeHookSpecification":{"description":"Contains information about code hooks that Amazon Lex calls during a conversation.","properties":{"lambdaCodeHook":{"$ref":"#/types/aws-native:lex:BotAliasLambdaCodeHook"}},"type":"object","required":["lambdaCodeHook"]},"aws-native:lex:BotAliasConversationLogSettings":{"description":"Contains information about code hooks that Amazon Lex calls during a conversation.","properties":{"audioLogSettings":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotAliasAudioLogSetting"},"description":"The Amazon S3 settings for logging audio to an S3 bucket."},"textLogSettings":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotAliasTextLogSetting"},"description":"The Amazon CloudWatch Logs settings for logging text and metadata."}},"type":"object"},"aws-native:lex:BotAliasLambdaCodeHook":{"description":"Contains information about code hooks that Amazon Lex calls during a conversation.","properties":{"codeHookInterfaceVersion":{"type":"string","description":"The version of the request-response that you want Amazon Lex to use to invoke your Lambda function."},"lambdaArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Lambda function."}},"type":"object","required":["codeHookInterfaceVersion","lambdaArn"]},"aws-native:lex:BotAliasLocaleSettings":{"description":"You can use this parameter to specify a specific Lambda function to run different functions in different locales.","properties":{"codeHookSpecification":{"$ref":"#/types/aws-native:lex:BotAliasCodeHookSpecification"},"enabled":{"type":"boolean","description":"Whether the Lambda code hook is enabled"}},"type":"object","required":["enabled"]},"aws-native:lex:BotAliasLocaleSettingsItem":{"description":"A locale setting in alias","properties":{"botAliasLocaleSetting":{"$ref":"#/types/aws-native:lex:BotAliasLocaleSettings"},"localeId":{"type":"string","description":"A string used to identify the locale"}},"type":"object","required":["botAliasLocaleSetting","localeId"]},"aws-native:lex:BotAliasS3BucketLogDestination":{"description":"Specifies an Amazon S3 bucket for logging audio conversations","properties":{"kmsKeyArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket."},"logPrefix":{"type":"string","description":"The Amazon S3 key of the deployment package."},"s3BucketArn":{"type":"string","description":"The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored."}},"type":"object","required":["logPrefix","s3BucketArn"]},"aws-native:lex:BotAliasStatus":{"type":"string","enum":[{"name":"Creating","value":"Creating"},{"name":"Available","value":"Available"},{"name":"Deleting","value":"Deleting"},{"name":"Failed","value":"Failed"}]},"aws-native:lex:BotAliasTag":{"description":"A label for tagging Lex resources","properties":{"key":{"type":"string","description":"A string used to identify this tag"},"value":{"type":"string","description":"A string containing the value for the tag"}},"type":"object","required":["key","value"]},"aws-native:lex:BotAliasTextLogDestination":{"description":"Defines the Amazon CloudWatch Logs destination log group for conversation text logs.","properties":{"cloudWatch":{"$ref":"#/types/aws-native:lex:BotAliasCloudWatchLogGroupLogDestination"}},"type":"object","required":["cloudWatch"]},"aws-native:lex:BotAliasTextLogSetting":{"description":"Contains information about code hooks that Amazon Lex calls during a conversation.","properties":{"destination":{"$ref":"#/types/aws-native:lex:BotAliasTextLogDestination"},"enabled":{"type":"boolean"}},"type":"object","required":["destination","enabled"]},"aws-native:lex:BotAllowedInputTypes":{"properties":{"allowAudioInput":{"type":"boolean"},"allowDtmfInput":{"type":"boolean"}},"type":"object","required":["allowAudioInput","allowDtmfInput"]},"aws-native:lex:BotAudioAndDtmfInputSpecification":{"properties":{"audioSpecification":{"$ref":"#/types/aws-native:lex:BotAudioSpecification"},"dtmfSpecification":{"$ref":"#/types/aws-native:lex:BotDtmfSpecification"},"startTimeoutMs":{"type":"integer"}},"type":"object","required":["startTimeoutMs"]},"aws-native:lex:BotAudioLogDestination":{"properties":{"s3Bucket":{"$ref":"#/types/aws-native:lex:BotS3BucketLogDestination"}},"type":"object","required":["s3Bucket"]},"aws-native:lex:BotAudioLogSetting":{"properties":{"destination":{"$ref":"#/types/aws-native:lex:BotAudioLogDestination"},"enabled":{"type":"boolean"}},"type":"object","required":["destination","enabled"]},"aws-native:lex:BotAudioRecognitionStrategy":{"type":"string","enum":[{"name":"UseSlotValuesAsCustomVocabulary","value":"UseSlotValuesAsCustomVocabulary"}]},"aws-native:lex:BotAudioSpecification":{"properties":{"endTimeoutMs":{"type":"integer"},"maxLengthMs":{"type":"integer"}},"type":"object","required":["endTimeoutMs","maxLengthMs"]},"aws-native:lex:BotBedrockAgentIntentConfiguration":{"properties":{"bedrockAgentConfiguration":{"$ref":"#/types/aws-native:lex:BotBedrockAgentIntentConfigurationBedrockAgentConfigurationProperties"},"bedrockAgentIntentKnowledgeBaseConfiguration":{"$ref":"#/types/aws-native:lex:BotBedrockAgentIntentConfigurationBedrockAgentIntentKnowledgeBaseConfigurationProperties"}},"type":"object"},"aws-native:lex:BotBedrockAgentIntentConfigurationBedrockAgentConfigurationProperties":{"properties":{"bedrockAgentAliasId":{"type":"string"},"bedrockAgentId":{"type":"string"}},"type":"object"},"aws-native:lex:BotBedrockAgentIntentConfigurationBedrockAgentIntentKnowledgeBaseConfigurationProperties":{"properties":{"bedrockKnowledgeBaseArn":{"type":"string"},"bedrockModelConfiguration":{"$ref":"#/types/aws-native:lex:BotBedrockModelSpecification"}},"type":"object","required":["bedrockKnowledgeBaseArn","bedrockModelConfiguration"]},"aws-native:lex:BotBedrockModelSpecification":{"properties":{"bedrockGuardrailConfiguration":{"$ref":"#/types/aws-native:lex:BotBedrockModelSpecificationBedrockGuardrailConfigurationProperties"},"bedrockModelCustomPrompt":{"type":"string"},"bedrockTraceStatus":{"$ref":"#/types/aws-native:lex:BotBedrockModelSpecificationBedrockTraceStatus"},"modelArn":{"type":"string","description":"The ARN of the foundation model used in descriptive bot building."}},"type":"object","required":["modelArn"]},"aws-native:lex:BotBedrockModelSpecificationBedrockGuardrailConfigurationProperties":{"properties":{"bedrockGuardrailIdentifier":{"type":"string"},"bedrockGuardrailVersion":{"type":"string"}},"type":"object"},"aws-native:lex:BotBedrockModelSpecificationBedrockTraceStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:lex:BotButton":{"properties":{"text":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["text","value"]},"aws-native:lex:BotCloudWatchLogGroupLogDestination":{"properties":{"cloudWatchLogGroupArn":{"type":"string"},"logPrefix":{"type":"string"}},"type":"object","required":["cloudWatchLogGroupArn","logPrefix"]},"aws-native:lex:BotCodeHookSpecification":{"properties":{"lambdaCodeHook":{"$ref":"#/types/aws-native:lex:BotLambdaCodeHook"}},"type":"object","required":["lambdaCodeHook"]},"aws-native:lex:BotCompositeSlotTypeSetting":{"properties":{"subSlots":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSubSlotTypeComposition"},"description":"Subslots in the composite slot."}},"type":"object"},"aws-native:lex:BotCondition":{"properties":{"expressionString":{"type":"string"}},"type":"object","required":["expressionString"]},"aws-native:lex:BotConditionalBranch":{"properties":{"condition":{"$ref":"#/types/aws-native:lex:BotCondition"},"name":{"type":"string"},"nextStep":{"$ref":"#/types/aws-native:lex:BotDialogState"},"response":{"$ref":"#/types/aws-native:lex:BotResponseSpecification"}},"type":"object","required":["condition","name","nextStep"]},"aws-native:lex:BotConditionalSpecification":{"properties":{"conditionalBranches":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotConditionalBranch"},"description":"A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true."},"defaultBranch":{"$ref":"#/types/aws-native:lex:BotDefaultConditionalBranch","description":"The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step."},"isActive":{"type":"boolean","description":"Determines whether a conditional branch is active. When `IsActive` is false, the conditions are not evaluated."}},"type":"object","required":["conditionalBranches","defaultBranch","isActive"]},"aws-native:lex:BotConversationLogSettings":{"properties":{"audioLogSettings":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotAudioLogSetting"},"description":"The Amazon S3 settings for logging audio to an S3 bucket."},"textLogSettings":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotTextLogSetting"},"description":"The Amazon CloudWatch Logs settings for logging text and metadata."}},"type":"object"},"aws-native:lex:BotCustomPayload":{"properties":{"value":{"type":"string"}},"type":"object","required":["value"]},"aws-native:lex:BotCustomVocabulary":{"properties":{"customVocabularyItems":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotCustomVocabularyItem"},"description":"Specifies a list of words that you expect to be used during a conversation with your bot."}},"type":"object","required":["customVocabularyItems"]},"aws-native:lex:BotCustomVocabularyItem":{"properties":{"displayAs":{"type":"string"},"phrase":{"type":"string"},"weight":{"type":"integer"}},"type":"object","required":["phrase"]},"aws-native:lex:BotDeepgramSpeechModelConfig":{"properties":{"apiTokenSecretArn":{"type":"string"},"modelId":{"type":"string"}},"type":"object","required":["apiTokenSecretArn"]},"aws-native:lex:BotDefaultConditionalBranch":{"properties":{"nextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"The next step in the conversation."},"response":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."}},"type":"object"},"aws-native:lex:BotDialogAction":{"properties":{"slotToElicit":{"type":"string","description":"If the dialog action is `ElicitSlot` , defines the slot to elicit from the user."},"suppressNextMessage":{"type":"boolean","description":"When true the next message for the intent is not used."},"type":{"$ref":"#/types/aws-native:lex:BotDialogActionType","description":"The action that the bot should execute."}},"type":"object","required":["type"]},"aws-native:lex:BotDialogActionType":{"type":"string","enum":[{"name":"CloseIntent","value":"CloseIntent"},{"name":"ConfirmIntent","value":"ConfirmIntent"},{"name":"ElicitIntent","value":"ElicitIntent"},{"name":"ElicitSlot","value":"ElicitSlot"},{"name":"StartIntent","value":"StartIntent"},{"name":"FulfillIntent","value":"FulfillIntent"},{"name":"EndConversation","value":"EndConversation"},{"name":"EvaluateConditional","value":"EvaluateConditional"},{"name":"InvokeDialogCodeHook","value":"InvokeDialogCodeHook"}]},"aws-native:lex:BotDialogCodeHookInvocationSetting":{"properties":{"enableCodeHookInvocation":{"type":"boolean","description":"Indicates whether a Lambda function should be invoked for the dialog."},"invocationLabel":{"type":"string","description":"A label that indicates the dialog step from which the dialog code hook is happening."},"isActive":{"type":"boolean","description":"Determines whether a dialog code hook is used when the intent is activated."},"postCodeHookSpecification":{"$ref":"#/types/aws-native:lex:BotPostDialogCodeHookInvocationSpecification","description":"Contains the responses and actions that Amazon Lex takes after the Lambda function is complete."}},"type":"object","required":["enableCodeHookInvocation","isActive","postCodeHookSpecification"]},"aws-native:lex:BotDialogCodeHookSetting":{"properties":{"enabled":{"type":"boolean","description":"Enables the dialog code hook so that it processes user requests."}},"type":"object","required":["enabled"]},"aws-native:lex:BotDialogState":{"properties":{"dialogAction":{"$ref":"#/types/aws-native:lex:BotDialogAction","description":"Defines the action that the bot executes at runtime when the conversation reaches this step."},"intent":{"$ref":"#/types/aws-native:lex:BotIntentOverride","description":"Override settings to configure the intent state."},"sessionAttributes":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSessionAttribute"},"description":"Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application."}},"type":"object"},"aws-native:lex:BotDtmfSpecification":{"properties":{"deletionCharacter":{"type":"string"},"endCharacter":{"type":"string"},"endTimeoutMs":{"type":"integer"},"maxLength":{"type":"integer"}},"type":"object","required":["deletionCharacter","endCharacter","endTimeoutMs","maxLength"]},"aws-native:lex:BotElicitationCodeHookInvocationSetting":{"properties":{"enableCodeHookInvocation":{"type":"boolean","description":"Indicates whether a Lambda function should be invoked for the dialog."},"invocationLabel":{"type":"string","description":"A label that indicates the dialog step from which the dialog code hook is happening."}},"type":"object","required":["enableCodeHookInvocation"]},"aws-native:lex:BotExternalSourceSetting":{"properties":{"grammarSlotTypeSetting":{"$ref":"#/types/aws-native:lex:BotGrammarSlotTypeSetting","description":"Settings required for a slot type based on a grammar that you provide."}},"type":"object"},"aws-native:lex:BotFulfillmentCodeHookSetting":{"properties":{"enabled":{"type":"boolean","description":"Indicates whether a Lambda function should be invoked to fulfill a specific intent."},"fulfillmentUpdatesSpecification":{"$ref":"#/types/aws-native:lex:BotFulfillmentUpdatesSpecification","description":"Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations."},"isActive":{"type":"boolean","description":"Determines whether the fulfillment code hook is used. When `active` is false, the code hook doesn't run."},"postFulfillmentStatusSpecification":{"$ref":"#/types/aws-native:lex:BotPostFulfillmentStatusSpecification","description":"Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations."}},"type":"object","required":["enabled"]},"aws-native:lex:BotFulfillmentStartResponseSpecification":{"properties":{"allowInterrupt":{"type":"boolean","description":"Determines whether the user can interrupt the start message while it is playing."},"delayInSeconds":{"type":"integer","description":"The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played."},"messageGroups":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotMessageGroup"},"description":"1 - 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user."}},"type":"object","required":["delayInSeconds","messageGroups"]},"aws-native:lex:BotFulfillmentUpdateResponseSpecification":{"properties":{"allowInterrupt":{"type":"boolean","description":"Determines whether the user can interrupt an update message while it is playing."},"frequencyInSeconds":{"type":"integer","description":"The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user."},"messageGroups":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotMessageGroup"},"description":"1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user."}},"type":"object","required":["frequencyInSeconds","messageGroups"]},"aws-native:lex:BotFulfillmentUpdatesSpecification":{"properties":{"active":{"type":"boolean","description":"Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.\n\nIf the `active` field is set to true, the `startResponse` , `updateResponse` , and `timeoutInSeconds` fields are required."},"startResponse":{"$ref":"#/types/aws-native:lex:BotFulfillmentStartResponseSpecification","description":"Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running."},"timeoutInSeconds":{"type":"integer","description":"The length of time that the fulfillment Lambda function should run before it times out."},"updateResponse":{"$ref":"#/types/aws-native:lex:BotFulfillmentUpdateResponseSpecification","description":"Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running."}},"type":"object","required":["active"]},"aws-native:lex:BotGenerativeAiSettings":{"properties":{"buildtimeSettings":{"$ref":"#/types/aws-native:lex:BotGenerativeAiSettingsBuildtimeSettingsProperties"},"runtimeSettings":{"$ref":"#/types/aws-native:lex:BotGenerativeAiSettingsRuntimeSettingsProperties"}},"type":"object"},"aws-native:lex:BotGenerativeAiSettingsBuildtimeSettingsProperties":{"properties":{"descriptiveBotBuilderSpecification":{"$ref":"#/types/aws-native:lex:BotGenerativeAiSettingsBuildtimeSettingsPropertiesDescriptiveBotBuilderSpecificationProperties"},"sampleUtteranceGenerationSpecification":{"$ref":"#/types/aws-native:lex:BotGenerativeAiSettingsBuildtimeSettingsPropertiesSampleUtteranceGenerationSpecificationProperties"}},"type":"object"},"aws-native:lex:BotGenerativeAiSettingsBuildtimeSettingsPropertiesDescriptiveBotBuilderSpecificationProperties":{"properties":{"bedrockModelSpecification":{"$ref":"#/types/aws-native:lex:BotBedrockModelSpecification"},"enabled":{"type":"boolean"}},"type":"object","required":["enabled"]},"aws-native:lex:BotGenerativeAiSettingsBuildtimeSettingsPropertiesSampleUtteranceGenerationSpecificationProperties":{"properties":{"bedrockModelSpecification":{"$ref":"#/types/aws-native:lex:BotBedrockModelSpecification"},"enabled":{"type":"boolean"}},"type":"object","required":["enabled"]},"aws-native:lex:BotGenerativeAiSettingsRuntimeSettingsProperties":{"properties":{"nluImprovementSpecification":{"$ref":"#/types/aws-native:lex:BotGenerativeAiSettingsRuntimeSettingsPropertiesNluImprovementSpecificationProperties"},"slotResolutionImprovementSpecification":{"$ref":"#/types/aws-native:lex:BotGenerativeAiSettingsRuntimeSettingsPropertiesSlotResolutionImprovementSpecificationProperties"}},"type":"object"},"aws-native:lex:BotGenerativeAiSettingsRuntimeSettingsPropertiesNluImprovementSpecificationProperties":{"properties":{"assistedNluMode":{"$ref":"#/types/aws-native:lex:BotGenerativeAiSettingsRuntimeSettingsPropertiesNluImprovementSpecificationPropertiesAssistedNluMode"},"enabled":{"type":"boolean"},"intentDisambiguationSettings":{"$ref":"#/types/aws-native:lex:BotIntentDisambiguationSettings"}},"type":"object","required":["enabled"]},"aws-native:lex:BotGenerativeAiSettingsRuntimeSettingsPropertiesNluImprovementSpecificationPropertiesAssistedNluMode":{"type":"string","enum":[{"name":"Primary","value":"Primary"},{"name":"Fallback","value":"Fallback"}]},"aws-native:lex:BotGenerativeAiSettingsRuntimeSettingsPropertiesSlotResolutionImprovementSpecificationProperties":{"properties":{"bedrockModelSpecification":{"$ref":"#/types/aws-native:lex:BotBedrockModelSpecification"},"enabled":{"type":"boolean"}},"type":"object","required":["enabled"]},"aws-native:lex:BotGrammarSlotTypeSetting":{"properties":{"source":{"$ref":"#/types/aws-native:lex:BotGrammarSlotTypeSource","description":"The source of the grammar used to create the slot type."}},"type":"object"},"aws-native:lex:BotGrammarSlotTypeSource":{"properties":{"kmsKeyArn":{"type":"string","description":"The AWS  key required to decrypt the contents of the grammar, if any."},"s3BucketName":{"type":"string","description":"The name of the Amazon S3 bucket that contains the grammar source."},"s3ObjectKey":{"type":"string","description":"The path to the grammar in the Amazon S3 bucket."}},"type":"object","required":["s3BucketName","s3ObjectKey"]},"aws-native:lex:BotImageResponseCard":{"properties":{"buttons":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotButton"}},"imageUrl":{"type":"string"},"subtitle":{"type":"string"},"title":{"type":"string"}},"type":"object","required":["title"]},"aws-native:lex:BotInitialResponseSetting":{"properties":{"codeHook":{"$ref":"#/types/aws-native:lex:BotDialogCodeHookInvocationSetting","description":"Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation."},"conditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition."},"initialResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."},"nextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"The next step in the conversation."}},"type":"object"},"aws-native:lex:BotInputContext":{"properties":{"name":{"type":"string"}},"type":"object","required":["name"]},"aws-native:lex:BotIntent":{"properties":{"bedrockAgentIntentConfiguration":{"$ref":"#/types/aws-native:lex:BotBedrockAgentIntentConfiguration"},"description":{"type":"string","description":"Resource Type definition for the intent."},"dialogCodeHook":{"$ref":"#/types/aws-native:lex:BotDialogCodeHookSetting","description":"Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction."},"displayName":{"type":"string"},"fulfillmentCodeHook":{"$ref":"#/types/aws-native:lex:BotFulfillmentCodeHookSetting","description":"Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user."},"initialResponseSetting":{"$ref":"#/types/aws-native:lex:BotInitialResponseSetting","description":"Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots."},"inputContexts":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotInputContext"},"description":"A list of contexts that must be active for this intent to be considered by Amazon Lex ."},"intentClosingSetting":{"$ref":"#/types/aws-native:lex:BotIntentClosingSetting","description":"Sets the response that Amazon Lex sends to the user when the intent is closed."},"intentConfirmationSetting":{"$ref":"#/types/aws-native:lex:BotIntentConfirmationSetting","description":"Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers \"no,\" the settings contain a statement that is sent to the user to end the intent."},"kendraConfiguration":{"$ref":"#/types/aws-native:lex:BotKendraConfiguration","description":"Provides configuration information for the `AMAZON.KendraSearchIntent` intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance."},"name":{"type":"string","description":"The name of the intent. Intent names must be unique within the locale that contains the intent and can't match the name of any built-in intent."},"outputContexts":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotOutputContext"},"description":"A list of contexts that the intent activates when it is fulfilled."},"parentIntentSignature":{"type":"string","description":"A unique identifier for the built-in intent to base this intent on."},"qInConnectIntentConfiguration":{"$ref":"#/types/aws-native:lex:BotQInConnectIntentConfiguration"},"qnAIntentConfiguration":{"$ref":"#/types/aws-native:lex:BotQnAIntentConfiguration"},"sampleUtterances":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSampleUtterance"},"description":"A list of utterances that a user might say to signal the intent."},"slotPriorities":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSlotPriority"},"description":"Indicates the priority for slots. Amazon Lex prompts the user for slot values in priority order."},"slots":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSlot"},"description":"A list of slots that the intent requires for fulfillment."}},"type":"object","required":["name"]},"aws-native:lex:BotIntentClosingSetting":{"properties":{"closingResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"The response that Amazon Lex sends to the user when the intent is complete."},"conditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"A list of conditional branches associated with the intent's closing response. These branches are executed when the `nextStep` attribute is set to `EvalutateConditional` ."},"isActive":{"type":"boolean","description":"Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the `IsActive` field isn't specified, the default is true."},"nextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"Specifies the next step that the bot executes after playing the intent's closing response."}},"type":"object"},"aws-native:lex:BotIntentConfirmationSetting":{"properties":{"codeHook":{"$ref":"#/types/aws-native:lex:BotDialogCodeHookInvocationSetting","description":"The `DialogCodeHookInvocationSetting` object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is `InvokeDialogCodeHook` ."},"confirmationConditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"A list of conditional branches to evaluate after the intent is closed."},"confirmationNextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"Specifies the next step that the bot executes when the customer confirms the intent."},"confirmationResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."},"declinationConditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"A list of conditional branches to evaluate after the intent is declined."},"declinationNextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"Specifies the next step that the bot executes when the customer declines the intent."},"declinationResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"When the user answers \"no\" to the question defined in `promptSpecification` , Amazon Lex responds with this response to acknowledge that the intent was canceled."},"elicitationCodeHook":{"$ref":"#/types/aws-native:lex:BotElicitationCodeHookInvocationSetting","description":"The `DialogCodeHookInvocationSetting` used when the code hook is invoked during confirmation prompt retries."},"failureConditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition."},"failureNextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"The next step to take in the conversation if the confirmation step fails."},"failureResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"Specifies a list of message groups that Amazon Lex uses to respond the user input when the intent confirmation fails."},"isActive":{"type":"boolean","description":"Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the `IsActive` field isn't specified, the default is true."},"promptSpecification":{"$ref":"#/types/aws-native:lex:BotPromptSpecification","description":"Prompts the user to confirm the intent. This question should have a yes or no answer.\n\nAmazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the `OrderPizza` intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information."}},"type":"object","required":["promptSpecification"]},"aws-native:lex:BotIntentDisambiguationSettings":{"properties":{"customDisambiguationMessage":{"type":"string","description":"Provides a custom message that will be displayed before presenting the disambiguation options to users. This message helps set the context for users and can be customized to match your bot's tone and brand. If not specified, a default message will be used."},"enabled":{"type":"boolean","description":"Determines whether the Intent Disambiguation feature is enabled. When set to `true` , Amazon Lex will present disambiguation options to users when multiple intents could match their input, with the default being `false` ."},"maxDisambiguationIntents":{"type":"integer","description":"Specifies the maximum number of intent options (2-5) to present to users when disambiguation is needed. This setting determines how many intent options will be shown to users when the system detects ambiguous input. The default value is 3."}},"type":"object","required":["enabled"]},"aws-native:lex:BotIntentOverride":{"properties":{"name":{"type":"string","description":"The name of the intent. Only required when you're switching intents."},"slots":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSlotValueOverrideMap"},"description":"A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden."}},"type":"object"},"aws-native:lex:BotKendraConfiguration":{"properties":{"kendraIndex":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the `AMAZON.KendraSearchIntent` intent to search. The index must be in the same account and Region as the Amazon Lex bot."},"queryFilterString":{"type":"string","description":"A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see [Filtering queries](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html) ."},"queryFilterStringEnabled":{"type":"boolean","description":"Determines whether the `AMAZON.KendraSearchIntent` intent uses a custom query string to query the Amazon Kendra index."}},"type":"object","required":["kendraIndex"]},"aws-native:lex:BotLambdaCodeHook":{"properties":{"codeHookInterfaceVersion":{"type":"string"},"lambdaArn":{"type":"string"}},"type":"object","required":["codeHookInterfaceVersion","lambdaArn"]},"aws-native:lex:BotLocale":{"properties":{"customVocabulary":{"$ref":"#/types/aws-native:lex:BotCustomVocabulary","description":"Specifies a custom vocabulary to use with a specific locale."},"description":{"type":"string","description":"A description of the bot locale. Use this to help identify the bot locale in lists."},"generativeAiSettings":{"$ref":"#/types/aws-native:lex:BotGenerativeAiSettings"},"intents":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotIntent"},"description":"One or more intents defined for the locale."},"localeId":{"type":"string","description":"The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales."},"nluConfidenceThreshold":{"type":"number","description":"Determines the threshold where Amazon Lex will insert the `AMAZON.FallbackIntent` , `AMAZON.KendraSearchIntent` , or both when returning alternative intents. You must configure an `AMAZON.FallbackIntent` . `AMAZON.KendraSearchIntent` is only inserted if it is configured for the bot."},"slotTypes":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSlotType"},"description":"One or more slot types defined for the locale."},"speechDetectionSensitivity":{"$ref":"#/types/aws-native:lex:BotSpeechDetectionSensitivity"},"speechRecognitionSettings":{"$ref":"#/types/aws-native:lex:BotSpeechRecognitionSettings"},"unifiedSpeechSettings":{"$ref":"#/types/aws-native:lex:BotUnifiedSpeechSettings"},"voiceSettings":{"$ref":"#/types/aws-native:lex:BotVoiceSettings","description":"Defines settings for using an Amazon Polly voice to communicate with a user.\n\nValid values include:\n\n- `standard`\n- `neural`\n- `long-form`\n- `generative`"}},"type":"object","required":["localeId","nluConfidenceThreshold"]},"aws-native:lex:BotMessage":{"properties":{"customPayload":{"$ref":"#/types/aws-native:lex:BotCustomPayload"},"imageResponseCard":{"$ref":"#/types/aws-native:lex:BotImageResponseCard"},"plainTextMessage":{"$ref":"#/types/aws-native:lex:BotPlainTextMessage"},"ssmlMessage":{"$ref":"#/types/aws-native:lex:BotSsmlMessage"}},"type":"object"},"aws-native:lex:BotMessageGroup":{"properties":{"message":{"$ref":"#/types/aws-native:lex:BotMessage"},"variations":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotMessage"}}},"type":"object","required":["message"]},"aws-native:lex:BotMessageSelectionStrategy":{"type":"string","enum":[{"name":"Random","value":"Random"},{"name":"Ordered","value":"Ordered"}]},"aws-native:lex:BotMultipleValuesSetting":{"properties":{"allowMultipleValues":{"type":"boolean","description":"Indicates whether a slot can return multiple values. When `true` , the slot may return more than one value in a response. When `false` , the slot returns only a single value.\n\nMulti-value slots are only available in the en-US locale. If you set this value to `true` in any other locale, Amazon Lex throws a `ValidationException` .\n\nIf the `allowMutlipleValues` is not set, the default value is `false` ."}},"type":"object"},"aws-native:lex:BotObfuscationSetting":{"properties":{"obfuscationSettingType":{"$ref":"#/types/aws-native:lex:BotObfuscationSettingObfuscationSettingType","description":"Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values."}},"type":"object","required":["obfuscationSettingType"]},"aws-native:lex:BotObfuscationSettingObfuscationSettingType":{"description":"Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.","type":"string","enum":[{"name":"None","value":"None"},{"name":"DefaultObfuscation","value":"DefaultObfuscation"}]},"aws-native:lex:BotOutputContext":{"properties":{"name":{"type":"string"},"timeToLiveInSeconds":{"type":"integer"},"turnsToLive":{"type":"integer"}},"type":"object","required":["name","timeToLiveInSeconds","turnsToLive"]},"aws-native:lex:BotPlainTextMessage":{"properties":{"value":{"type":"string"}},"type":"object","required":["value"]},"aws-native:lex:BotPostDialogCodeHookInvocationSpecification":{"properties":{"failureConditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed` ."},"failureNextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed` ."},"failureResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"Specifies a list of message groups that Amazon Lex uses to respond the user input when the code hook fails."},"successConditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"A list of conditional branches to evaluate after the dialog code hook finishes successfully."},"successNextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"Specifics the next step the bot runs after the dialog code hook finishes successfully."},"successResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"Specifies a list of message groups that Amazon Lex uses to respond when the code hook succeeds."},"timeoutConditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"A list of conditional branches to evaluate if the code hook times out."},"timeoutNextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"Specifies the next step that the bot runs when the code hook times out."},"timeoutResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"Specifies a list of message groups that Amazon Lex uses to respond to the user input when the code hook times out."}},"type":"object"},"aws-native:lex:BotPostFulfillmentStatusSpecification":{"properties":{"failureConditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed` ."},"failureNextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed` ."},"failureResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn't successful."},"successConditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"A list of conditional branches to evaluate after the fulfillment code hook finishes successfully."},"successNextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully."},"successResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"Specifies a list of message groups that Amazon Lex uses to respond when the fulfillment is successful."},"timeoutConditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"A list of conditional branches to evaluate if the fulfillment code hook times out."},"timeoutNextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"Specifies the next step that the bot runs when the fulfillment code hook times out."},"timeoutResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn't completed within the timeout period."}},"type":"object"},"aws-native:lex:BotPromptAttemptSpecification":{"properties":{"allowInterrupt":{"type":"boolean"},"allowedInputTypes":{"$ref":"#/types/aws-native:lex:BotAllowedInputTypes"},"audioAndDtmfInputSpecification":{"$ref":"#/types/aws-native:lex:BotAudioAndDtmfInputSpecification"},"textInputSpecification":{"$ref":"#/types/aws-native:lex:BotTextInputSpecification"}},"type":"object","required":["allowedInputTypes"]},"aws-native:lex:BotPromptSpecification":{"properties":{"allowInterrupt":{"type":"boolean","description":"Indicates whether the user can interrupt a speech prompt from the bot."},"maxRetries":{"type":"integer","description":"The maximum number of times the bot tries to elicit a response from the user using this prompt."},"messageGroupsList":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotMessageGroup"},"description":"A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime."},"messageSelectionStrategy":{"$ref":"#/types/aws-native:lex:BotMessageSelectionStrategy","description":"Indicates how a message is selected from a message group among retries."},"promptAttemptsSpecification":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:lex:BotPromptAttemptSpecification"},"description":"Specifies the advanced settings on each attempt of the prompt."}},"type":"object","required":["maxRetries","messageGroupsList"]},"aws-native:lex:BotQInConnectIntentConfiguration":{"properties":{"qInConnectAssistantConfiguration":{"$ref":"#/types/aws-native:lex:BotQInConnectIntentConfigurationQInConnectAssistantConfigurationProperties"}},"type":"object"},"aws-native:lex:BotQInConnectIntentConfigurationQInConnectAssistantConfigurationProperties":{"properties":{"assistantArn":{"type":"string"}},"type":"object","required":["assistantArn"]},"aws-native:lex:BotQnAIntentConfiguration":{"properties":{"bedrockModelConfiguration":{"$ref":"#/types/aws-native:lex:BotBedrockModelSpecification"},"dataSourceConfiguration":{"$ref":"#/types/aws-native:lex:BotQnAIntentConfigurationDataSourceConfigurationProperties","description":"Contains details about the configuration of the data source used for the `AMAZON.QnAIntent` ."}},"type":"object","required":["bedrockModelConfiguration","dataSourceConfiguration"]},"aws-native:lex:BotQnAIntentConfigurationDataSourceConfigurationProperties":{"description":"Contains details about the configuration of the data source used for the `AMAZON.QnAIntent` .","properties":{"bedrockKnowledgeStoreConfiguration":{"$ref":"#/types/aws-native:lex:BotQnAIntentConfigurationDataSourceConfigurationPropertiesBedrockKnowledgeStoreConfigurationProperties"},"kendraConfiguration":{"$ref":"#/types/aws-native:lex:BotQnAKendraConfiguration"},"opensearchConfiguration":{"$ref":"#/types/aws-native:lex:BotQnAIntentConfigurationDataSourceConfigurationPropertiesOpensearchConfigurationProperties"}},"type":"object"},"aws-native:lex:BotQnAIntentConfigurationDataSourceConfigurationPropertiesBedrockKnowledgeStoreConfigurationProperties":{"properties":{"bedrockKnowledgeBaseArn":{"type":"string"},"bkbExactResponseFields":{"$ref":"#/types/aws-native:lex:BotQnAIntentConfigurationDataSourceConfigurationPropertiesBedrockKnowledgeStoreConfigurationPropertiesBkbExactResponseFieldsProperties"},"exactResponse":{"type":"boolean"}},"type":"object"},"aws-native:lex:BotQnAIntentConfigurationDataSourceConfigurationPropertiesBedrockKnowledgeStoreConfigurationPropertiesBkbExactResponseFieldsProperties":{"properties":{"answerField":{"type":"string"}},"type":"object"},"aws-native:lex:BotQnAIntentConfigurationDataSourceConfigurationPropertiesOpensearchConfigurationProperties":{"properties":{"domainEndpoint":{"type":"string"},"exactResponse":{"type":"boolean"},"exactResponseFields":{"$ref":"#/types/aws-native:lex:BotQnAIntentConfigurationDataSourceConfigurationPropertiesOpensearchConfigurationPropertiesExactResponseFieldsProperties"},"includeFields":{"type":"array","items":{"type":"string"}},"indexName":{"type":"string"}},"type":"object"},"aws-native:lex:BotQnAIntentConfigurationDataSourceConfigurationPropertiesOpensearchConfigurationPropertiesExactResponseFieldsProperties":{"properties":{"answerField":{"type":"string"},"questionField":{"type":"string"}},"type":"object"},"aws-native:lex:BotQnAKendraConfiguration":{"properties":{"exactResponse":{"type":"boolean","description":"Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at [Adding frequently asked questions (FAQs) to an index](https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html) ."},"kendraIndex":{"type":"string","description":"The ARN of the Amazon Kendra index to use."},"queryFilterString":{"type":"string","description":"Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see [Using document attributes to filter search results](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering) ."},"queryFilterStringEnabled":{"type":"boolean","description":"Specifies whether to enable an Amazon Kendra filter string or not."}},"type":"object","required":["exactResponse","kendraIndex","queryFilterStringEnabled"]},"aws-native:lex:BotReplication":{"properties":{"replicaRegions":{"type":"array","items":{"type":"string"}}},"type":"object","required":["replicaRegions"]},"aws-native:lex:BotResponseSpecification":{"properties":{"allowInterrupt":{"type":"boolean","description":"Indicates whether the user can interrupt a speech response from Amazon Lex."},"messageGroupsList":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotMessageGroup"},"description":"A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime."}},"type":"object","required":["messageGroupsList"]},"aws-native:lex:BotS3BucketLogDestination":{"properties":{"kmsKeyArn":{"type":"string"},"logPrefix":{"type":"string"},"s3BucketArn":{"type":"string"}},"type":"object","required":["logPrefix","s3BucketArn"]},"aws-native:lex:BotS3Location":{"properties":{"s3Bucket":{"type":"string","description":"The S3 bucket name."},"s3ObjectKey":{"type":"string","description":"The path and file name to the object in the S3 bucket."},"s3ObjectVersion":{"type":"string","description":"The version of the object in the S3 bucket."}},"type":"object","required":["s3Bucket","s3ObjectKey"]},"aws-native:lex:BotSampleUtterance":{"properties":{"utterance":{"type":"string"}},"type":"object","required":["utterance"]},"aws-native:lex:BotSampleValue":{"properties":{"value":{"type":"string"}},"type":"object","required":["value"]},"aws-native:lex:BotSessionAttribute":{"properties":{"key":{"type":"string","description":"The name of the session attribute."},"value":{"type":"string","description":"The session-specific context information for the session attribute."}},"type":"object","required":["key"]},"aws-native:lex:BotSlot":{"properties":{"description":{"type":"string","description":"The description of the slot."},"multipleValuesSetting":{"$ref":"#/types/aws-native:lex:BotMultipleValuesSetting","description":"Indicates whether a slot can return multiple values."},"name":{"type":"string","description":"The name given to the slot."},"obfuscationSetting":{"$ref":"#/types/aws-native:lex:BotObfuscationSetting","description":"Determines whether the contents of the slot are obfuscated in Amazon CloudWatch Logs logs. Use obfuscated slots to protect information such as personally identifiable information (PII) in logs."},"slotTypeName":{"type":"string","description":"The name of the slot type that this slot is based on. The slot type defines the acceptable values for the slot."},"subSlotSetting":{"$ref":"#/types/aws-native:lex:BotSubSlotSetting"},"valueElicitationSetting":{"$ref":"#/types/aws-native:lex:BotSlotValueElicitationSetting","description":"Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:\n\n- ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to a slot value.\n- TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.\n\nIf you don't specify the `valueSelectionStrategy` , the default is `ORIGINAL_VALUE` ."}},"type":"object","required":["name","slotTypeName","valueElicitationSetting"]},"aws-native:lex:BotSlotCaptureSetting":{"properties":{"captureConditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"A list of conditional branches to evaluate after the slot value is captured."},"captureNextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"Specifies the next step that the bot runs when the slot value is captured before the code hook times out."},"captureResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"Specifies a list of message groups that Amazon Lex uses to respond the user input."},"codeHook":{"$ref":"#/types/aws-native:lex:BotDialogCodeHookInvocationSetting","description":"Code hook called after Amazon Lex successfully captures a slot value."},"elicitationCodeHook":{"$ref":"#/types/aws-native:lex:BotElicitationCodeHookInvocationSetting","description":"Code hook called when Amazon Lex doesn't capture a slot value."},"failureConditional":{"$ref":"#/types/aws-native:lex:BotConditionalSpecification","description":"A list of conditional branches to evaluate when the slot value isn't captured."},"failureNextStep":{"$ref":"#/types/aws-native:lex:BotDialogState","description":"Specifies the next step that the bot runs when the slot value code is not recognized."},"failureResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"Specifies a list of message groups that Amazon Lex uses to respond the user input when the slot fails to be captured."}},"type":"object"},"aws-native:lex:BotSlotConstraint":{"type":"string","enum":[{"name":"Required","value":"Required"},{"name":"Optional","value":"Optional"}]},"aws-native:lex:BotSlotDefaultValue":{"properties":{"defaultValue":{"type":"string","description":"The default value to use when a user doesn't provide a value for a slot."}},"type":"object","required":["defaultValue"]},"aws-native:lex:BotSlotDefaultValueSpecification":{"properties":{"defaultValueList":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSlotDefaultValue"},"description":"A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list."}},"type":"object","required":["defaultValueList"]},"aws-native:lex:BotSlotPriority":{"properties":{"priority":{"type":"integer"},"slotName":{"type":"string"}},"type":"object","required":["priority","slotName"]},"aws-native:lex:BotSlotShape":{"type":"string","enum":[{"name":"Scalar","value":"Scalar"},{"name":"List","value":"List"}]},"aws-native:lex:BotSlotType":{"properties":{"compositeSlotTypeSetting":{"$ref":"#/types/aws-native:lex:BotCompositeSlotTypeSetting"},"description":{"type":"string","description":"A description of the slot type. Use the description to help identify the slot type in lists."},"externalSourceSetting":{"$ref":"#/types/aws-native:lex:BotExternalSourceSetting","description":"Sets the type of external information used to create the slot type."},"name":{"type":"string","description":"The name of the slot type. A slot type name must be unique withing the account."},"parentSlotTypeSignature":{"type":"string","description":"The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent lot type.\n\nOnly `AMAZON.AlphaNumeric` is supported."},"slotTypeValues":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSlotTypeValue"},"description":"A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for the slot."},"valueSelectionSetting":{"$ref":"#/types/aws-native:lex:BotSlotValueSelectionSetting","description":"Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:\n\n- `ORIGINAL_VALUE` - Returns the value entered by the user, if the user value is similar to the slot value.\n- `TOP_RESOLUTION` - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.\n\nIf you don't specify the `valueSelectionStrategy` , the default is `ORIGINAL_VALUE` ."}},"type":"object","required":["name"]},"aws-native:lex:BotSlotTypeValue":{"properties":{"sampleValue":{"$ref":"#/types/aws-native:lex:BotSampleValue"},"synonyms":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSampleValue"}}},"type":"object","required":["sampleValue"]},"aws-native:lex:BotSlotValue":{"properties":{"interpretedValue":{"type":"string","description":"The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the `resolvedValues` list."}},"type":"object"},"aws-native:lex:BotSlotValueElicitationSetting":{"properties":{"defaultValueSpecification":{"$ref":"#/types/aws-native:lex:BotSlotDefaultValueSpecification","description":"A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values."},"promptSpecification":{"$ref":"#/types/aws-native:lex:BotPromptSpecification","description":"The prompt that Amazon Lex uses to elicit the slot value from the user."},"sampleUtterances":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSampleUtterance"},"description":"If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances."},"slotCaptureSetting":{"$ref":"#/types/aws-native:lex:BotSlotCaptureSetting","description":"Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user."},"slotConstraint":{"$ref":"#/types/aws-native:lex:BotSlotConstraint","description":"Specifies whether the slot is required or optional."},"waitAndContinueSpecification":{"$ref":"#/types/aws-native:lex:BotWaitAndContinueSpecification","description":"Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input."}},"type":"object","required":["slotConstraint"]},"aws-native:lex:BotSlotValueOverride":{"properties":{"shape":{"$ref":"#/types/aws-native:lex:BotSlotShape","description":"When the shape value is `List` , it indicates that the `values` field contains a list of slot values. When the value is `Scalar` , it indicates that the `value` field contains a single value."},"value":{"$ref":"#/types/aws-native:lex:BotSlotValue","description":"The current value of the slot."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSlotValueOverride"},"description":"A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be \"pepperoni\" and \"pineapple.\""}},"type":"object"},"aws-native:lex:BotSlotValueOverrideMap":{"properties":{"slotName":{"type":"string","description":"The name of the slot."},"slotValueOverride":{"$ref":"#/types/aws-native:lex:BotSlotValueOverride","description":"The SlotValueOverride object to which the slot name will be mapped."}},"type":"object"},"aws-native:lex:BotSlotValueRegexFilter":{"properties":{"pattern":{"type":"string","description":"A regular expression used to validate the value of a slot.\n\nUse a standard regular expression. Amazon Lex supports the following characters in the regular expression:\n\n- A-Z, a-z\n- 0-9\n- Unicode characters (\"\\⁠u\u003cUnicode\u003e\")\n\nRepresent Unicode characters with four digits, for example \"\\⁠u0041\" or \"\\⁠u005A\".\n\nThe following regular expression operators are not supported:\n\n- Infinite repeaters: *, +, or {x,} with no upper bound.\n- Wild card (.)"}},"type":"object","required":["pattern"]},"aws-native:lex:BotSlotValueResolutionStrategy":{"type":"string","enum":[{"name":"OriginalValue","value":"ORIGINAL_VALUE"},{"name":"TopResolution","value":"TOP_RESOLUTION"},{"name":"Concatenation","value":"CONCATENATION"}]},"aws-native:lex:BotSlotValueSelectionSetting":{"properties":{"advancedRecognitionSetting":{"$ref":"#/types/aws-native:lex:BotAdvancedRecognitionSetting","description":"Provides settings that enable advanced recognition settings for slot values. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances."},"regexFilter":{"$ref":"#/types/aws-native:lex:BotSlotValueRegexFilter","description":"A regular expression used to validate the value of a slot."},"resolutionStrategy":{"$ref":"#/types/aws-native:lex:BotSlotValueResolutionStrategy","description":"Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:\n\n- `ORIGINAL_VALUE` - Returns the value entered by the user, if the user value is similar to the slot value.\n- `TOP_RESOLUTION` - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.\n\nIf you don't specify the `valueSelectionStrategy` , the default is `ORIGINAL_VALUE` ."}},"type":"object","required":["resolutionStrategy"]},"aws-native:lex:BotSpecifications":{"properties":{"slotTypeId":{"type":"string"},"slotTypeName":{"type":"string"},"valueElicitationSetting":{"$ref":"#/types/aws-native:lex:BotSubSlotValueElicitationSetting"}},"type":"object","required":["valueElicitationSetting"]},"aws-native:lex:BotSpeechDetectionSensitivity":{"type":"string","enum":[{"name":"Default","value":"Default"},{"name":"HighNoiseTolerance","value":"HighNoiseTolerance"},{"name":"MaximumNoiseTolerance","value":"MaximumNoiseTolerance"}]},"aws-native:lex:BotSpeechModelConfig":{"properties":{"deepgramConfig":{"$ref":"#/types/aws-native:lex:BotDeepgramSpeechModelConfig"}},"type":"object"},"aws-native:lex:BotSpeechModelPreference":{"type":"string","enum":[{"name":"Standard","value":"Standard"},{"name":"Neural","value":"Neural"},{"name":"Deepgram","value":"Deepgram"}]},"aws-native:lex:BotSpeechRecognitionSettings":{"properties":{"speechModelConfig":{"$ref":"#/types/aws-native:lex:BotSpeechModelConfig"},"speechModelPreference":{"$ref":"#/types/aws-native:lex:BotSpeechModelPreference"}},"type":"object"},"aws-native:lex:BotSsmlMessage":{"properties":{"value":{"type":"string"}},"type":"object","required":["value"]},"aws-native:lex:BotStillWaitingResponseSpecification":{"properties":{"allowInterrupt":{"type":"boolean","description":"Indicates that the user can interrupt the response by speaking while the message is being played."},"frequencyInSeconds":{"type":"integer","description":"How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes."},"messageGroupsList":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotMessageGroup"},"description":"One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user."},"timeoutInSeconds":{"type":"integer","description":"If Amazon Lex waits longer than this length of time for a response, it will stop sending messages."}},"type":"object","required":["frequencyInSeconds","messageGroupsList","timeoutInSeconds"]},"aws-native:lex:BotSubSlotSetting":{"properties":{"expression":{"type":"string","description":"The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators."},"slotSpecifications":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:lex:BotSpecifications"},"description":"Specifications for the constituent sub slots of a composite slot."}},"type":"object"},"aws-native:lex:BotSubSlotTypeComposition":{"properties":{"name":{"type":"string","description":"Name of a constituent sub slot inside a composite slot."},"slotTypeId":{"type":"string","description":"The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type."},"slotTypeName":{"type":"string"}},"type":"object","required":["name"]},"aws-native:lex:BotSubSlotValueElicitationSetting":{"properties":{"defaultValueSpecification":{"$ref":"#/types/aws-native:lex:BotSlotDefaultValueSpecification"},"promptSpecification":{"$ref":"#/types/aws-native:lex:BotPromptSpecification"},"sampleUtterances":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotSampleUtterance"}},"waitAndContinueSpecification":{"$ref":"#/types/aws-native:lex:BotWaitAndContinueSpecification"}},"type":"object"},"aws-native:lex:BotTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:lex:BotTestBotAliasSettings":{"properties":{"botAliasLocaleSettings":{"type":"array","items":{"$ref":"#/types/aws-native:lex:BotAliasLocaleSettingsItem"},"description":"Specifies settings that are unique to a locale. For example, you can use a different Lambda function depending on the bot's locale."},"conversationLogSettings":{"$ref":"#/types/aws-native:lex:BotConversationLogSettings","description":"Specifies settings for conversation logs that save audio, text, and metadata information for conversations with your users."},"description":{"type":"string","description":"Specifies a description for the test bot alias."},"sentimentAnalysisSettings":{"$ref":"#/types/aws-native:lex:BotTestBotAliasSettingsSentimentAnalysisSettingsProperties","description":"Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances."}},"type":"object"},"aws-native:lex:BotTestBotAliasSettingsSentimentAnalysisSettingsProperties":{"description":"Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.","properties":{"detectSentiment":{"type":"boolean"}},"type":"object","required":["detectSentiment"]},"aws-native:lex:BotTextInputSpecification":{"properties":{"startTimeoutMs":{"type":"integer"}},"type":"object","required":["startTimeoutMs"]},"aws-native:lex:BotTextLogDestination":{"properties":{"cloudWatch":{"$ref":"#/types/aws-native:lex:BotCloudWatchLogGroupLogDestination"}},"type":"object","required":["cloudWatch"]},"aws-native:lex:BotTextLogSetting":{"properties":{"destination":{"$ref":"#/types/aws-native:lex:BotTextLogDestination"},"enabled":{"type":"boolean"}},"type":"object","required":["destination","enabled"]},"aws-native:lex:BotUnifiedSpeechSettings":{"properties":{"speechFoundationModel":{"$ref":"#/types/aws-native:lex:BotUnifiedSpeechSettingsSpeechFoundationModelProperties","description":"The foundation model configuration to use for unified speech processing capabilities."}},"type":"object","required":["speechFoundationModel"]},"aws-native:lex:BotUnifiedSpeechSettingsSpeechFoundationModelProperties":{"description":"The foundation model configuration to use for unified speech processing capabilities.","properties":{"modelArn":{"type":"string"},"voiceId":{"type":"string"}},"type":"object","required":["modelArn"]},"aws-native:lex:BotVersionLocaleDetails":{"description":"The version of a bot used for a bot locale.","properties":{"sourceBotVersion":{"type":"string"}},"type":"object","required":["sourceBotVersion"]},"aws-native:lex:BotVersionLocaleSpecification":{"properties":{"botVersionLocaleDetails":{"$ref":"#/types/aws-native:lex:BotVersionLocaleDetails"},"localeId":{"type":"string"}},"type":"object","required":["botVersionLocaleDetails","localeId"]},"aws-native:lex:BotVoiceSettings":{"properties":{"engine":{"$ref":"#/types/aws-native:lex:BotVoiceSettingsEngine","description":"Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the [`engine` parameter of the `SynthesizeSpeech` operation](https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine) in the *Amazon Polly developer guide* .\n\nIf you do not specify a value, the default is `standard` ."},"voiceId":{"type":"string","description":"The identifier of the Amazon Polly voice to use."}},"type":"object","required":["voiceId"]},"aws-native:lex:BotVoiceSettingsEngine":{"description":"Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the [`engine` parameter of the `SynthesizeSpeech` operation](https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine) in the *Amazon Polly developer guide* .\n\nIf you do not specify a value, the default is `standard` .","type":"string","enum":[{"name":"Standard","value":"standard"},{"name":"Neural","value":"neural"},{"name":"LongForm","value":"long-form"},{"name":"Generative","value":"generative"}]},"aws-native:lex:BotWaitAndContinueSpecification":{"properties":{"continueResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation."},"isActive":{"type":"boolean","description":"Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the `IsActive` field isn't specified, the default is true."},"stillWaitingResponse":{"$ref":"#/types/aws-native:lex:BotStillWaitingResponseSpecification","description":"A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user."},"waitingResponse":{"$ref":"#/types/aws-native:lex:BotResponseSpecification","description":"The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue."}},"type":"object","required":["continueResponse","waitingResponse"]},"aws-native:lex:DataPrivacyProperties":{"description":"By default, data stored by Amazon Lex is encrypted. The `DataPrivacy` structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.","properties":{"childDirected":{"type":"boolean","description":"For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying `true` or `false` in the `childDirected` field. By specifying `true` in the `childDirected` field, you confirm that your use of Amazon Lex *is* related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying `false` in the `childDirected` field, you confirm that your use of Amazon Lex *is not* related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the `childDirected` field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ](https://docs.aws.amazon.com/lex/faqs#data-security) ."}},"type":"object","required":["childDirected"]},"aws-native:lex:ErrorLogSettingsProperties":{"properties":{"enabled":{"type":"boolean"}},"type":"object","required":["enabled"]},"aws-native:lex:ResourcePolicyPolicy":{"description":"A resource policy to add to the resource. The policy is a JSON structure following the IAM syntax that contains one or more statements that define the policy.","type":"object"},"aws-native:lex:SentimentAnalysisSettingsProperties":{"description":"Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.","properties":{"detectSentiment":{"type":"boolean","description":"Enable to call Amazon Comprehend for Sentiment natively within Lex"}},"type":"object","required":["detectSentiment"]},"aws-native:licensemanager:GrantTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag."},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key","value"]},"aws-native:licensemanager:LicenseBorrowConfiguration":{"properties":{"allowEarlyCheckIn":{"type":"boolean","description":"Indicates whether early check-ins are allowed."},"maxTimeToLiveInMinutes":{"type":"integer","description":"Maximum time for the borrow configuration, in minutes."}},"type":"object","required":["allowEarlyCheckIn","maxTimeToLiveInMinutes"]},"aws-native:licensemanager:LicenseConsumptionConfiguration":{"properties":{"borrowConfiguration":{"$ref":"#/types/aws-native:licensemanager:LicenseBorrowConfiguration","description":"Details about a borrow configuration."},"provisionalConfiguration":{"$ref":"#/types/aws-native:licensemanager:LicenseProvisionalConfiguration","description":"Details about a provisional configuration."},"renewType":{"type":"string","description":"Renewal frequency."}},"type":"object"},"aws-native:licensemanager:LicenseEntitlement":{"properties":{"allowCheckIn":{"type":"boolean","description":"Indicates whether check-ins are allowed."},"maxCount":{"type":"integer","description":"Maximum entitlement count. Use if the unit is not None."},"name":{"type":"string","description":"Entitlement name."},"overage":{"type":"boolean","description":"Indicates whether overages are allowed."},"unit":{"type":"string","description":"Entitlement unit."},"value":{"type":"string","description":"Entitlement resource. Use only if the unit is None."}},"type":"object","required":["name","unit"]},"aws-native:licensemanager:LicenseIssuerData":{"properties":{"name":{"type":"string","description":"Issuer name."},"signKey":{"type":"string","description":"Asymmetric KMS key from AWS Key Management Service . The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm."}},"type":"object","required":["name"]},"aws-native:licensemanager:LicenseMetadata":{"properties":{"name":{"type":"string","description":"The key name."},"value":{"type":"string","description":"The value."}},"type":"object","required":["name","value"]},"aws-native:licensemanager:LicenseProvisionalConfiguration":{"properties":{"maxTimeToLiveInMinutes":{"type":"integer","description":"Maximum time for the provisional configuration, in minutes."}},"type":"object","required":["maxTimeToLiveInMinutes"]},"aws-native:licensemanager:LicenseTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag."},"value":{"type":"string","description":"The value for the tag."}},"type":"object","required":["key","value"]},"aws-native:licensemanager:LicenseValidityDateFormat":{"properties":{"begin":{"type":"string","description":"Validity begin date for the license."},"end":{"type":"string","description":"Validity begin date for the license."}},"type":"object","required":["begin","end"]},"aws-native:lightsail:BucketAccessRules":{"description":"An object that sets the public accessibility of objects in the specified bucket.","properties":{"allowPublicOverrides":{"type":"boolean","description":"A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified."},"getObject":{"type":"string","description":"Specifies the anonymous access to all objects in a bucket."}},"type":"object"},"aws-native:lightsail:BucketTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:lightsail:CertificateTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:lightsail:Container":{"description":"Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.","properties":{"command":{"type":"array","items":{"type":"string"},"description":"The launch command for the container."},"containerName":{"type":"string","description":"The name of the container."},"environment":{"type":"array","items":{"$ref":"#/types/aws-native:lightsail:ContainerEnvironmentVariable"},"description":"The environment variables of the container."},"image":{"type":"string","description":"The name of the image used for the container."},"ports":{"type":"array","items":{"$ref":"#/types/aws-native:lightsail:ContainerPortInfo"},"description":"The open firewall ports of the container."}},"type":"object"},"aws-native:lightsail:ContainerEnvironmentVariable":{"properties":{"value":{"type":"string","description":"The environment variable value."},"variable":{"type":"string","description":"The environment variable key."}},"type":"object"},"aws-native:lightsail:ContainerHealthCheckConfig":{"description":"Describes the health check configuration of an Amazon Lightsail container service.","properties":{"healthyThreshold":{"type":"integer","description":"The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2."},"intervalSeconds":{"type":"integer","description":"The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5."},"path":{"type":"string","description":"The path on the container on which to perform the health check. The default value is /."},"successCodes":{"type":"string","description":"The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299)."},"timeoutSeconds":{"type":"integer","description":"The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2."},"unhealthyThreshold":{"type":"integer","description":"The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2."}},"type":"object"},"aws-native:lightsail:ContainerPortInfo":{"properties":{"port":{"type":"string","description":"The open firewall ports of the container."},"protocol":{"type":"string","description":"The protocol name for the open ports.\n\n*Allowed values* : `HTTP` | `HTTPS` | `TCP` | `UDP`"}},"type":"object"},"aws-native:lightsail:ContainerPrivateRegistryAccess":{"description":"An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.","properties":{"ecrImagePullerRole":{"$ref":"#/types/aws-native:lightsail:ContainerPrivateRegistryAccessEcrImagePullerRoleProperties","description":"An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories."}},"type":"object"},"aws-native:lightsail:ContainerPrivateRegistryAccessEcrImagePullerRoleProperties":{"description":"An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.","properties":{"isActive":{"type":"boolean","description":"A Boolean value that indicates whether to activate the role."},"principalArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the role, if it is activated."}},"type":"object"},"aws-native:lightsail:ContainerPublicDomainName":{"description":"The public domain name to use with the container service, such as example.com and www.example.com.","properties":{"certificateName":{"type":"string","description":"The name of the certificate for the public domains."},"domainNames":{"type":"array","items":{"type":"string"},"description":"An object that describes the configuration for the containers of the deployment."}},"type":"object"},"aws-native:lightsail:ContainerPublicEndpoint":{"description":"Describes the settings of a public endpoint for an Amazon Lightsail container service.","properties":{"containerName":{"type":"string","description":"The name of the container for the endpoint."},"containerPort":{"type":"integer","description":"The port of the container to which traffic is forwarded to."},"healthCheckConfig":{"$ref":"#/types/aws-native:lightsail:ContainerHealthCheckConfig","description":"An object that describes the health check configuration of the container."}},"type":"object"},"aws-native:lightsail:ContainerServiceDeployment":{"description":"Describes a container deployment configuration of an Amazon Lightsail container service.","properties":{"containers":{"type":"array","items":{"$ref":"#/types/aws-native:lightsail:Container"},"description":"An object that describes the configuration for the containers of the deployment."},"publicEndpoint":{"$ref":"#/types/aws-native:lightsail:ContainerPublicEndpoint","description":"An object that describes the endpoint of the deployment."}},"type":"object"},"aws-native:lightsail:ContainerTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:lightsail:DatabaseRelationalDatabaseParameter":{"description":"Describes the parameters of the database.","properties":{"allowedValues":{"type":"string","description":"Specifies the valid range of values for the parameter."},"applyMethod":{"type":"string","description":"Indicates when parameter updates are applied. Can be immediate or pending-reboot."},"applyType":{"type":"string","description":"Specifies the engine-specific parameter type."},"dataType":{"type":"string","description":"Specifies the valid data type for the parameter."},"description":{"type":"string","description":"Provides a description of the parameter."},"isModifiable":{"type":"boolean","description":"A Boolean value indicating whether the parameter can be modified."},"parameterName":{"type":"string","description":"Specifies the name of the parameter."},"parameterValue":{"type":"string","description":"Specifies the value of the parameter."}},"type":"object"},"aws-native:lightsail:DatabaseSnapshotResourceType":{"description":"The Lightsail resource type.","type":"string","enum":[{"name":"RelationalDatabaseSnapshot","value":"RelationalDatabaseSnapshot"}]},"aws-native:lightsail:DatabaseSnapshotTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:lightsail:DatabaseTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:lightsail:DiskAddOn":{"description":"A addon associate with a resource.","properties":{"addOnType":{"type":"string","description":"The add-on type"},"autoSnapshotAddOnRequest":{"$ref":"#/types/aws-native:lightsail:DiskAutoSnapshotAddOn","description":"The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created."},"status":{"$ref":"#/types/aws-native:lightsail:DiskAddOnStatus","description":"Status of the Addon"}},"type":"object","required":["addOnType"]},"aws-native:lightsail:DiskAddOnStatus":{"description":"Status of the Addon","type":"string","enum":[{"name":"Enabling","value":"Enabling"},{"name":"Disabling","value":"Disabling"},{"name":"Enabled","value":"Enabled"},{"name":"Terminating","value":"Terminating"},{"name":"Terminated","value":"Terminated"},{"name":"Disabled","value":"Disabled"},{"name":"Failed","value":"Failed"}]},"aws-native:lightsail:DiskAutoSnapshotAddOn":{"description":"An object that represents additional parameters when enabling or modifying the automatic snapshot add-on","properties":{"snapshotTimeOfDay":{"type":"string","description":"The daily time when an automatic snapshot will be created."}},"type":"object"},"aws-native:lightsail:DiskLocation":{"description":"Location of a resource.","properties":{"availabilityZone":{"type":"string","description":"The Availability Zone in which to create your disk. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request."},"regionName":{"type":"string","description":"The Region Name in which to create your disk."}},"type":"object"},"aws-native:lightsail:DiskSnapshotResourceType":{"description":"The Lightsail resource type (DiskSnapshot).","type":"string","enum":[{"name":"DiskSnapshot","value":"DiskSnapshot"}]},"aws-native:lightsail:DiskSnapshotState":{"description":"The status of the disk snapshot operation.","type":"string","enum":[{"name":"Pending","value":"pending"},{"name":"Completed","value":"completed"},{"name":"Error","value":"error"},{"name":"Unknown","value":"unknown"}]},"aws-native:lightsail:DiskSnapshotTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:lightsail:DiskTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:lightsail:InstanceAddOn":{"description":"A addon associate with a resource.","properties":{"addOnType":{"type":"string","description":"The add-on type"},"autoSnapshotAddOnRequest":{"$ref":"#/types/aws-native:lightsail:InstanceAutoSnapshotAddOn","description":"The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created."},"status":{"$ref":"#/types/aws-native:lightsail:InstanceAddOnStatus","description":"Status of the Addon"}},"type":"object","required":["addOnType"]},"aws-native:lightsail:InstanceAddOnStatus":{"description":"Status of the Addon","type":"string","enum":[{"name":"Enabling","value":"Enabling"},{"name":"Disabling","value":"Disabling"},{"name":"Enabled","value":"Enabled"},{"name":"Terminating","value":"Terminating"},{"name":"Terminated","value":"Terminated"},{"name":"Disabled","value":"Disabled"},{"name":"Failed","value":"Failed"}]},"aws-native:lightsail:InstanceAutoSnapshotAddOn":{"description":"An object that represents additional parameters when enabling or modifying the automatic snapshot add-on","properties":{"snapshotTimeOfDay":{"type":"string","description":"The daily time when an automatic snapshot will be created."}},"type":"object"},"aws-native:lightsail:InstanceDisk":{"description":"Disk associated with the Instance.","properties":{"attachedTo":{"type":"string","description":"Instance attached to the disk."},"attachmentState":{"type":"string","description":"Attachment state of the disk."},"diskName":{"type":"string","description":"The names to use for your new Lightsail disk."},"iops":{"type":"integer","description":"IOPS of disk."},"isSystemDisk":{"type":"boolean","description":"Is the Attached disk is the system disk of the Instance."},"path":{"type":"string","description":"Path of the disk attached to the instance."},"sizeInGb":{"type":"string","description":"Size of the disk attached to the Instance."}},"type":"object","required":["diskName","path"]},"aws-native:lightsail:InstanceHardware":{"description":"Hardware of the Instance.","properties":{"cpuCount":{"type":"integer","description":"CPU count of the Instance."},"disks":{"type":"array","items":{"$ref":"#/types/aws-native:lightsail:InstanceDisk"},"description":"Disks attached to the Instance."},"ramSizeInGb":{"type":"integer","description":"RAM Size of the Instance."}},"type":"object"},"aws-native:lightsail:InstanceLocation":{"description":"Location of a resource.","properties":{"availabilityZone":{"type":"string","description":"The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request."},"regionName":{"type":"string","description":"The Region Name in which to create your instance."}},"type":"object"},"aws-native:lightsail:InstanceMonthlyTransfer":{"description":"Monthly Transfer of the Instance.","properties":{"gbPerMonthAllocated":{"type":"string","description":"GbPerMonthAllocated of the Instance."}},"type":"object"},"aws-native:lightsail:InstanceNetworking":{"description":"Networking of the Instance.","properties":{"monthlyTransfer":{"$ref":"#/types/aws-native:lightsail:InstanceMonthlyTransfer","description":"The monthly amount of data transfer, in GB, allocated for the instance"},"ports":{"type":"array","items":{"$ref":"#/types/aws-native:lightsail:InstancePort"},"description":"Ports to the Instance."}},"type":"object","required":["ports"]},"aws-native:lightsail:InstancePort":{"description":"Port of the Instance.","properties":{"accessDirection":{"type":"string","description":"Access Direction for Protocol of the Instance(inbound/outbound)."},"accessFrom":{"type":"string","description":"Access From Protocol of the Instance."},"accessType":{"type":"string","description":"Access Type Protocol of the Instance."},"cidrListAliases":{"type":"array","items":{"type":"string"},"description":"An alias that defines access for a preconfigured range of IP addresses.\n\nThe only alias currently supported is `lightsail-connect` , which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance."},"cidrs":{"type":"array","items":{"type":"string"},"description":"The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.\n\n\u003e The `ipv6Cidrs` parameter lists the IPv6 addresses that are allowed to connect to an instance. \n\nExamples:\n\n- To allow the IP address `192.0.2.44` , specify `192.0.2.44` or `192.0.2.44/32` .\n- To allow the IP addresses `192.0.2.0` to `192.0.2.255` , specify `192.0.2.0/24` ."},"commonName":{"type":"string","description":"CommonName for Protocol of the Instance."},"fromPort":{"type":"integer","description":"From Port of the Instance."},"ipv6Cidrs":{"type":"array","items":{"type":"string"},"description":"The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.\n\n\u003e The `cidrs` parameter lists the IPv4 addresses that are allowed to connect to an instance."},"protocol":{"type":"string","description":"Port Protocol of the Instance."},"toPort":{"type":"integer","description":"To Port of the Instance."}},"type":"object"},"aws-native:lightsail:InstanceSnapshotLocation":{"description":"The region name and Availability Zone where you created the snapshot.","properties":{"availabilityZone":{"type":"string","description":"The Availability Zone. Follows the format us-east-2a (case-sensitive)."},"regionName":{"type":"string","description":"The AWS Region name."}},"type":"object"},"aws-native:lightsail:InstanceSnapshotTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:lightsail:InstanceState":{"description":"Current State of the Instance.","properties":{"code":{"type":"integer","description":"Status code of the Instance."},"name":{"type":"string","description":"Status code of the Instance."}},"type":"object"},"aws-native:lightsail:InstanceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:lightsail:LoadBalancerTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:lightsail:LocationProperties":{"description":"The AWS Region and Availability Zone where the disk snapshot was created.","properties":{"availabilityZone":{"type":"string","description":"The Availability Zone where the disk snapshot was created."},"regionName":{"type":"string","description":"The AWS Region where the disk snapshot was created."}},"type":"object"},"aws-native:location:ApiKeyAndroidApp":{"properties":{"certificateFingerprint":{"type":"string"},"package":{"type":"string"}},"type":"object","required":["certificateFingerprint","package"]},"aws-native:location:ApiKeyAppleApp":{"properties":{"bundleId":{"type":"string"}},"type":"object","required":["bundleId"]},"aws-native:location:ApiKeyRestrictions":{"properties":{"allowActions":{"type":"array","items":{"type":"string"},"description":"A list of allowed actions that an API key resource grants permissions to perform. You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.\n\nThe following are valid values for the actions.\n\n- *Map actions*\n\n- `geo:GetMap*` - Allows all actions needed for map rendering.\n- *Enhanced Maps actions*\n\n- `geo-maps:GetTile` - Allows getting map tiles for rendering.\n- `geo-maps:GetStaticMap` - Allows getting static map images.\n- *Place actions*\n\n- `geo:SearchPlaceIndexForText` - Allows finding geo coordinates of a known place.\n- `geo:SearchPlaceIndexForPosition` - Allows getting nearest address to geo coordinates.\n- `geo:SearchPlaceIndexForSuggestions` - Allows suggestions based on an incomplete or misspelled query.\n- `geo:GetPlace` - Allows getting details of a place.\n- *Enhanced Places actions*\n\n- `geo-places:Autcomplete` - Allows auto-completion of search text.\n- `geo-places:Geocode` - Allows finding geo coordinates of a known place.\n- `geo-places:GetPlace` - Allows getting details of a place.\n- `geo-places:ReverseGeocode` - Allows getting nearest address to geo coordinates.\n- `geo-places:SearchNearby` - Allows category based places search around geo coordinates.\n- `geo-places:SearchText` - Allows place or address search based on free-form text.\n- `geo-places:Suggest` - Allows suggestions based on an incomplete or misspelled query.\n- *Route actions*\n\n- `geo:CalculateRoute` - Allows point to point routing.\n- `geo:CalculateRouteMatrix` - Allows matrix routing.\n- *Enhanced Routes actions*\n\n- `geo-routes:CalculateIsolines` - Allows isoline calculation.\n- `geo-routes:CalculateRoutes` - Allows point to point routing.\n- `geo-routes:CalculateRouteMatrix` - Allows matrix routing.\n- `geo-routes:OptimizeWaypoints` - Allows computing the best sequence of waypoints.\n- `geo-routes:SnapToRoads` - Allows snapping GPS points to a likely route.\n\n\u003e You must use these strings exactly. For example, to provide access to map rendering, the only valid action is `geo:GetMap*` as an input to the list. `[\"geo:GetMap*\"]` is valid but `[\"geo:GetTile\"]` is not. Similarly, you cannot use `[\"geo:SearchPlaceIndexFor*\"]` - you must list each of the Place actions separately."},"allowAndroidApps":{"type":"array","items":{"$ref":"#/types/aws-native:location:ApiKeyAndroidApp"}},"allowAppleApps":{"type":"array","items":{"$ref":"#/types/aws-native:location:ApiKeyAppleApp"}},"allowReferers":{"type":"array","items":{"type":"string"},"description":"An optional list of allowed HTTP referers for which requests must originate from. Requests using this API key from other domains will not be allowed.\n\nRequirements:\n\n- Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list `$\\-._+!*`(),;/?:@=\u0026`\n- May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.\n- May contain wildcard characters question mark (?) and asterisk (*).\n\nQuestion mark (?) will replace any single character (including hexadecimal digits).\n\nAsterisk (*) will replace any multiple characters (including multiple hexadecimal digits).\n- No spaces allowed. For example, `https://example.com` ."},"allowResources":{"type":"array","items":{"type":"string"},"description":"A list of allowed resource ARNs that a API key bearer can perform actions on.\n\n- The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.\n- The resources must be in the same `partition` , `region` , and `account-id` as the key that is being created.\n- Other than wildcards, you must include the full ARN, including the `arn` , `partition` , `service` , `region` , `account-id` and `resource-id` delimited by colons (:).\n- No spaces allowed, even with wildcards. For example, `arn:aws:geo:region: *account-id* :map/ExampleMap*` .\n\nFor more information about ARN format, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) ."}},"type":"object","required":["allowActions","allowResources"]},"aws-native:location:ApiKeyTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:location:GeofenceCollectionPricingPlan":{"type":"string","enum":[{"name":"RequestBasedUsage","value":"RequestBasedUsage"}]},"aws-native:location:GeofenceCollectionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:location:MapConfiguration":{"properties":{"customLayers":{"type":"array","items":{"type":"string"},"description":"Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as the `POI` layer for the VectorEsriNavigation style.\n\n\u003e Currenlty only `VectorEsriNavigation` supports CustomLayers. For more information, see [Custom Layers](https://docs.aws.amazon.com//location/latest/developerguide/map-concepts.html#map-custom-layers) ."},"politicalView":{"type":"string","description":"Specifies the map political view selected from an available data provider."},"style":{"type":"string","description":"Specifies the map style selected from an available data provider.\n\nValid [Esri map styles](https://docs.aws.amazon.com/location/previous/developerguide/esri.html) :\n\n- `VectorEsriDarkGrayCanvas` – The Esri Dark Gray Canvas map style. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content.\n- `RasterEsriImagery` – The Esri Imagery map style. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide.\n- `VectorEsriLightGrayCanvas` – The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content.\n- `VectorEsriTopographic` – The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style.\n- `VectorEsriStreets` – The Esri Street Map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style. The vector tile layer is similar in content and style to the World Street Map raster map.\n- `VectorEsriNavigation` – The Esri Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices.\n\nValid [HERE Technologies map styles](https://docs.aws.amazon.com/location/previous/developerguide/HERE.html) :\n\n- `VectorHereContrast` – The HERE Contrast (Berlin) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering.\n\n\u003e The `VectorHereContrast` style has been renamed from `VectorHereBerlin` . `VectorHereBerlin` has been deprecated, but will continue to work in applications that use it.\n- `VectorHereExplore` – A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features. It also now includes a fully designed map of Japan.\n- `VectorHereExploreTruck` – A global map containing truck restrictions and attributes (e.g. width / height / HAZMAT) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics.\n- `RasterHereExploreSatellite` – A global map containing high resolution satellite imagery.\n- `HybridHereExploreSatellite` – A global map displaying the road network, street names, and city labels over satellite imagery. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved.\n\n\u003e Hybrid styles use both vector and raster tiles when rendering the map that you see. This means that more tiles are retrieved than when using either vector or raster tiles alone. Your charges will include all tiles retrieved.\n\nValid [GrabMaps map styles](https://docs.aws.amazon.com/location/previous/developerguide/grab.html) :\n\n- `VectorGrabStandardLight` – The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia.\n- `VectorGrabStandardDark` – The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia.\n\n\u003e Grab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific (Singapore) Region ( `ap-southeast-1` ). For more information, see [GrabMaps countries and area covered](https://docs.aws.amazon.com/location/previous/developerguide/grab.html#grab-coverage-area) . \n\nValid [Open Data map styles](https://docs.aws.amazon.com/location/previous/developerguide/open-data.html) :\n\n- `VectorOpenDataStandardLight` – The Open Data Standard Light map style provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.\n- `VectorOpenDataStandardDark` – Open Data Standard Dark is a dark-themed map style that provides a detailed basemap for the world suitable for website and mobile application use. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries.\n- `VectorOpenDataVisualizationLight` – The Open Data Visualization Light map style is a light-themed style with muted colors and fewer features that aids in understanding overlaid data.\n- `VectorOpenDataVisualizationDark` – The Open Data Visualization Dark map style is a dark-themed style with muted colors and fewer features that aids in understanding overlaid data."}},"type":"object","required":["style"]},"aws-native:location:MapPricingPlan":{"type":"string","enum":[{"name":"RequestBasedUsage","value":"RequestBasedUsage"}]},"aws-native:location:MapTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:location:PlaceIndexDataSourceConfiguration":{"properties":{"intendedUse":{"$ref":"#/types/aws-native:location:PlaceIndexIntendedUse","description":"Specifies how the results of an operation will be stored by the caller.\n\nValid values include:\n\n- `SingleUse` specifies that the results won't be stored.\n- `Storage` specifies that the result can be cached or stored in a database.\n\nDefault value: `SingleUse`"}},"type":"object"},"aws-native:location:PlaceIndexIntendedUse":{"type":"string","enum":[{"name":"SingleUse","value":"SingleUse"},{"name":"Storage","value":"Storage"}]},"aws-native:location:PlaceIndexPricingPlan":{"type":"string","enum":[{"name":"RequestBasedUsage","value":"RequestBasedUsage"}]},"aws-native:location:PlaceIndexTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:location:RouteCalculatorPricingPlan":{"type":"string","enum":[{"name":"RequestBasedUsage","value":"RequestBasedUsage"}]},"aws-native:location:RouteCalculatorTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:location:TrackerPositionFiltering":{"type":"string","enum":[{"name":"TimeBased","value":"TimeBased"},{"name":"DistanceBased","value":"DistanceBased"},{"name":"AccuracyBased","value":"AccuracyBased"}]},"aws-native:location:TrackerPricingPlan":{"type":"string","enum":[{"name":"RequestBasedUsage","value":"RequestBasedUsage"}]},"aws-native:location:TrackerTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:logs:AccountPolicyPolicyType":{"description":"Type of the policy.","type":"string","enum":[{"name":"DataProtectionPolicy","value":"DATA_PROTECTION_POLICY"},{"name":"SubscriptionFilterPolicy","value":"SUBSCRIPTION_FILTER_POLICY"},{"name":"FieldIndexPolicy","value":"FIELD_INDEX_POLICY"},{"name":"TransformerPolicy","value":"TRANSFORMER_POLICY"},{"name":"MetricExtractionPolicy","value":"METRIC_EXTRACTION_POLICY"}]},"aws-native:logs:AccountPolicyScope":{"description":"Scope for policy application","type":"string","enum":[{"name":"All","value":"ALL"}]},"aws-native:logs:DeliveryDestinationDestinationPolicy":{"properties":{"deliveryDestinationName":{"type":"string","description":"The name of the delivery destination to assign this policy to"},"deliveryDestinationPolicy":{"$ref":"pulumi.json#/Any","description":"The contents of the policy attached to the delivery destination"}},"type":"object"},"aws-native:logs:DeliveryDestinationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:logs:DeliverySourceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode"},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode"}},"type":"object","required":["key","value"]},"aws-native:logs:DeliveryTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode"},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode"}},"type":"object","required":["key","value"]},"aws-native:logs:DestinationTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, - and @."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, - and @."}},"type":"object","required":["key","value"]},"aws-native:logs:IntegrationOpenSearchResourceConfig":{"properties":{"applicationArn":{"type":"string","description":"If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you omit this, a new application will be created."},"dashboardViewerPrincipals":{"type":"array","items":{"type":"string"},"description":"Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.\n\n\u003e In addition to specifying these users here, you must also grant them the *CloudWatchOpenSearchDashboardAccess* IAM policy. For more information, see [IAM policies for users](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-UserRoles.html) ."},"dataSourceRoleArn":{"type":"string","description":"Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions needed, see [Permissions that the integration needs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-CreateRole.html) in the CloudWatch Logs User Guide."},"kmsKeyArn":{"type":"string","description":"To have the vended dashboard data encrypted with AWS  instead of the CloudWatch Logs default encryption method, specify the ARN of the AWS  key that you want to use."},"retentionDays":{"type":"integer","description":"Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to. This also sets the maximum time period that you can choose when viewing data in the dashboard. Choosing a longer time frame will incur additional costs."}},"type":"object","required":["dashboardViewerPrincipals","dataSourceRoleArn"]},"aws-native:logs:IntegrationStatus":{"description":"Status of creation for the Integration and its resources","type":"string","enum":[{"name":"Provisioning","value":"PROVISIONING"},{"name":"Active","value":"ACTIVE"},{"name":"Failed","value":"FAILED"}]},"aws-native:logs:IntegrationType":{"description":"The type of the Integration.","type":"string","enum":[{"name":"Opensearch","value":"OPENSEARCH"}]},"aws-native:logs:LogAnomalyDetectorEvaluationFrequency":{"description":"How often log group is evaluated","type":"string","enum":[{"name":"FiveMin","value":"FIVE_MIN"},{"name":"TenMin","value":"TEN_MIN"},{"name":"FifteenMin","value":"FIFTEEN_MIN"},{"name":"ThirtyMin","value":"THIRTY_MIN"},{"name":"OneHour","value":"ONE_HOUR"}]},"aws-native:logs:LogGroupClass":{"description":"Specifies the log group class for this log group. There are two classes:\n  +  The ``Standard`` log class supports all CWL features.\n  +  The ``Infrequent Access`` log class supports a subset of CWL features and incurs lower costs.\n  \n For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)","type":"string","enum":[{"name":"Standard","value":"STANDARD"},{"name":"InfrequentAccess","value":"INFREQUENT_ACCESS"},{"name":"Delivery","value":"DELIVERY"}]},"aws-native:logs:LogGroupTag":{"description":"The value of this key-value pair.","properties":{"key":{"type":"string"},"value":{"type":"string","description":"The value of this key-value pair."}},"type":"object","required":["key","value"]},"aws-native:logs:MetricFilterDimension":{"description":"Specifies the CW metric dimensions to publish with this metric.\n  Because dimensions are part of the unique identifier for a metric, whenever a unique dimension name/value pair is extracted from your logs, you are creating a new variation of that metric.\n For more information about publishing dimensions with metrics created by metric filters, see [Publishing dimensions with metrics from values in JSON or space-delimited log events](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html#logs-metric-filters-dimensions).\n  Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. \n To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.\n You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html).","properties":{"key":{"type":"string","description":"The name for the CW metric dimension that the metric filter creates.\n Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:)."},"value":{"type":"string","description":"The log event field that will contain the value for this dimension. This dimension will only be published for a metric if the value is found in the log event. For example, ``$.eventType`` for JSON log events, or ``$server`` for space-delimited log events."}},"type":"object","required":["key","value"]},"aws-native:logs:MetricFilterMetricTransformation":{"description":"``MetricTransformation`` is a property of the ``AWS::Logs::MetricFilter`` resource that describes how to transform log streams into a CloudWatch metric.","properties":{"defaultValue":{"type":"number","description":"(Optional) The value to emit when a filter pattern does not match a log event. This value can be null."},"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:logs:MetricFilterDimension"},"description":"The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.\n  Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. \n CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.\n You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html)."},"metricName":{"type":"string","description":"The name of the CloudWatch metric."},"metricNamespace":{"type":"string","description":"A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace)."},"metricValue":{"type":"string","description":"The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like ``Error``, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as ``$.size``."},"unit":{"$ref":"#/types/aws-native:logs:MetricFilterMetricTransformationUnit","description":"The unit to assign to the metric. If you omit this, the unit is set as ``None``."}},"type":"object","required":["metricName","metricNamespace","metricValue"]},"aws-native:logs:MetricFilterMetricTransformationUnit":{"description":"The unit to assign to the metric. If you omit this, the unit is set as ``None``.","type":"string","enum":[{"name":"Seconds","value":"Seconds"},{"name":"Microseconds","value":"Microseconds"},{"name":"Milliseconds","value":"Milliseconds"},{"name":"Bytes","value":"Bytes"},{"name":"Kilobytes","value":"Kilobytes"},{"name":"Megabytes","value":"Megabytes"},{"name":"Gigabytes","value":"Gigabytes"},{"name":"Terabytes","value":"Terabytes"},{"name":"Bits","value":"Bits"},{"name":"Kilobits","value":"Kilobits"},{"name":"Megabits","value":"Megabits"},{"name":"Gigabits","value":"Gigabits"},{"name":"Terabits","value":"Terabits"},{"name":"Percent","value":"Percent"},{"name":"Count","value":"Count"},{"name":"BytesSecond","value":"Bytes/Second"},{"name":"KilobytesSecond","value":"Kilobytes/Second"},{"name":"MegabytesSecond","value":"Megabytes/Second"},{"name":"GigabytesSecond","value":"Gigabytes/Second"},{"name":"TerabytesSecond","value":"Terabytes/Second"},{"name":"BitsSecond","value":"Bits/Second"},{"name":"KilobitsSecond","value":"Kilobits/Second"},{"name":"MegabitsSecond","value":"Megabits/Second"},{"name":"GigabitsSecond","value":"Gigabits/Second"},{"name":"TerabitsSecond","value":"Terabits/Second"},{"name":"CountSecond","value":"Count/Second"},{"name":"None","value":"None"}]},"aws-native:logs:QueryDefinitionQueryLanguage":{"description":"Query language of the query string. Possible values are CWLI, SQL, PPL, with CWLI being the default.","type":"string","enum":[{"name":"Cwli","value":"CWLI"},{"name":"Sql","value":"SQL"},{"name":"Ppl","value":"PPL"}]},"aws-native:logs:ResourceConfigProperties":{"description":"OpenSearchResourceConfig for the given Integration","properties":{"openSearchResourceConfig":{"$ref":"#/types/aws-native:logs:IntegrationOpenSearchResourceConfig","description":"This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service."}},"type":"object"},"aws-native:logs:ScheduledQueryDestinationConfiguration":{"properties":{"s3Configuration":{"$ref":"#/types/aws-native:logs:ScheduledQueryS3Configuration"}},"type":"object"},"aws-native:logs:ScheduledQueryLastExecutionStatus":{"type":"string","enum":[{"name":"InvalidQuery","value":"InvalidQuery"},{"name":"Complete","value":"Complete"},{"name":"Failed","value":"Failed"},{"name":"Timeout","value":"Timeout"}]},"aws-native:logs:ScheduledQueryS3Configuration":{"properties":{"destinationIdentifier":{"type":"string"},"roleArn":{"type":"string"}},"type":"object","required":["destinationIdentifier","roleArn"]},"aws-native:logs:ScheduledQueryState":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:logs:SubscriptionFilterDistribution":{"description":"The method used to distribute log data to the destination, which can be either random or grouped by log stream.","type":"string","enum":[{"name":"Random","value":"Random"},{"name":"ByLogStream","value":"ByLogStream"}]},"aws-native:logs:TagsItemProperties":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:logs:TransformerAddKeyEntry":{"properties":{"key":{"type":"string","description":"The key of the new entry to be added to the log event"},"overwriteIfExists":{"type":"boolean","description":"Specifies whether to overwrite the value if the key already exists in the log event. If you omit this, the default is `false` ."},"value":{"type":"string","description":"The value of the new entry to be added to the log event"}},"type":"object","required":["key","value"]},"aws-native:logs:TransformerCopyValueEntry":{"properties":{"overwriteIfExists":{"type":"boolean"},"source":{"type":"string"},"target":{"type":"string"}},"type":"object","required":["source","target"]},"aws-native:logs:TransformerEventSource":{"type":"string","enum":[{"name":"CloudTrail","value":"CloudTrail"},{"name":"Route53Resolver","value":"Route53Resolver"},{"name":"VpcFlow","value":"VPCFlow"},{"name":"EksAudit","value":"EKSAudit"},{"name":"Awswaf","value":"AWSWAF"}]},"aws-native:logs:TransformerMoveKeyEntry":{"properties":{"overwriteIfExists":{"type":"boolean"},"source":{"type":"string"},"target":{"type":"string"}},"type":"object","required":["source","target"]},"aws-native:logs:TransformerOcsfVersion":{"type":"string","enum":[{"name":"V11","value":"V1.1"},{"name":"V15","value":"V1.5"}]},"aws-native:logs:TransformerParseCloudfront":{"properties":{"source":{"type":"string","description":"Omit this parameter and the whole log message will be processed by this processor. No other value than `@message` is allowed for `source` ."}},"type":"object"},"aws-native:logs:TransformerParsePostgres":{"properties":{"source":{"type":"string","description":"Omit this parameter and the whole log message will be processed by this processor. No other value than `@message` is allowed for `source` ."}},"type":"object"},"aws-native:logs:TransformerParseRoute53":{"properties":{"source":{"type":"string","description":"Omit this parameter and the whole log message will be processed by this processor. No other value than `@message` is allowed for `source` ."}},"type":"object"},"aws-native:logs:TransformerParseToOcsf":{"properties":{"eventSource":{"$ref":"#/types/aws-native:logs:TransformerEventSource","description":"Specify the service or process that produces the log events that will be converted with this processor."},"mappingVersion":{"type":"string","description":"The version of the OCSF mapping to use for parsing log data."},"ocsfVersion":{"$ref":"#/types/aws-native:logs:TransformerOcsfVersion","description":"Specify which version of the OCSF schema to use for the transformed log events."},"source":{"type":"string","description":"The path to the field in the log event that you want to parse. If you omit this value, the whole log message is parsed."}},"type":"object","required":["eventSource","ocsfVersion"]},"aws-native:logs:TransformerParseVpc":{"properties":{"source":{"type":"string","description":"Omit this parameter and the whole log message will be processed by this processor. No other value than `@message` is allowed for `source` ."}},"type":"object"},"aws-native:logs:TransformerParseWaf":{"properties":{"source":{"type":"string","description":"Omit this parameter and the whole log message will be processed by this processor. No other value than `@message` is allowed for `source` ."}},"type":"object"},"aws-native:logs:TransformerProcessor":{"description":"Individual processor configuration","properties":{"addKeys":{"$ref":"#/types/aws-native:logs:TransformerProcessorAddKeysProperties","description":"Use this parameter to include the [addKeys](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-addKeys) processor in your transformer."},"copyValue":{"$ref":"#/types/aws-native:logs:TransformerProcessorCopyValueProperties","description":"Use this parameter to include the [copyValue](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-copyValue) processor in your transformer."},"csv":{"$ref":"#/types/aws-native:logs:TransformerProcessorCsvProperties","description":"Use this parameter to include the [CSV](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-CSV) processor in your transformer."},"dateTimeConverter":{"$ref":"#/types/aws-native:logs:TransformerProcessorDateTimeConverterProperties","description":"Use this parameter to include the [datetimeConverter](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-datetimeConverter) processor in your transformer."},"deleteKeys":{"$ref":"#/types/aws-native:logs:TransformerProcessorDeleteKeysProperties","description":"Use this parameter to include the [deleteKeys](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-deleteKeys) processor in your transformer."},"grok":{"$ref":"#/types/aws-native:logs:TransformerProcessorGrokProperties","description":"Use this parameter to include the [grok](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-grok) processor in your transformer."},"listToMap":{"$ref":"#/types/aws-native:logs:TransformerProcessorListToMapProperties","description":"Use this parameter to include the [listToMap](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-listToMap) processor in your transformer."},"lowerCaseString":{"$ref":"#/types/aws-native:logs:TransformerProcessorLowerCaseStringProperties","description":"Use this parameter to include the [lowerCaseString](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-lowerCaseString) processor in your transformer."},"moveKeys":{"$ref":"#/types/aws-native:logs:TransformerProcessorMoveKeysProperties","description":"Use this parameter to include the [moveKeys](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-moveKeys) processor in your transformer."},"parseCloudfront":{"$ref":"#/types/aws-native:logs:TransformerParseCloudfront","description":"Use this parameter to include the [parseCloudfront](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-parseCloudfront) processor in your transformer.\n\nIf you use this processor, it must be the first processor in your transformer."},"parseJson":{"$ref":"#/types/aws-native:logs:TransformerProcessorParseJsonProperties","description":"Use this parameter to include the [parseJSON](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-parseJSON) processor in your transformer."},"parseKeyValue":{"$ref":"#/types/aws-native:logs:TransformerProcessorParseKeyValueProperties","description":"Use this parameter to include the [parseKeyValue](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-parseKeyValue) processor in your transformer."},"parsePostgres":{"$ref":"#/types/aws-native:logs:TransformerParsePostgres","description":"Use this parameter to include the [parsePostGres](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-parsePostGres) processor in your transformer.\n\nIf you use this processor, it must be the first processor in your transformer."},"parseRoute53":{"$ref":"#/types/aws-native:logs:TransformerParseRoute53","description":"Use this parameter to include the [parseRoute53](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-parseRoute53) processor in your transformer.\n\nIf you use this processor, it must be the first processor in your transformer."},"parseToOcsf":{"$ref":"#/types/aws-native:logs:TransformerParseToOcsf","description":"Use this parameter to convert logs into Open Cybersecurity Schema (OCSF) format."},"parseVpc":{"$ref":"#/types/aws-native:logs:TransformerParseVpc","description":"Use this parameter to include the [parseVPC](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-parseVPC) processor in your transformer.\n\nIf you use this processor, it must be the first processor in your transformer."},"parseWaf":{"$ref":"#/types/aws-native:logs:TransformerParseWaf","description":"Use this parameter to include the [parseWAF](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-parseWAF) processor in your transformer.\n\nIf you use this processor, it must be the first processor in your transformer."},"renameKeys":{"$ref":"#/types/aws-native:logs:TransformerProcessorRenameKeysProperties","description":"Use this parameter to include the [renameKeys](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-renameKeys) processor in your transformer."},"splitString":{"$ref":"#/types/aws-native:logs:TransformerProcessorSplitStringProperties","description":"Use this parameter to include the [splitString](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-splitString) processor in your transformer."},"substituteString":{"$ref":"#/types/aws-native:logs:TransformerProcessorSubstituteStringProperties","description":"Use this parameter to include the [substituteString](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-substituteString) processor in your transformer."},"trimString":{"$ref":"#/types/aws-native:logs:TransformerProcessorTrimStringProperties","description":"Use this parameter to include the [trimString](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-trimString) processor in your transformer."},"typeConverter":{"$ref":"#/types/aws-native:logs:TransformerProcessorTypeConverterProperties","description":"Use this parameter to include the [typeConverter](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-typeConverter) processor in your transformer."},"upperCaseString":{"$ref":"#/types/aws-native:logs:TransformerProcessorUpperCaseStringProperties","description":"Use this parameter to include the [upperCaseString](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-upperCaseString) processor in your transformer."}},"type":"object"},"aws-native:logs:TransformerProcessorAddKeysProperties":{"description":"Use this parameter to include the [addKeys](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-addKeys) processor in your transformer.","properties":{"entries":{"type":"array","items":{"$ref":"#/types/aws-native:logs:TransformerAddKeyEntry"}}},"type":"object","required":["entries"]},"aws-native:logs:TransformerProcessorCopyValueProperties":{"description":"Use this parameter to include the [copyValue](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-copyValue) processor in your transformer.","properties":{"entries":{"type":"array","items":{"$ref":"#/types/aws-native:logs:TransformerCopyValueEntry"}}},"type":"object","required":["entries"]},"aws-native:logs:TransformerProcessorCsvProperties":{"description":"Use this parameter to include the [CSV](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-CSV) processor in your transformer.","properties":{"columns":{"type":"array","items":{"type":"string"}},"delimiter":{"type":"string"},"quoteCharacter":{"type":"string"},"source":{"type":"string"}},"type":"object"},"aws-native:logs:TransformerProcessorDateTimeConverterProperties":{"description":"Use this parameter to include the [datetimeConverter](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-datetimeConverter) processor in your transformer.","properties":{"locale":{"type":"string"},"matchPatterns":{"type":"array","items":{"type":"string"}},"source":{"type":"string"},"sourceTimezone":{"type":"string"},"target":{"type":"string"},"targetFormat":{"type":"string"},"targetTimezone":{"type":"string"}},"type":"object","required":["matchPatterns","source","target"]},"aws-native:logs:TransformerProcessorDeleteKeysProperties":{"description":"Use this parameter to include the [deleteKeys](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-deleteKeys) processor in your transformer.","properties":{"withKeys":{"type":"array","items":{"type":"string"}}},"type":"object","required":["withKeys"]},"aws-native:logs:TransformerProcessorGrokProperties":{"description":"Use this parameter to include the [grok](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-grok) processor in your transformer.","properties":{"match":{"type":"string"},"source":{"type":"string"}},"type":"object","required":["match"]},"aws-native:logs:TransformerProcessorListToMapProperties":{"description":"Use this parameter to include the [listToMap](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-listToMap) processor in your transformer.","properties":{"flatten":{"type":"boolean"},"flattenedElement":{"$ref":"#/types/aws-native:logs:TransformerProcessorListToMapPropertiesFlattenedElement"},"key":{"type":"string"},"source":{"type":"string"},"target":{"type":"string"},"valueKey":{"type":"string"}},"type":"object","required":["key","source"]},"aws-native:logs:TransformerProcessorListToMapPropertiesFlattenedElement":{"type":"string","enum":[{"name":"First","value":"first"},{"name":"Last","value":"last"}]},"aws-native:logs:TransformerProcessorLowerCaseStringProperties":{"description":"Use this parameter to include the [lowerCaseString](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-lowerCaseString) processor in your transformer.","properties":{"withKeys":{"type":"array","items":{"type":"string"}}},"type":"object","required":["withKeys"]},"aws-native:logs:TransformerProcessorMoveKeysProperties":{"description":"Use this parameter to include the [moveKeys](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-moveKeys) processor in your transformer.","properties":{"entries":{"type":"array","items":{"$ref":"#/types/aws-native:logs:TransformerMoveKeyEntry"}}},"type":"object","required":["entries"]},"aws-native:logs:TransformerProcessorParseJsonProperties":{"description":"Use this parameter to include the [parseJSON](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-parseJSON) processor in your transformer.","properties":{"destination":{"type":"string"},"source":{"type":"string"}},"type":"object"},"aws-native:logs:TransformerProcessorParseKeyValueProperties":{"description":"Use this parameter to include the [parseKeyValue](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-parseKeyValue) processor in your transformer.","properties":{"destination":{"type":"string"},"fieldDelimiter":{"type":"string"},"keyPrefix":{"type":"string"},"keyValueDelimiter":{"type":"string"},"nonMatchValue":{"type":"string"},"overwriteIfExists":{"type":"boolean"},"source":{"type":"string"}},"type":"object"},"aws-native:logs:TransformerProcessorRenameKeysProperties":{"description":"Use this parameter to include the [renameKeys](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-renameKeys) processor in your transformer.","properties":{"entries":{"type":"array","items":{"$ref":"#/types/aws-native:logs:TransformerRenameKeyEntry"}}},"type":"object","required":["entries"]},"aws-native:logs:TransformerProcessorSplitStringProperties":{"description":"Use this parameter to include the [splitString](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-splitString) processor in your transformer.","properties":{"entries":{"type":"array","items":{"$ref":"#/types/aws-native:logs:TransformerSplitStringEntry"}}},"type":"object","required":["entries"]},"aws-native:logs:TransformerProcessorSubstituteStringProperties":{"description":"Use this parameter to include the [substituteString](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-substituteString) processor in your transformer.","properties":{"entries":{"type":"array","items":{"$ref":"#/types/aws-native:logs:TransformerSubstituteStringEntry"}}},"type":"object","required":["entries"]},"aws-native:logs:TransformerProcessorTrimStringProperties":{"description":"Use this parameter to include the [trimString](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-trimString) processor in your transformer.","properties":{"withKeys":{"type":"array","items":{"type":"string"}}},"type":"object","required":["withKeys"]},"aws-native:logs:TransformerProcessorTypeConverterProperties":{"description":"Use this parameter to include the [typeConverter](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-typeConverter) processor in your transformer.","properties":{"entries":{"type":"array","items":{"$ref":"#/types/aws-native:logs:TransformerTypeConverterEntry"}}},"type":"object","required":["entries"]},"aws-native:logs:TransformerProcessorUpperCaseStringProperties":{"description":"Use this parameter to include the [upperCaseString](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation-Processors.html#CloudWatch-Logs-Transformation-upperCaseString) processor in your transformer.","properties":{"withKeys":{"type":"array","items":{"type":"string"}}},"type":"object","required":["withKeys"]},"aws-native:logs:TransformerRenameKeyEntry":{"properties":{"key":{"type":"string"},"overwriteIfExists":{"type":"boolean"},"renameTo":{"type":"string"}},"type":"object","required":["key","renameTo"]},"aws-native:logs:TransformerSplitStringEntry":{"properties":{"delimiter":{"type":"string"},"source":{"type":"string"}},"type":"object","required":["delimiter","source"]},"aws-native:logs:TransformerSubstituteStringEntry":{"properties":{"from":{"type":"string"},"source":{"type":"string"},"to":{"type":"string"}},"type":"object","required":["from","source","to"]},"aws-native:logs:TransformerTypeConverterEntry":{"properties":{"key":{"type":"string"},"type":{"$ref":"#/types/aws-native:logs:TransformerTypeConverterEntryType"}},"type":"object","required":["key","type"]},"aws-native:logs:TransformerTypeConverterEntryType":{"type":"string","enum":[{"name":"Boolean","value":"boolean"},{"name":"Integer","value":"integer"},{"name":"Double","value":"double"},{"name":"String","value":"string"}]},"aws-native:m2:ApplicationDefinition0Properties":{"properties":{"s3Location":{"type":"string"}},"type":"object","required":["s3Location"]},"aws-native:m2:ApplicationDefinition1Properties":{"properties":{"content":{"type":"string"}},"type":"object","required":["content"]},"aws-native:m2:ApplicationEngineType":{"type":"string","enum":[{"name":"Microfocus","value":"microfocus"},{"name":"Bluage","value":"bluage"}]},"aws-native:m2:EnvironmentEngineType":{"description":"The target platform for the environment.","type":"string","enum":[{"name":"Microfocus","value":"microfocus"},{"name":"Bluage","value":"bluage"}]},"aws-native:m2:EnvironmentHighAvailabilityConfig":{"description":"Defines the details of a high availability configuration.","properties":{"desiredCapacity":{"type":"integer","description":"The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100."}},"type":"object","required":["desiredCapacity"]},"aws-native:m2:EnvironmentNetworkType":{"type":"string","enum":[{"name":"Ipv4","value":"ipv4"},{"name":"Dual","value":"dual"}]},"aws-native:m2:EnvironmentStorageConfiguration":{"description":"Defines the storage configuration for an environment.","type":"object"},"aws-native:macie:AllowListCriteria":{"description":"The regex or s3 object to use for the AllowList.","type":"object"},"aws-native:macie:AllowListStatus":{"description":"The status for the AllowList","type":"string","enum":[{"name":"Ok","value":"OK"},{"name":"S3ObjectNotFound","value":"S3_OBJECT_NOT_FOUND"},{"name":"S3UserAccessDenied","value":"S3_USER_ACCESS_DENIED"},{"name":"S3ObjectAccessDenied","value":"S3_OBJECT_ACCESS_DENIED"},{"name":"S3Throttled","value":"S3_THROTTLED"},{"name":"S3ObjectOversize","value":"S3_OBJECT_OVERSIZE"},{"name":"S3ObjectEmpty","value":"S3_OBJECT_EMPTY"},{"name":"UnknownError","value":"UNKNOWN_ERROR"}]},"aws-native:macie:AllowListTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:macie:CustomDataIdentifierTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:macie:FindingsFilterCriterionAdditionalProperties":{"properties":{"eq":{"type":"array","items":{"type":"string"},"description":"The value for the specified property matches (equals) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values."},"gt":{"type":"integer","description":"The value for the specified property is greater than the specified value."},"gte":{"type":"integer","description":"The value for the specified property is greater than or equal to the specified value."},"lt":{"type":"integer","description":"The value for the specified property is less than the specified value."},"lte":{"type":"integer","description":"The value for the specified property is less than or equal to the specified value."},"neq":{"type":"array","items":{"type":"string"},"description":"The value for the specified property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values."}},"type":"object"},"aws-native:macie:FindingsFilterFindingCriteria":{"properties":{"criterion":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:macie:FindingsFilterCriterionAdditionalProperties"},"description":"Specifies a condition that defines the property, operator, and one or more values to use to filter the results."}},"type":"object"},"aws-native:macie:FindingsFilterFindingFilterAction":{"type":"string","enum":[{"name":"Archive","value":"ARCHIVE"},{"name":"Noop","value":"NOOP"}]},"aws-native:macie:FindingsFilterTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The tag's key."},"value":{"type":"string","description":"The tag's value."}},"type":"object","required":["key","value"]},"aws-native:macie:SessionAutomatedDiscoveryStatus":{"description":"The status of automated sensitive data discovery for the Macie session.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:macie:SessionFindingPublishingFrequency":{"description":"A enumeration value that specifies how frequently finding updates are published.","type":"string","enum":[{"name":"FifteenMinutes","value":"FIFTEEN_MINUTES"},{"name":"OneHour","value":"ONE_HOUR"},{"name":"SixHours","value":"SIX_HOURS"}]},"aws-native:macie:SessionStatus":{"description":"A enumeration value that specifies the status of the Macie Session.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Paused","value":"PAUSED"}]},"aws-native:mediaconnect:BridgeEgressGatewayBridge":{"properties":{"maxBitrate":{"type":"integer","description":"The maximum expected bitrate of the egress bridge."}},"type":"object","required":["maxBitrate"]},"aws-native:mediaconnect:BridgeFailoverConfig":{"description":"The settings for source failover.","properties":{"failoverMode":{"$ref":"#/types/aws-native:mediaconnect:BridgeFailoverModeEnum","description":"The type of failover you choose for this flow. FAILOVER allows switching between different streams."},"sourcePriority":{"$ref":"#/types/aws-native:mediaconnect:BridgeSourcePriority","description":"The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams."},"state":{"$ref":"#/types/aws-native:mediaconnect:BridgeFailoverConfigStateEnum","description":"The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources."}},"type":"object","required":["failoverMode"]},"aws-native:mediaconnect:BridgeFailoverConfigStateEnum":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:BridgeFailoverModeEnum":{"type":"string","enum":[{"name":"Failover","value":"FAILOVER"}]},"aws-native:mediaconnect:BridgeFlowSource":{"description":"The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.","properties":{"flowArn":{"type":"string","description":"The ARN of the cloud flow used as a source of this bridge."},"flowVpcInterfaceAttachment":{"$ref":"#/types/aws-native:mediaconnect:BridgeVpcInterfaceAttachment","description":"The name of the VPC interface attachment to use for this source."},"name":{"type":"string","description":"The name of the flow source."}},"type":"object","required":["flowArn","name"]},"aws-native:mediaconnect:BridgeIngressGatewayBridge":{"properties":{"maxBitrate":{"type":"integer","description":"The maximum expected bitrate of the ingress bridge."},"maxOutputs":{"type":"integer","description":"The maximum number of outputs on the ingress bridge."}},"type":"object","required":["maxBitrate","maxOutputs"]},"aws-native:mediaconnect:BridgeMulticastSourceSettings":{"description":"The settings related to the multicast source.","properties":{"multicastSourceIp":{"type":"string","description":"The IP address of the source for source-specific multicast (SSM)."}},"type":"object"},"aws-native:mediaconnect:BridgeNetworkOutput":{"description":"The output of the bridge. A network output is delivered to your premises.","properties":{"ipAddress":{"type":"string","description":"The network output IP Address."},"name":{"type":"string","description":"The network output name."},"networkName":{"type":"string","description":"The network output's gateway network name."},"port":{"type":"integer","description":"The network output port."},"protocol":{"$ref":"#/types/aws-native:mediaconnect:BridgeProtocolEnum","description":"The network output protocol."},"ttl":{"type":"integer","description":"The network output TTL."}},"type":"object","required":["ipAddress","name","networkName","port","protocol","ttl"]},"aws-native:mediaconnect:BridgeNetworkSource":{"description":"The source of the bridge. A network source originates at your premises.","properties":{"multicastIp":{"type":"string","description":"The network source multicast IP."},"multicastSourceSettings":{"$ref":"#/types/aws-native:mediaconnect:BridgeMulticastSourceSettings","description":"The settings related to the multicast source."},"name":{"type":"string","description":"The name of the network source."},"networkName":{"type":"string","description":"The network source's gateway network name."},"port":{"type":"integer","description":"The network source port."},"protocol":{"$ref":"#/types/aws-native:mediaconnect:BridgeProtocolEnum","description":"The network source protocol."}},"type":"object","required":["multicastIp","name","networkName","port","protocol"]},"aws-native:mediaconnect:BridgeOutput":{"description":"The output of the bridge.","properties":{"networkOutput":{"$ref":"#/types/aws-native:mediaconnect:BridgeNetworkOutput","description":"The output of the bridge. A network output is delivered to your premises."}},"type":"object"},"aws-native:mediaconnect:BridgeOutputResourceBridgeNetworkOutput":{"description":"The output of the bridge. A network output is delivered to your premises.","properties":{"ipAddress":{"type":"string","description":"The network output IP Address."},"networkName":{"type":"string","description":"The network output's gateway network name."},"port":{"type":"integer","description":"The network output port."},"protocol":{"$ref":"#/types/aws-native:mediaconnect:BridgeOutputResourceBridgeNetworkOutputProtocol","description":"The network output protocol."},"ttl":{"type":"integer","description":"The network output TTL."}},"type":"object","required":["ipAddress","networkName","port","protocol","ttl"]},"aws-native:mediaconnect:BridgeOutputResourceBridgeNetworkOutputProtocol":{"description":"The network output protocol.","type":"string","enum":[{"name":"RtpFec","value":"rtp-fec"},{"name":"Rtp","value":"rtp"},{"name":"Udp","value":"udp"}]},"aws-native:mediaconnect:BridgeProtocolEnum":{"type":"string","enum":[{"name":"RtpFec","value":"rtp-fec"},{"name":"Rtp","value":"rtp"},{"name":"Udp","value":"udp"}]},"aws-native:mediaconnect:BridgeSource":{"description":"The bridge's source.","properties":{"flowSource":{"$ref":"#/types/aws-native:mediaconnect:BridgeFlowSource","description":"The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow."},"networkSource":{"$ref":"#/types/aws-native:mediaconnect:BridgeNetworkSource","description":"The source of the bridge. A network source originates at your premises."}},"type":"object"},"aws-native:mediaconnect:BridgeSourceBridgeFlowSource":{"description":"The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.","properties":{"flowArn":{"type":"string","description":"The ARN of the cloud flow used as a source of this bridge."},"flowVpcInterfaceAttachment":{"$ref":"#/types/aws-native:mediaconnect:BridgeSourceVpcInterfaceAttachment","description":"The name of the VPC interface attachment to use for this source."}},"type":"object","required":["flowArn"]},"aws-native:mediaconnect:BridgeSourceBridgeNetworkSource":{"description":"The source of the bridge. A network source originates at your premises.","properties":{"multicastIp":{"type":"string","description":"The network source multicast IP."},"multicastSourceSettings":{"$ref":"#/types/aws-native:mediaconnect:BridgeSourceMulticastSourceSettings","description":"The settings related to the multicast source."},"networkName":{"type":"string","description":"The network source's gateway network name."},"port":{"type":"integer","description":"The network source port."},"protocol":{"$ref":"#/types/aws-native:mediaconnect:BridgeSourceProtocolEnum","description":"The network source protocol."}},"type":"object","required":["multicastIp","networkName","port","protocol"]},"aws-native:mediaconnect:BridgeSourceMulticastSourceSettings":{"description":"The settings related to the multicast source.","properties":{"multicastSourceIp":{"type":"string","description":"The IP address of the source for source-specific multicast (SSM)."}},"type":"object"},"aws-native:mediaconnect:BridgeSourcePriority":{"description":"The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.","properties":{"primarySource":{"type":"string","description":"The name of the source you choose as the primary source for this flow."}},"type":"object"},"aws-native:mediaconnect:BridgeSourceProtocolEnum":{"type":"string","enum":[{"name":"RtpFec","value":"rtp-fec"},{"name":"Rtp","value":"rtp"},{"name":"Udp","value":"udp"}]},"aws-native:mediaconnect:BridgeSourceVpcInterfaceAttachment":{"description":"The settings for attaching a VPC interface to an resource.","properties":{"vpcInterfaceName":{"type":"string","description":"The name of the VPC interface to use for this resource."}},"type":"object"},"aws-native:mediaconnect:BridgeStateEnum":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Standby","value":"STANDBY"},{"name":"Starting","value":"STARTING"},{"name":"Deploying","value":"DEPLOYING"},{"name":"Active","value":"ACTIVE"},{"name":"Stopping","value":"STOPPING"},{"name":"Deleting","value":"DELETING"},{"name":"Deleted","value":"DELETED"},{"name":"StartFailed","value":"START_FAILED"},{"name":"StartPending","value":"START_PENDING"},{"name":"Updating","value":"UPDATING"}]},"aws-native:mediaconnect:BridgeVpcInterfaceAttachment":{"description":"The settings for attaching a VPC interface to an resource.","properties":{"vpcInterfaceName":{"type":"string","description":"The name of the VPC interface to use for this resource."}},"type":"object"},"aws-native:mediaconnect:FlowAudioMonitoringSetting":{"description":"Specifies the configuration for audio stream metrics monitoring.","properties":{"silentAudio":{"$ref":"#/types/aws-native:mediaconnect:FlowSilentAudio","description":"Detects periods of silence."}},"type":"object"},"aws-native:mediaconnect:FlowAutomaticEncryptionKeyConfiguration":{"description":"Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.","type":"object"},"aws-native:mediaconnect:FlowBlackFrames":{"description":"Configures settings for the BlackFrames metric.","properties":{"state":{"$ref":"#/types/aws-native:mediaconnect:FlowBlackFramesState","description":"Indicates whether the BlackFrames metric is enabled or disabled."},"thresholdSeconds":{"type":"integer","description":"Specifies the number of consecutive seconds of black frames that triggers an event or alert."}},"type":"object"},"aws-native:mediaconnect:FlowBlackFramesState":{"description":"Indicates whether the BlackFrames metric is enabled or disabled.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:FlowEncryption":{"description":"Information about the encryption of the flow.","properties":{"algorithm":{"$ref":"#/types/aws-native:mediaconnect:FlowEncryptionAlgorithm","description":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)."},"constantInitializationVector":{"type":"string","description":"A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption."},"deviceId":{"type":"string","description":"The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"keyType":{"$ref":"#/types/aws-native:mediaconnect:FlowEncryptionKeyType","description":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."},"region":{"type":"string","description":"The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"resourceId":{"type":"string","description":"An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"roleArn":{"type":"string","description":"The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)."},"secretArn":{"type":"string","description":" The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption."},"url":{"type":"string","description":"The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption."}},"type":"object","required":["roleArn"]},"aws-native:mediaconnect:FlowEncryptionAlgorithm":{"description":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).","type":"string","enum":[{"name":"Aes128","value":"aes128"},{"name":"Aes192","value":"aes192"},{"name":"Aes256","value":"aes256"}]},"aws-native:mediaconnect:FlowEncryptionKeyType":{"description":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).","type":"string","enum":[{"name":"Speke","value":"speke"},{"name":"StaticKey","value":"static-key"},{"name":"SrtPassword","value":"srt-password"}]},"aws-native:mediaconnect:FlowEntitlementEncryption":{"description":"Information about the encryption of the flow.","properties":{"algorithm":{"$ref":"#/types/aws-native:mediaconnect:FlowEntitlementEncryptionAlgorithm","description":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)."},"constantInitializationVector":{"type":"string","description":"A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption."},"deviceId":{"type":"string","description":"The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"keyType":{"$ref":"#/types/aws-native:mediaconnect:FlowEntitlementEncryptionKeyType","description":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."},"region":{"type":"string","description":"The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"resourceId":{"type":"string","description":"An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"roleArn":{"type":"string","description":"The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)."},"secretArn":{"type":"string","description":" The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption."},"url":{"type":"string","description":"The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption."}},"type":"object","required":["algorithm","roleArn"]},"aws-native:mediaconnect:FlowEntitlementEncryptionAlgorithm":{"description":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).","type":"string","enum":[{"name":"Aes128","value":"aes128"},{"name":"Aes192","value":"aes192"},{"name":"Aes256","value":"aes256"}]},"aws-native:mediaconnect:FlowEntitlementEncryptionKeyType":{"description":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).","type":"string","enum":[{"name":"Speke","value":"speke"},{"name":"StaticKey","value":"static-key"}]},"aws-native:mediaconnect:FlowEntitlementEntitlementStatus":{"description":" An indication of whether the entitlement is enabled.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:FlowFailoverConfig":{"description":"The settings for source failover","properties":{"failoverMode":{"$ref":"#/types/aws-native:mediaconnect:FlowFailoverConfigFailoverMode","description":"The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams."},"recoveryWindow":{"type":"integer","description":"Search window time to look for dash-7 packets"},"sourcePriority":{"$ref":"#/types/aws-native:mediaconnect:FlowFailoverConfigSourcePriorityProperties","description":"The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams."},"state":{"$ref":"#/types/aws-native:mediaconnect:FlowFailoverConfigState","description":"The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources."}},"type":"object"},"aws-native:mediaconnect:FlowFailoverConfigFailoverMode":{"description":"The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.","type":"string","enum":[{"name":"Merge","value":"MERGE"},{"name":"Failover","value":"FAILOVER"}]},"aws-native:mediaconnect:FlowFailoverConfigSourcePriorityProperties":{"description":"The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.","properties":{"primarySource":{"type":"string","description":"The name of the source you choose as the primary source for this flow."}},"type":"object","required":["primarySource"]},"aws-native:mediaconnect:FlowFailoverConfigState":{"description":"The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:FlowFmtp":{"description":"A set of parameters that define the media stream.","properties":{"channelOrder":{"type":"string","description":"The format of the audio channel."},"colorimetry":{"$ref":"#/types/aws-native:mediaconnect:FlowFmtpColorimetry","description":"The format used for the representation of color."},"exactFramerate":{"type":"string","description":"The frame rate for the video stream, in frames/second. For example: 60000/1001."},"par":{"type":"string","description":"The pixel aspect ratio (PAR) of the video."},"range":{"$ref":"#/types/aws-native:mediaconnect:FlowFmtpRange","description":"The encoding range of the video."},"scanMode":{"$ref":"#/types/aws-native:mediaconnect:FlowFmtpScanMode","description":"The type of compression that was used to smooth the video's appearance."},"tcs":{"$ref":"#/types/aws-native:mediaconnect:FlowFmtpTcs","description":"The transfer characteristic system (TCS) that is used in the video."}},"type":"object"},"aws-native:mediaconnect:FlowFmtpColorimetry":{"description":"The format used for the representation of color.","type":"string","enum":[{"name":"Bt601","value":"BT601"},{"name":"Bt709","value":"BT709"},{"name":"Bt2020","value":"BT2020"},{"name":"Bt2100","value":"BT2100"},{"name":"St20651","value":"ST2065-1"},{"name":"St20653","value":"ST2065-3"},{"name":"Xyz","value":"XYZ"}]},"aws-native:mediaconnect:FlowFmtpRange":{"description":"The encoding range of the video.","type":"string","enum":[{"name":"Narrow","value":"NARROW"},{"name":"Full","value":"FULL"},{"name":"Fullprotect","value":"FULLPROTECT"}]},"aws-native:mediaconnect:FlowFmtpScanMode":{"description":"The type of compression that was used to smooth the video's appearance.","type":"string","enum":[{"name":"Progressive","value":"progressive"},{"name":"Interlace","value":"interlace"},{"name":"ProgressiveSegmentedFrame","value":"progressive-segmented-frame"}]},"aws-native:mediaconnect:FlowFmtpTcs":{"description":"The transfer characteristic system (TCS) that is used in the video.","type":"string","enum":[{"name":"Sdr","value":"SDR"},{"name":"Pq","value":"PQ"},{"name":"Hlg","value":"HLG"},{"name":"Linear","value":"LINEAR"},{"name":"Bt2100linpq","value":"BT2100LINPQ"},{"name":"Bt2100linhlg","value":"BT2100LINHLG"},{"name":"St20651","value":"ST2065-1"},{"name":"St4281","value":"ST428-1"},{"name":"Density","value":"DENSITY"}]},"aws-native:mediaconnect:FlowFrozenFrames":{"description":"Configures settings for the FrozenFrames metric.","properties":{"state":{"$ref":"#/types/aws-native:mediaconnect:FlowFrozenFramesState","description":"Indicates whether the FrozenFrames metric is enabled or disabled."},"thresholdSeconds":{"type":"integer","description":"Specifies the number of consecutive seconds of a static image that triggers an event or alert."}},"type":"object"},"aws-native:mediaconnect:FlowFrozenFramesState":{"description":"Indicates whether the FrozenFrames metric is enabled or disabled.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:FlowGatewayBridgeSource":{"description":"The source configuration for cloud flows receiving a stream from a bridge.","properties":{"bridgeArn":{"type":"string","description":"The ARN of the bridge feeding this flow."},"vpcInterfaceAttachment":{"$ref":"#/types/aws-native:mediaconnect:FlowVpcInterfaceAttachment","description":"The name of the VPC interface attachment to use for this bridge source."}},"type":"object","required":["bridgeArn"]},"aws-native:mediaconnect:FlowInputConfiguration":{"description":"The transport parameters associated with an incoming media stream.","properties":{"inputPort":{"type":"integer","description":"The port that the flow listens on for an incoming media stream."},"interface":{"$ref":"#/types/aws-native:mediaconnect:FlowInterface","description":"The VPC interface where the media stream comes in from."}},"type":"object","required":["inputPort","interface"]},"aws-native:mediaconnect:FlowInterface":{"description":"The VPC interface that you want to use for the media stream associated with the output.","properties":{"name":{"type":"string","description":"The name of the VPC interface that you want to use for the media stream associated with the output."}},"type":"object","required":["name"]},"aws-native:mediaconnect:FlowMaintenance":{"description":"The maintenance setting of a flow.","properties":{"maintenanceDay":{"$ref":"#/types/aws-native:mediaconnect:FlowMaintenanceMaintenanceDay","description":"A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday."},"maintenanceStartHour":{"type":"string","description":"UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00."}},"type":"object","required":["maintenanceDay","maintenanceStartHour"]},"aws-native:mediaconnect:FlowMaintenanceMaintenanceDay":{"description":"A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.","type":"string","enum":[{"name":"Monday","value":"Monday"},{"name":"Tuesday","value":"Tuesday"},{"name":"Wednesday","value":"Wednesday"},{"name":"Thursday","value":"Thursday"},{"name":"Friday","value":"Friday"},{"name":"Saturday","value":"Saturday"},{"name":"Sunday","value":"Sunday"}]},"aws-native:mediaconnect:FlowMediaStream":{"description":"A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.","properties":{"attributes":{"$ref":"#/types/aws-native:mediaconnect:FlowMediaStreamAttributes","description":"Attributes that are related to the media stream."},"clockRate":{"type":"integer","description":"The sample rate for the stream. This value in measured in kHz."},"description":{"type":"string","description":"A description that can help you quickly identify what your media stream is used for."},"fmt":{"type":"integer","description":"The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver."},"mediaStreamId":{"type":"integer","description":"A unique identifier for the media stream."},"mediaStreamName":{"type":"string","description":"A name that helps you distinguish one media stream from another."},"mediaStreamType":{"$ref":"#/types/aws-native:mediaconnect:FlowMediaStreamMediaStreamType","description":"The type of media stream."},"videoFormat":{"$ref":"#/types/aws-native:mediaconnect:FlowMediaStreamVideoFormat","description":"The resolution of the video."}},"type":"object","required":["mediaStreamId","mediaStreamName","mediaStreamType"]},"aws-native:mediaconnect:FlowMediaStreamAttributes":{"description":"Attributes that are related to the media stream.","properties":{"fmtp":{"$ref":"#/types/aws-native:mediaconnect:FlowFmtp","description":"A set of parameters that define the media stream."},"lang":{"type":"string","description":"The audio language, in a format that is recognized by the receiver."}},"type":"object"},"aws-native:mediaconnect:FlowMediaStreamMediaStreamType":{"description":"The type of media stream.","type":"string","enum":[{"name":"Video","value":"video"},{"name":"Audio","value":"audio"},{"name":"AncillaryData","value":"ancillary-data"}]},"aws-native:mediaconnect:FlowMediaStreamSourceConfiguration":{"description":"The media stream that is associated with the source, and the parameters for that association.","properties":{"encodingName":{"$ref":"#/types/aws-native:mediaconnect:FlowMediaStreamSourceConfigurationEncodingName","description":"The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv."},"inputConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:mediaconnect:FlowInputConfiguration"},"description":"The media streams that you want to associate with the source."},"mediaStreamName":{"type":"string","description":"A name that helps you distinguish one media stream from another."}},"type":"object","required":["encodingName","mediaStreamName"]},"aws-native:mediaconnect:FlowMediaStreamSourceConfigurationEncodingName":{"description":"The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.","type":"string","enum":[{"name":"Jxsv","value":"jxsv"},{"name":"Raw","value":"raw"},{"name":"Smpte291","value":"smpte291"},{"name":"Pcm","value":"pcm"}]},"aws-native:mediaconnect:FlowMediaStreamVideoFormat":{"description":"The resolution of the video.","type":"string","enum":[{"name":"2160p","value":"2160p"},{"name":"1080p","value":"1080p"},{"name":"1080i","value":"1080i"},{"name":"720p","value":"720p"},{"name":"480p","value":"480p"}]},"aws-native:mediaconnect:FlowNdiConfig":{"description":"Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.","properties":{"machineName":{"type":"string","description":"A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix."},"ndiDiscoveryServers":{"type":"array","items":{"$ref":"#/types/aws-native:mediaconnect:FlowNdiDiscoveryServerConfig"},"description":"A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly."},"ndiState":{"$ref":"#/types/aws-native:mediaconnect:FlowNdiConfigNdiState","description":"A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED."}},"type":"object"},"aws-native:mediaconnect:FlowNdiConfigNdiState":{"description":"A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:FlowNdiDiscoveryServerConfig":{"description":"Specifies the configuration settings for individual NDI discovery servers. A maximum of 3 servers is allowed.","properties":{"discoveryServerAddress":{"type":"string","description":"The unique network address of the NDI discovery server."},"discoveryServerPort":{"type":"integer","description":"The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified."},"vpcInterfaceAdapter":{"type":"string","description":"The identifier for the Virtual Private Cloud (VPC) network interface used by the flow."}},"type":"object","required":["discoveryServerAddress","vpcInterfaceAdapter"]},"aws-native:mediaconnect:FlowOutputAutomaticEncryptionKeyConfiguration":{"description":"Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.","type":"object"},"aws-native:mediaconnect:FlowOutputDestinationConfiguration":{"description":"The definition of a media stream that is associated with the output.","properties":{"destinationIp":{"type":"string","description":"The IP address where contents of the media stream will be sent."},"destinationPort":{"type":"integer","description":"The port to use when the content of the media stream is distributed to the output."},"interface":{"$ref":"#/types/aws-native:mediaconnect:FlowOutputInterface","description":"The VPC interface that is used for the media stream associated with the output."}},"type":"object","required":["destinationIp","destinationPort","interface"]},"aws-native:mediaconnect:FlowOutputEncodingParameters":{"description":"A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.","properties":{"compressionFactor":{"type":"number","description":"A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are in the range of 3.0 to 10.0, inclusive."},"encoderProfile":{"$ref":"#/types/aws-native:mediaconnect:FlowOutputEncodingParametersEncoderProfile","description":"A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol."}},"type":"object","required":["compressionFactor"]},"aws-native:mediaconnect:FlowOutputEncodingParametersEncoderProfile":{"description":"A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.","type":"string","enum":[{"name":"Main","value":"main"},{"name":"High","value":"high"}]},"aws-native:mediaconnect:FlowOutputEncryption":{"description":"Information about the encryption of the flow.","properties":{"algorithm":{"$ref":"#/types/aws-native:mediaconnect:FlowOutputEncryptionAlgorithm","description":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)."},"keyType":{"$ref":"#/types/aws-native:mediaconnect:FlowOutputEncryptionKeyType","description":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."},"roleArn":{"type":"string","description":"The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)."},"secretArn":{"type":"string","description":" The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption."}},"type":"object","required":["roleArn","secretArn"]},"aws-native:mediaconnect:FlowOutputEncryptionAlgorithm":{"description":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).","type":"string","enum":[{"name":"Aes128","value":"aes128"},{"name":"Aes192","value":"aes192"},{"name":"Aes256","value":"aes256"}]},"aws-native:mediaconnect:FlowOutputEncryptionKeyType":{"description":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).","type":"string","enum":[{"name":"StaticKey","value":"static-key"},{"name":"SrtPassword","value":"srt-password"}]},"aws-native:mediaconnect:FlowOutputFlowTransitEncryption":{"description":"The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.","properties":{"encryptionKeyConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:mediaconnect:FlowOutputFlowTransitEncryptionKeyConfiguration0Properties"},{"$ref":"#/types/aws-native:mediaconnect:FlowOutputFlowTransitEncryptionKeyConfiguration1Properties"}]},"encryptionKeyType":{"$ref":"#/types/aws-native:mediaconnect:FlowOutputFlowTransitEncryptionKeyType"}},"type":"object","required":["encryptionKeyConfiguration"]},"aws-native:mediaconnect:FlowOutputFlowTransitEncryptionKeyConfiguration0Properties":{"description":"Configuration settings for flow transit encryption keys.","properties":{"secretsManager":{"$ref":"#/types/aws-native:mediaconnect:FlowOutputSecretsManagerEncryptionKeyConfiguration"}},"type":"object","required":["secretsManager"]},"aws-native:mediaconnect:FlowOutputFlowTransitEncryptionKeyConfiguration1Properties":{"description":"Configuration settings for flow transit encryption keys.","properties":{"automatic":{"$ref":"#/types/aws-native:mediaconnect:FlowOutputAutomaticEncryptionKeyConfiguration"}},"type":"object","required":["automatic"]},"aws-native:mediaconnect:FlowOutputFlowTransitEncryptionKeyType":{"type":"string","enum":[{"name":"SecretsManager","value":"SECRETS_MANAGER"},{"name":"Automatic","value":"AUTOMATIC"}]},"aws-native:mediaconnect:FlowOutputInterface":{"description":"The VPC interface that you want to use for the media stream associated with the output.","properties":{"name":{"type":"string","description":"The name of the VPC interface that you want to use for the media stream associated with the output."}},"type":"object","required":["name"]},"aws-native:mediaconnect:FlowOutputMediaStreamOutputConfiguration":{"description":"The media stream that is associated with the output, and the parameters for that association.","properties":{"destinationConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:mediaconnect:FlowOutputDestinationConfiguration"},"description":"The media streams that you want to associate with the output."},"encodingName":{"$ref":"#/types/aws-native:mediaconnect:FlowOutputMediaStreamOutputConfigurationEncodingName","description":"The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video streams on sources or outputs that use the CDI protocol, set the encoding name to raw. For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name to jxsv."},"encodingParameters":{"$ref":"#/types/aws-native:mediaconnect:FlowOutputEncodingParameters","description":"A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source."},"mediaStreamName":{"type":"string","description":"A name that helps you distinguish one media stream from another."}},"type":"object","required":["encodingName","mediaStreamName"]},"aws-native:mediaconnect:FlowOutputMediaStreamOutputConfigurationEncodingName":{"description":"The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video streams on sources or outputs that use the CDI protocol, set the encoding name to raw. For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name to jxsv.","type":"string","enum":[{"name":"Jxsv","value":"jxsv"},{"name":"Raw","value":"raw"},{"name":"Smpte291","value":"smpte291"},{"name":"Pcm","value":"pcm"}]},"aws-native:mediaconnect:FlowOutputOutputStatus":{"description":"An indication of whether the output should transmit data or not.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:FlowOutputProtocol":{"description":"The protocol that is used by the source or output.","type":"string","enum":[{"name":"ZixiPush","value":"zixi-push"},{"name":"RtpFec","value":"rtp-fec"},{"name":"Rtp","value":"rtp"},{"name":"ZixiPull","value":"zixi-pull"},{"name":"Rist","value":"rist"},{"name":"FujitsuQos","value":"fujitsu-qos"},{"name":"SrtListener","value":"srt-listener"},{"name":"SrtCaller","value":"srt-caller"},{"name":"St2110Jpegxs","value":"st2110-jpegxs"},{"name":"Cdi","value":"cdi"},{"name":"NdiSpeedHq","value":"ndi-speed-hq"}]},"aws-native:mediaconnect:FlowOutputRouterIntegrationState":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:FlowOutputSecretsManagerEncryptionKeyConfiguration":{"description":"The configuration settings for transit encryption of a flow output using AWS Secrets Manager, including the secret ARN and role ARN.","properties":{"roleArn":{"type":"string","description":"The ARN of the IAM role used for transit encryption to the router input using AWS Secrets Manager."},"secretArn":{"type":"string","description":"The ARN of the AWS Secrets Manager secret used for transit encryption to the router input."}},"type":"object","required":["roleArn","secretArn"]},"aws-native:mediaconnect:FlowOutputVpcInterfaceAttachment":{"description":"The settings for attaching a VPC interface to an output.","properties":{"vpcInterfaceName":{"type":"string","description":"The name of the VPC interface to use for this output."}},"type":"object"},"aws-native:mediaconnect:FlowSecretsManagerEncryptionKeyConfiguration":{"description":"The configuration settings for transit encryption of a flow source using AWS Secrets Manager, including the secret ARN and role ARN.","properties":{"roleArn":{"type":"string","description":"The ARN of the IAM role used for transit encryption from the router output using AWS Secrets Manager."},"secretArn":{"type":"string","description":"The ARN of the AWS Secrets Manager secret used for transit encryption from the router output."}},"type":"object","required":["roleArn","secretArn"]},"aws-native:mediaconnect:FlowSilentAudio":{"description":"Configures settings for the SilentAudio metric.","properties":{"state":{"$ref":"#/types/aws-native:mediaconnect:FlowSilentAudioState","description":"Indicates whether the SilentAudio metric is enabled or disabled."},"thresholdSeconds":{"type":"integer","description":"Specifies the number of consecutive seconds of silence that triggers an event or alert."}},"type":"object"},"aws-native:mediaconnect:FlowSilentAudioState":{"description":"Indicates whether the SilentAudio metric is enabled or disabled.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:FlowSize":{"description":"Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.","type":"string","enum":[{"name":"Medium","value":"MEDIUM"},{"name":"Large","value":"LARGE"}]},"aws-native:mediaconnect:FlowSource":{"description":"The settings for the source of the flow.","properties":{"decryption":{"$ref":"#/types/aws-native:mediaconnect:FlowEncryption","description":"The type of decryption that is used on the content ingested from this source."},"description":{"type":"string","description":"A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account."},"entitlementArn":{"type":"string","description":"The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow."},"gatewayBridgeSource":{"$ref":"#/types/aws-native:mediaconnect:FlowGatewayBridgeSource","description":"The source configuration for cloud flows receiving a stream from a bridge."},"ingestIp":{"type":"string","description":"The IP address that the flow will be listening on for incoming content."},"ingestPort":{"type":"integer","description":"The port that the flow will be listening on for incoming content."},"maxBitrate":{"type":"integer","description":"The smoothing max bitrate for RIST, RTP, and RTP-FEC streams."},"maxLatency":{"type":"integer","description":"The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams."},"maxSyncBuffer":{"type":"integer","description":"The size of the buffer (in milliseconds) to use to sync incoming source data."},"mediaStreamSourceConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:mediaconnect:FlowMediaStreamSourceConfiguration"},"description":"The media stream that is associated with the source, and the parameters for that association."},"minLatency":{"type":"integer","description":"The minimum latency in milliseconds."},"name":{"type":"string","description":"The name of the source.","replaceOnChanges":true},"protocol":{"$ref":"#/types/aws-native:mediaconnect:FlowSourceProtocol","description":"The protocol that is used by the source."},"routerIntegrationState":{"$ref":"#/types/aws-native:mediaconnect:FlowSourceRouterIntegrationState","description":"Indicates if router integration is enabled or disabled on the flow source."},"routerIntegrationTransitDecryption":{"$ref":"#/types/aws-native:mediaconnect:FlowTransitEncryption","description":"The decryption configuration for the flow source when router integration is enabled."},"senderControlPort":{"type":"integer","description":"The port that the flow uses to send outbound requests to initiate connection with the sender for fujitsu-qos protocol."},"senderIpAddress":{"type":"string","description":"The IP address that the flow communicates with to initiate connection with the sender for fujitsu-qos protocol."},"sourceArn":{"type":"string","description":"The ARN of the source."},"sourceIngestPort":{"type":"string","description":"The port that the flow will be listening on for incoming content.(ReadOnly)"},"sourceListenerAddress":{"type":"string","description":"Source IP or domain name for SRT-caller protocol."},"sourceListenerPort":{"type":"integer","description":"Source port for SRT-caller protocol."},"streamId":{"type":"string","description":"The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams."},"vpcInterfaceName":{"type":"string","description":"The name of the VPC Interface this Source is configured with."},"whitelistCidr":{"type":"string","description":"The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16."}},"type":"object"},"aws-native:mediaconnect:FlowSourceEncryption":{"description":"Information about the encryption of the flow.","properties":{"algorithm":{"$ref":"#/types/aws-native:mediaconnect:FlowSourceEncryptionAlgorithm","description":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)."},"constantInitializationVector":{"type":"string","description":"A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption."},"deviceId":{"type":"string","description":"The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"keyType":{"$ref":"#/types/aws-native:mediaconnect:FlowSourceEncryptionKeyType","description":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)."},"region":{"type":"string","description":"The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"resourceId":{"type":"string","description":"An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption."},"roleArn":{"type":"string","description":"The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)."},"secretArn":{"type":"string","description":" The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption."},"url":{"type":"string","description":"The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption."}},"type":"object","required":["roleArn"]},"aws-native:mediaconnect:FlowSourceEncryptionAlgorithm":{"description":"The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).","type":"string","enum":[{"name":"Aes128","value":"aes128"},{"name":"Aes192","value":"aes192"},{"name":"Aes256","value":"aes256"}]},"aws-native:mediaconnect:FlowSourceEncryptionKeyType":{"description":"The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).","type":"string","enum":[{"name":"Speke","value":"speke"},{"name":"StaticKey","value":"static-key"},{"name":"SrtPassword","value":"srt-password"}]},"aws-native:mediaconnect:FlowSourceGatewayBridgeSource":{"description":"The source configuration for cloud flows receiving a stream from a bridge.","properties":{"bridgeArn":{"type":"string","description":"The ARN of the bridge feeding this flow."},"vpcInterfaceAttachment":{"$ref":"#/types/aws-native:mediaconnect:FlowSourceVpcInterfaceAttachment","description":"The name of the VPC interface attachment to use for this bridge source."}},"type":"object","required":["bridgeArn"]},"aws-native:mediaconnect:FlowSourceMonitoringConfig":{"description":"The settings for source monitoring.","properties":{"audioMonitoringSettings":{"type":"array","items":{"$ref":"#/types/aws-native:mediaconnect:FlowAudioMonitoringSetting"},"description":"Contains the settings for audio stream metrics monitoring."},"contentQualityAnalysisState":{"$ref":"#/types/aws-native:mediaconnect:FlowSourceMonitoringConfigContentQualityAnalysisState","description":"Indicates whether content quality analysis is enabled or disabled."},"thumbnailState":{"$ref":"#/types/aws-native:mediaconnect:FlowSourceMonitoringConfigThumbnailState","description":"The state of thumbnail monitoring."},"videoMonitoringSettings":{"type":"array","items":{"$ref":"#/types/aws-native:mediaconnect:FlowVideoMonitoringSetting"},"description":"Contains the settings for video stream metrics monitoring."}},"type":"object"},"aws-native:mediaconnect:FlowSourceMonitoringConfigContentQualityAnalysisState":{"description":"Indicates whether content quality analysis is enabled or disabled.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:FlowSourceMonitoringConfigThumbnailState":{"description":"The state of thumbnail monitoring.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:FlowSourceProtocol":{"description":"The protocol that is used by the source.","type":"string","enum":[{"name":"ZixiPush","value":"zixi-push"},{"name":"RtpFec","value":"rtp-fec"},{"name":"Rtp","value":"rtp"},{"name":"Rist","value":"rist"},{"name":"FujitsuQos","value":"fujitsu-qos"},{"name":"SrtListener","value":"srt-listener"},{"name":"SrtCaller","value":"srt-caller"},{"name":"St2110Jpegxs","value":"st2110-jpegxs"},{"name":"Cdi","value":"cdi"}]},"aws-native:mediaconnect:FlowSourceRouterIntegrationState":{"description":"Indicates if router integration is enabled or disabled on the flow source.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:FlowSourceVpcInterfaceAttachment":{"description":"The settings for attaching a VPC interface to an resource.","properties":{"vpcInterfaceName":{"type":"string","description":"The name of the VPC interface to use for this resource."}},"type":"object"},"aws-native:mediaconnect:FlowTransitEncryption":{"description":"The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.","properties":{"encryptionKeyConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:mediaconnect:FlowTransitEncryptionKeyConfiguration0Properties"},{"$ref":"#/types/aws-native:mediaconnect:FlowTransitEncryptionKeyConfiguration1Properties"}]},"encryptionKeyType":{"$ref":"#/types/aws-native:mediaconnect:FlowTransitEncryptionKeyType"}},"type":"object","required":["encryptionKeyConfiguration"]},"aws-native:mediaconnect:FlowTransitEncryptionKeyConfiguration0Properties":{"description":"Configuration settings for flow transit encryption keys.","properties":{"secretsManager":{"$ref":"#/types/aws-native:mediaconnect:FlowSecretsManagerEncryptionKeyConfiguration"}},"type":"object","required":["secretsManager"]},"aws-native:mediaconnect:FlowTransitEncryptionKeyConfiguration1Properties":{"description":"Configuration settings for flow transit encryption keys.","properties":{"automatic":{"$ref":"#/types/aws-native:mediaconnect:FlowAutomaticEncryptionKeyConfiguration"}},"type":"object","required":["automatic"]},"aws-native:mediaconnect:FlowTransitEncryptionKeyType":{"type":"string","enum":[{"name":"SecretsManager","value":"SECRETS_MANAGER"},{"name":"Automatic","value":"AUTOMATIC"}]},"aws-native:mediaconnect:FlowVideoMonitoringSetting":{"description":"Specifies the configuration for video stream metrics monitoring.","properties":{"blackFrames":{"$ref":"#/types/aws-native:mediaconnect:FlowBlackFrames","description":"Detects video frames that are black."},"frozenFrames":{"$ref":"#/types/aws-native:mediaconnect:FlowFrozenFrames","description":"Detects video frames that have not changed."}},"type":"object"},"aws-native:mediaconnect:FlowVpcInterface":{"description":"The details of a VPC interface.","properties":{"name":{"type":"string","description":"Immutable and has to be a unique against other VpcInterfaces in this Flow."},"networkInterfaceIds":{"type":"array","items":{"type":"string"},"description":"IDs of the network interfaces created in customer's account by MediaConnect."},"networkInterfaceType":{"$ref":"#/types/aws-native:mediaconnect:FlowVpcInterfaceNetworkInterfaceType","description":"The type of network adapter that you want MediaConnect to use on this interface. If you don't set this value, it defaults to ENA."},"roleArn":{"type":"string","description":"Role Arn MediaConnect can assume to create ENIs in customer's account."},"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"Security Group IDs to be used on ENI."},"subnetId":{"type":"string","description":"Subnet must be in the AZ of the Flow"}},"type":"object","required":["name","roleArn","securityGroupIds","subnetId"]},"aws-native:mediaconnect:FlowVpcInterfaceAttachment":{"description":"The settings for attaching a VPC interface to an resource.","properties":{"vpcInterfaceName":{"type":"string","description":"The name of the VPC interface to use for this resource."}},"type":"object"},"aws-native:mediaconnect:FlowVpcInterfaceNetworkInterfaceType":{"description":"The type of network adapter that you want MediaConnect to use on this interface. If you don't set this value, it defaults to ENA.","type":"string","enum":[{"name":"Ena","value":"ena"},{"name":"Efa","value":"efa"}]},"aws-native:mediaconnect:GatewayNetwork":{"description":"The network settings for a gateway.","properties":{"cidrBlock":{"type":"string","description":"A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16."},"name":{"type":"string","description":"The name of the network. This name is used to reference the network and must be unique among networks in this gateway."}},"type":"object","required":["cidrBlock","name"]},"aws-native:mediaconnect:GatewayState":{"description":"The current status of the gateway.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Updating","value":"UPDATING"},{"name":"Error","value":"ERROR"},{"name":"Deleting","value":"DELETING"},{"name":"Deleted","value":"DELETED"}]},"aws-native:mediaconnect:RouterInputAutomaticEncryptionKeyConfiguration":{"description":"Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.","type":"object"},"aws-native:mediaconnect:RouterInputConfiguration0Properties":{"description":"The configuration settings for a router input.","properties":{"standard":{"$ref":"#/types/aws-native:mediaconnect:RouterInputStandardRouterInputConfiguration"}},"type":"object","required":["standard"]},"aws-native:mediaconnect:RouterInputConfiguration1Properties":{"description":"The configuration settings for a router input.","properties":{"failover":{"$ref":"#/types/aws-native:mediaconnect:RouterInputFailoverRouterInputConfiguration"}},"type":"object","required":["failover"]},"aws-native:mediaconnect:RouterInputConfiguration2Properties":{"description":"The configuration settings for a router input.","properties":{"merge":{"$ref":"#/types/aws-native:mediaconnect:RouterInputMergeRouterInputConfiguration"}},"type":"object","required":["merge"]},"aws-native:mediaconnect:RouterInputConfiguration3Properties":{"description":"The configuration settings for a router input.","properties":{"mediaConnectFlow":{"$ref":"#/types/aws-native:mediaconnect:RouterInputMediaConnectFlowRouterInputConfiguration"}},"type":"object","required":["mediaConnectFlow"]},"aws-native:mediaconnect:RouterInputDay":{"type":"string","enum":[{"name":"Monday","value":"MONDAY"},{"name":"Tuesday","value":"TUESDAY"},{"name":"Wednesday","value":"WEDNESDAY"},{"name":"Thursday","value":"THURSDAY"},{"name":"Friday","value":"FRIDAY"},{"name":"Saturday","value":"SATURDAY"},{"name":"Sunday","value":"SUNDAY"}]},"aws-native:mediaconnect:RouterInputDefaultMaintenanceConfiguration":{"description":"Configuration settings for default maintenance scheduling.","type":"object"},"aws-native:mediaconnect:RouterInputFailoverInputSourcePriorityMode":{"type":"string","enum":[{"name":"NoPriority","value":"NO_PRIORITY"},{"name":"PrimarySecondary","value":"PRIMARY_SECONDARY"}]},"aws-native:mediaconnect:RouterInputFailoverRouterInputConfiguration":{"description":"Configuration settings for a failover router input that allows switching between two input sources.","properties":{"networkInterfaceArn":{"type":"string","description":"The ARN of the network interface to use for this failover router input."},"primarySourceIndex":{"type":"integer","description":"The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY"},"protocolConfigurations":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:mediaconnect:RouterInputFailoverRouterInputProtocolConfiguration0Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterInputFailoverRouterInputProtocolConfiguration1Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterInputFailoverRouterInputProtocolConfiguration2Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterInputFailoverRouterInputProtocolConfiguration3Properties"}]},"description":"A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type."},"sourcePriorityMode":{"$ref":"#/types/aws-native:mediaconnect:RouterInputFailoverInputSourcePriorityMode"}},"type":"object","required":["networkInterfaceArn","protocolConfigurations","sourcePriorityMode"]},"aws-native:mediaconnect:RouterInputFailoverRouterInputProtocolConfiguration0Properties":{"description":"Protocol configuration settings for failover router inputs.","properties":{"rtp":{"$ref":"#/types/aws-native:mediaconnect:RouterInputRtpRouterInputConfiguration"}},"type":"object","required":["rtp"]},"aws-native:mediaconnect:RouterInputFailoverRouterInputProtocolConfiguration1Properties":{"description":"Protocol configuration settings for failover router inputs.","properties":{"rist":{"$ref":"#/types/aws-native:mediaconnect:RouterInputRistRouterInputConfiguration"}},"type":"object","required":["rist"]},"aws-native:mediaconnect:RouterInputFailoverRouterInputProtocolConfiguration2Properties":{"description":"Protocol configuration settings for failover router inputs.","properties":{"srtListener":{"$ref":"#/types/aws-native:mediaconnect:RouterInputSrtListenerRouterInputConfiguration"}},"type":"object","required":["srtListener"]},"aws-native:mediaconnect:RouterInputFailoverRouterInputProtocolConfiguration3Properties":{"description":"Protocol configuration settings for failover router inputs.","properties":{"srtCaller":{"$ref":"#/types/aws-native:mediaconnect:RouterInputSrtCallerRouterInputConfiguration"}},"type":"object","required":["srtCaller"]},"aws-native:mediaconnect:RouterInputFlowTransitEncryption":{"description":"The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.","properties":{"encryptionKeyConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:mediaconnect:RouterInputFlowTransitEncryptionKeyConfiguration0Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterInputFlowTransitEncryptionKeyConfiguration1Properties"}]},"encryptionKeyType":{"$ref":"#/types/aws-native:mediaconnect:RouterInputFlowTransitEncryptionKeyType"}},"type":"object","required":["encryptionKeyConfiguration"]},"aws-native:mediaconnect:RouterInputFlowTransitEncryptionKeyConfiguration0Properties":{"description":"Configuration settings for flow transit encryption keys.","properties":{"secretsManager":{"$ref":"#/types/aws-native:mediaconnect:RouterInputSecretsManagerEncryptionKeyConfiguration"}},"type":"object","required":["secretsManager"]},"aws-native:mediaconnect:RouterInputFlowTransitEncryptionKeyConfiguration1Properties":{"description":"Configuration settings for flow transit encryption keys.","properties":{"automatic":{"$ref":"#/types/aws-native:mediaconnect:RouterInputAutomaticEncryptionKeyConfiguration"}},"type":"object","required":["automatic"]},"aws-native:mediaconnect:RouterInputFlowTransitEncryptionKeyType":{"type":"string","enum":[{"name":"SecretsManager","value":"SECRETS_MANAGER"},{"name":"Automatic","value":"AUTOMATIC"}]},"aws-native:mediaconnect:RouterInputForwardErrorCorrectionState":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:RouterInputMaintenanceConfiguration0Properties":{"description":"The configuration settings for maintenance operations, including preferred maintenance windows and schedules.","properties":{"preferredDayTime":{"$ref":"#/types/aws-native:mediaconnect:RouterInputPreferredDayTimeMaintenanceConfiguration"}},"type":"object","required":["preferredDayTime"]},"aws-native:mediaconnect:RouterInputMaintenanceConfiguration1Properties":{"description":"The configuration settings for maintenance operations, including preferred maintenance windows and schedules.","properties":{"default":{"$ref":"#/types/aws-native:mediaconnect:RouterInputDefaultMaintenanceConfiguration"}},"type":"object","required":["default"]},"aws-native:mediaconnect:RouterInputMaintenanceType":{"type":"string","enum":[{"name":"PreferredDayTime","value":"PREFERRED_DAY_TIME"},{"name":"Default","value":"DEFAULT"}]},"aws-native:mediaconnect:RouterInputMediaConnectFlowRouterInputConfiguration":{"description":"Configuration settings for connecting a router input to a flow output.","properties":{"flowArn":{"type":"string","description":"The ARN of the flow to connect to."},"flowOutputArn":{"type":"string","description":"The ARN of the flow output to connect to this router input."},"sourceTransitDecryption":{"$ref":"#/types/aws-native:mediaconnect:RouterInputFlowTransitEncryption"}},"type":"object","required":["sourceTransitDecryption"]},"aws-native:mediaconnect:RouterInputMergeRouterInputConfiguration":{"description":"Configuration settings for a merge router input that combines two input sources.","properties":{"mergeRecoveryWindowMilliseconds":{"type":"integer","description":"The time window in milliseconds for merging the two input sources."},"networkInterfaceArn":{"type":"string","description":"The ARN of the network interface to use for this merge router input."},"protocolConfigurations":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:mediaconnect:RouterInputMergeRouterInputProtocolConfiguration0Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterInputMergeRouterInputProtocolConfiguration1Properties"}]},"description":"A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type."}},"type":"object","required":["mergeRecoveryWindowMilliseconds","networkInterfaceArn","protocolConfigurations"]},"aws-native:mediaconnect:RouterInputMergeRouterInputProtocolConfiguration0Properties":{"description":"Protocol configuration settings for merge router inputs.","properties":{"rtp":{"$ref":"#/types/aws-native:mediaconnect:RouterInputRtpRouterInputConfiguration"}},"type":"object","required":["rtp"]},"aws-native:mediaconnect:RouterInputMergeRouterInputProtocolConfiguration1Properties":{"description":"Protocol configuration settings for merge router inputs.","properties":{"rist":{"$ref":"#/types/aws-native:mediaconnect:RouterInputRistRouterInputConfiguration"}},"type":"object","required":["rist"]},"aws-native:mediaconnect:RouterInputPreferredDayTimeMaintenanceConfiguration":{"description":"Configuration for preferred day and time maintenance settings.","properties":{"day":{"$ref":"#/types/aws-native:mediaconnect:RouterInputDay"},"time":{"type":"string","description":"The preferred time for maintenance operations."}},"type":"object","required":["day","time"]},"aws-native:mediaconnect:RouterInputProtocol":{"type":"string","enum":[{"name":"Rtp","value":"RTP"},{"name":"Rist","value":"RIST"},{"name":"SrtCaller","value":"SRT_CALLER"},{"name":"SrtListener","value":"SRT_LISTENER"}]},"aws-native:mediaconnect:RouterInputProtocolConfiguration0Properties":{"description":"The protocol configuration settings for a router input.","properties":{"rtp":{"$ref":"#/types/aws-native:mediaconnect:RouterInputRtpRouterInputConfiguration"}},"type":"object","required":["rtp"]},"aws-native:mediaconnect:RouterInputProtocolConfiguration1Properties":{"description":"The protocol configuration settings for a router input.","properties":{"rist":{"$ref":"#/types/aws-native:mediaconnect:RouterInputRistRouterInputConfiguration"}},"type":"object","required":["rist"]},"aws-native:mediaconnect:RouterInputProtocolConfiguration2Properties":{"description":"The protocol configuration settings for a router input.","properties":{"srtListener":{"$ref":"#/types/aws-native:mediaconnect:RouterInputSrtListenerRouterInputConfiguration"}},"type":"object","required":["srtListener"]},"aws-native:mediaconnect:RouterInputProtocolConfiguration3Properties":{"description":"The protocol configuration settings for a router input.","properties":{"srtCaller":{"$ref":"#/types/aws-native:mediaconnect:RouterInputSrtCallerRouterInputConfiguration"}},"type":"object","required":["srtCaller"]},"aws-native:mediaconnect:RouterInputRistRouterInputConfiguration":{"description":"The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.","properties":{"port":{"type":"integer","description":"The port number used for the RIST protocol in the router input configuration."},"recoveryLatencyMilliseconds":{"type":"integer","description":"The recovery latency in milliseconds for the RIST protocol in the router input configuration."}},"type":"object","required":["port","recoveryLatencyMilliseconds"]},"aws-native:mediaconnect:RouterInputRoutingScope":{"type":"string","enum":[{"name":"Regional","value":"REGIONAL"},{"name":"Global","value":"GLOBAL"}]},"aws-native:mediaconnect:RouterInputRtpRouterInputConfiguration":{"description":"The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.","properties":{"forwardErrorCorrection":{"$ref":"#/types/aws-native:mediaconnect:RouterInputForwardErrorCorrectionState"},"port":{"type":"integer","description":"The port number used for the RTP protocol in the router input configuration."}},"type":"object","required":["port"]},"aws-native:mediaconnect:RouterInputSecretsManagerEncryptionKeyConfiguration":{"description":"The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.","properties":{"roleArn":{"type":"string","description":"The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret."},"secretArn":{"type":"string","description":"The ARN of the AWS Secrets Manager secret used for transit encryption."}},"type":"object","required":["roleArn","secretArn"]},"aws-native:mediaconnect:RouterInputSrtCallerRouterInputConfiguration":{"description":"The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.","properties":{"decryptionConfiguration":{"$ref":"#/types/aws-native:mediaconnect:RouterInputSrtDecryptionConfiguration"},"minimumLatencyMilliseconds":{"type":"integer","description":"The minimum latency in milliseconds for the SRT protocol in caller mode."},"sourceAddress":{"type":"string","description":"The source IP address for the SRT protocol in caller mode."},"sourcePort":{"type":"integer","description":"The source port number for the SRT protocol in caller mode."},"streamId":{"type":"string","description":"The stream ID for the SRT protocol in caller mode."}},"type":"object","required":["minimumLatencyMilliseconds","sourceAddress","sourcePort"]},"aws-native:mediaconnect:RouterInputSrtDecryptionConfiguration":{"description":"Contains the configuration settings for decrypting SRT streams, including the encryption key details and decryption parameters.","properties":{"encryptionKey":{"$ref":"#/types/aws-native:mediaconnect:RouterInputSecretsManagerEncryptionKeyConfiguration"}},"type":"object","required":["encryptionKey"]},"aws-native:mediaconnect:RouterInputSrtListenerRouterInputConfiguration":{"description":"The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.","properties":{"decryptionConfiguration":{"$ref":"#/types/aws-native:mediaconnect:RouterInputSrtDecryptionConfiguration"},"minimumLatencyMilliseconds":{"type":"integer","description":"The minimum latency in milliseconds for the SRT protocol in listener mode."},"port":{"type":"integer","description":"The port number for the SRT protocol in listener mode."}},"type":"object","required":["minimumLatencyMilliseconds","port"]},"aws-native:mediaconnect:RouterInputStandardRouterInputConfiguration":{"description":"The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.","properties":{"networkInterfaceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the network interface associated with the standard router input."},"protocol":{"$ref":"#/types/aws-native:mediaconnect:RouterInputProtocol"},"protocolConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:mediaconnect:RouterInputProtocolConfiguration0Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterInputProtocolConfiguration1Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterInputProtocolConfiguration2Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterInputProtocolConfiguration3Properties"}]}},"type":"object","required":["networkInterfaceArn","protocolConfiguration"]},"aws-native:mediaconnect:RouterInputState":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Standby","value":"STANDBY"},{"name":"Starting","value":"STARTING"},{"name":"Active","value":"ACTIVE"},{"name":"Stopping","value":"STOPPING"},{"name":"Deleting","value":"DELETING"},{"name":"Updating","value":"UPDATING"},{"name":"Error","value":"ERROR"},{"name":"Recovering","value":"RECOVERING"},{"name":"Migrating","value":"MIGRATING"}]},"aws-native:mediaconnect:RouterInputTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:mediaconnect:RouterInputTier":{"type":"string","enum":[{"name":"Input100","value":"INPUT_100"},{"name":"Input50","value":"INPUT_50"},{"name":"Input20","value":"INPUT_20"}]},"aws-native:mediaconnect:RouterInputTransitEncryption":{"description":"The transit encryption settings for a router input.","properties":{"encryptionKeyConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:mediaconnect:RouterInputTransitEncryptionKeyConfiguration0Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterInputTransitEncryptionKeyConfiguration1Properties"}]},"encryptionKeyType":{"$ref":"#/types/aws-native:mediaconnect:RouterInputTransitEncryptionKeyType"}},"type":"object","required":["encryptionKeyConfiguration"]},"aws-native:mediaconnect:RouterInputTransitEncryptionKeyConfiguration0Properties":{"description":"Defines the configuration settings for transit encryption keys.","properties":{"secretsManager":{"$ref":"#/types/aws-native:mediaconnect:RouterInputSecretsManagerEncryptionKeyConfiguration"}},"type":"object","required":["secretsManager"]},"aws-native:mediaconnect:RouterInputTransitEncryptionKeyConfiguration1Properties":{"description":"Defines the configuration settings for transit encryption keys.","properties":{"automatic":{"$ref":"#/types/aws-native:mediaconnect:RouterInputAutomaticEncryptionKeyConfiguration"}},"type":"object","required":["automatic"]},"aws-native:mediaconnect:RouterInputTransitEncryptionKeyType":{"type":"string","enum":[{"name":"SecretsManager","value":"SECRETS_MANAGER"},{"name":"Automatic","value":"AUTOMATIC"}]},"aws-native:mediaconnect:RouterInputType":{"type":"string","enum":[{"name":"Standard","value":"STANDARD"},{"name":"Failover","value":"FAILOVER"},{"name":"Merge","value":"MERGE"},{"name":"MediaconnectFlow","value":"MEDIACONNECT_FLOW"}]},"aws-native:mediaconnect:RouterNetworkInterfaceConfiguration0Properties":{"description":"The configuration settings for a router network interface.","properties":{"public":{"$ref":"#/types/aws-native:mediaconnect:RouterNetworkInterfacePublicRouterNetworkInterfaceConfiguration"}},"type":"object","required":["public"]},"aws-native:mediaconnect:RouterNetworkInterfaceConfiguration1Properties":{"description":"The configuration settings for a router network interface.","properties":{"vpc":{"$ref":"#/types/aws-native:mediaconnect:RouterNetworkInterfaceVpcRouterNetworkInterfaceConfiguration"}},"type":"object","required":["vpc"]},"aws-native:mediaconnect:RouterNetworkInterfacePublicRouterNetworkInterfaceConfiguration":{"description":"The configuration settings for a public router network interface, including the list of allowed CIDR blocks.","properties":{"allowRules":{"type":"array","items":{"$ref":"#/types/aws-native:mediaconnect:RouterNetworkInterfacePublicRouterNetworkInterfaceRule"},"description":"The list of allowed CIDR blocks for the public router network interface."}},"type":"object","required":["allowRules"]},"aws-native:mediaconnect:RouterNetworkInterfacePublicRouterNetworkInterfaceRule":{"description":"A rule that allows a specific CIDR block to access the public router network interface.","properties":{"cidr":{"type":"string","description":"The CIDR block that is allowed to access the public router network interface."}},"type":"object","required":["cidr"]},"aws-native:mediaconnect:RouterNetworkInterfaceState":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"Error","value":"ERROR"},{"name":"Recovering","value":"RECOVERING"}]},"aws-native:mediaconnect:RouterNetworkInterfaceTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:mediaconnect:RouterNetworkInterfaceType":{"type":"string","enum":[{"name":"Public","value":"PUBLIC"},{"name":"Vpc","value":"VPC"}]},"aws-native:mediaconnect:RouterNetworkInterfaceVpcRouterNetworkInterfaceConfiguration":{"description":"The configuration settings for a router network interface within a VPC, including the security group IDs and subnet ID.","properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The IDs of the security groups to associate with the router network interface within the VPC."},"subnetId":{"type":"string","description":"The ID of the subnet within the VPC to associate the router network interface with."}},"type":"object","required":["securityGroupIds","subnetId"]},"aws-native:mediaconnect:RouterOutputResourceAutomaticEncryptionKeyConfiguration":{"description":"Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.","type":"object"},"aws-native:mediaconnect:RouterOutputResourceDay":{"type":"string","enum":[{"name":"Monday","value":"MONDAY"},{"name":"Tuesday","value":"TUESDAY"},{"name":"Wednesday","value":"WEDNESDAY"},{"name":"Thursday","value":"THURSDAY"},{"name":"Friday","value":"FRIDAY"},{"name":"Saturday","value":"SATURDAY"},{"name":"Sunday","value":"SUNDAY"}]},"aws-native:mediaconnect:RouterOutputResourceDefaultMaintenanceConfiguration":{"description":"Configuration settings for default maintenance scheduling.","type":"object"},"aws-native:mediaconnect:RouterOutputResourceFlowTransitEncryption":{"description":"The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.","properties":{"encryptionKeyConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceFlowTransitEncryptionKeyConfiguration0Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceFlowTransitEncryptionKeyConfiguration1Properties"}]},"encryptionKeyType":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceFlowTransitEncryptionKeyType"}},"type":"object","required":["encryptionKeyConfiguration"]},"aws-native:mediaconnect:RouterOutputResourceFlowTransitEncryptionKeyConfiguration0Properties":{"description":"Configuration settings for flow transit encryption keys.","properties":{"secretsManager":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceSecretsManagerEncryptionKeyConfiguration"}},"type":"object","required":["secretsManager"]},"aws-native:mediaconnect:RouterOutputResourceFlowTransitEncryptionKeyConfiguration1Properties":{"description":"Configuration settings for flow transit encryption keys.","properties":{"automatic":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceAutomaticEncryptionKeyConfiguration"}},"type":"object","required":["automatic"]},"aws-native:mediaconnect:RouterOutputResourceFlowTransitEncryptionKeyType":{"type":"string","enum":[{"name":"SecretsManager","value":"SECRETS_MANAGER"},{"name":"Automatic","value":"AUTOMATIC"}]},"aws-native:mediaconnect:RouterOutputResourceForwardErrorCorrectionState":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:mediaconnect:RouterOutputResourceMaintenanceConfiguration0Properties":{"description":"The configuration settings for maintenance operations, including preferred maintenance windows and schedules.","properties":{"preferredDayTime":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourcePreferredDayTimeMaintenanceConfiguration"}},"type":"object","required":["preferredDayTime"]},"aws-native:mediaconnect:RouterOutputResourceMaintenanceConfiguration1Properties":{"description":"The configuration settings for maintenance operations, including preferred maintenance windows and schedules.","properties":{"default":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceDefaultMaintenanceConfiguration"}},"type":"object","required":["default"]},"aws-native:mediaconnect:RouterOutputResourceMaintenanceType":{"type":"string","enum":[{"name":"PreferredDayTime","value":"PREFERRED_DAY_TIME"},{"name":"Default","value":"DEFAULT"}]},"aws-native:mediaconnect:RouterOutputResourceMediaConnectFlowRouterOutputConfiguration":{"description":"Configuration settings for connecting a router output to a MediaConnect flow source.","properties":{"destinationTransitEncryption":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceFlowTransitEncryption"},"flowArn":{"type":"string","description":"The ARN of the flow to connect to this router output."},"flowSourceArn":{"type":"string","description":"The ARN of the flow source to connect to this router output."}},"type":"object","required":["destinationTransitEncryption"]},"aws-native:mediaconnect:RouterOutputResourceMediaLiveInputPipelineId":{"type":"string","enum":[{"name":"Pipeline0","value":"PIPELINE_0"},{"name":"Pipeline1","value":"PIPELINE_1"}]},"aws-native:mediaconnect:RouterOutputResourceMediaLiveInputRouterOutputConfiguration":{"description":"Configuration settings for connecting a router output to a MediaLive input.","properties":{"destinationTransitEncryption":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceMediaLiveTransitEncryption"},"mediaLiveInputArn":{"type":"string","description":"The ARN of the MediaLive input to connect to this router output."},"mediaLivePipelineId":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceMediaLiveInputPipelineId"}},"type":"object","required":["destinationTransitEncryption"]},"aws-native:mediaconnect:RouterOutputResourceMediaLiveTransitEncryption":{"description":"The encryption configuration that defines how content is encrypted during transit between MediaConnect Router and MediaLive. This configuration determines whether encryption keys are automatically managed by the service or manually managed through AWS Secrets Manager.","properties":{"encryptionKeyConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceMediaLiveTransitEncryptionKeyConfiguration0Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceMediaLiveTransitEncryptionKeyConfiguration1Properties"}]},"encryptionKeyType":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceMediaLiveTransitEncryptionKeyType"}},"type":"object","required":["encryptionKeyConfiguration"]},"aws-native:mediaconnect:RouterOutputResourceMediaLiveTransitEncryptionKeyConfiguration0Properties":{"description":"Configuration settings for the MediaLive transit encryption key.","properties":{"secretsManager":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceSecretsManagerEncryptionKeyConfiguration"}},"type":"object","required":["secretsManager"]},"aws-native:mediaconnect:RouterOutputResourceMediaLiveTransitEncryptionKeyConfiguration1Properties":{"description":"Configuration settings for the MediaLive transit encryption key.","properties":{"automatic":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceAutomaticEncryptionKeyConfiguration"}},"type":"object","required":["automatic"]},"aws-native:mediaconnect:RouterOutputResourceMediaLiveTransitEncryptionKeyType":{"type":"string","enum":[{"name":"SecretsManager","value":"SECRETS_MANAGER"},{"name":"Automatic","value":"AUTOMATIC"}]},"aws-native:mediaconnect:RouterOutputResourcePreferredDayTimeMaintenanceConfiguration":{"description":"Configuration for preferred day and time maintenance settings.","properties":{"day":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceDay"},"time":{"type":"string","description":"The preferred time for maintenance operations."}},"type":"object","required":["day","time"]},"aws-native:mediaconnect:RouterOutputResourceRistRouterOutputConfiguration":{"description":"The configuration settings for a router output using the RIST (Reliable Internet Stream Transport) protocol, including the destination address and port.","properties":{"destinationAddress":{"type":"string","description":"The destination IP address for the RIST protocol in the router output configuration."},"destinationPort":{"type":"integer","description":"The destination port number for the RIST protocol in the router output configuration."}},"type":"object","required":["destinationAddress","destinationPort"]},"aws-native:mediaconnect:RouterOutputResourceRouterOutputConfiguration0Properties":{"description":"The configuration settings for a router output.","properties":{"standard":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceStandardRouterOutputConfiguration"}},"type":"object","required":["standard"]},"aws-native:mediaconnect:RouterOutputResourceRouterOutputConfiguration1Properties":{"description":"The configuration settings for a router output.","properties":{"mediaConnectFlow":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceMediaConnectFlowRouterOutputConfiguration"}},"type":"object","required":["mediaConnectFlow"]},"aws-native:mediaconnect:RouterOutputResourceRouterOutputConfiguration2Properties":{"description":"The configuration settings for a router output.","properties":{"mediaLiveInput":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceMediaLiveInputRouterOutputConfiguration"}},"type":"object","required":["mediaLiveInput"]},"aws-native:mediaconnect:RouterOutputResourceRouterOutputProtocol":{"type":"string","enum":[{"name":"Rtp","value":"RTP"},{"name":"Rist","value":"RIST"},{"name":"SrtCaller","value":"SRT_CALLER"},{"name":"SrtListener","value":"SRT_LISTENER"}]},"aws-native:mediaconnect:RouterOutputResourceRouterOutputProtocolConfiguration0Properties":{"description":"The protocol configuration settings for a router output.","properties":{"rtp":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceRtpRouterOutputConfiguration"}},"type":"object","required":["rtp"]},"aws-native:mediaconnect:RouterOutputResourceRouterOutputProtocolConfiguration1Properties":{"description":"The protocol configuration settings for a router output.","properties":{"rist":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceRistRouterOutputConfiguration"}},"type":"object","required":["rist"]},"aws-native:mediaconnect:RouterOutputResourceRouterOutputProtocolConfiguration2Properties":{"description":"The protocol configuration settings for a router output.","properties":{"srtListener":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceSrtListenerRouterOutputConfiguration"}},"type":"object","required":["srtListener"]},"aws-native:mediaconnect:RouterOutputResourceRouterOutputProtocolConfiguration3Properties":{"description":"The protocol configuration settings for a router output.","properties":{"srtCaller":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceSrtCallerRouterOutputConfiguration"}},"type":"object","required":["srtCaller"]},"aws-native:mediaconnect:RouterOutputResourceRouterOutputRoutedState":{"type":"string","enum":[{"name":"Routed","value":"ROUTED"},{"name":"Routing","value":"ROUTING"},{"name":"Unrouted","value":"UNROUTED"}]},"aws-native:mediaconnect:RouterOutputResourceRouterOutputState":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Standby","value":"STANDBY"},{"name":"Starting","value":"STARTING"},{"name":"Active","value":"ACTIVE"},{"name":"Stopping","value":"STOPPING"},{"name":"Deleting","value":"DELETING"},{"name":"Updating","value":"UPDATING"},{"name":"Error","value":"ERROR"},{"name":"Recovering","value":"RECOVERING"},{"name":"Migrating","value":"MIGRATING"}]},"aws-native:mediaconnect:RouterOutputResourceRouterOutputTier":{"type":"string","enum":[{"name":"Output100","value":"OUTPUT_100"},{"name":"Output50","value":"OUTPUT_50"},{"name":"Output20","value":"OUTPUT_20"}]},"aws-native:mediaconnect:RouterOutputResourceRouterOutputType":{"type":"string","enum":[{"name":"Standard","value":"STANDARD"},{"name":"MediaconnectFlow","value":"MEDIACONNECT_FLOW"},{"name":"MedialiveInput","value":"MEDIALIVE_INPUT"}]},"aws-native:mediaconnect:RouterOutputResourceRoutingScope":{"type":"string","enum":[{"name":"Regional","value":"REGIONAL"},{"name":"Global","value":"GLOBAL"}]},"aws-native:mediaconnect:RouterOutputResourceRtpRouterOutputConfiguration":{"description":"The configuration settings for a router output using the RTP (Real-Time Transport Protocol) protocol, including the destination address and port, and forward error correction state.","properties":{"destinationAddress":{"type":"string","description":"The destination IP address for the RTP protocol in the router output configuration."},"destinationPort":{"type":"integer","description":"The destination port number for the RTP protocol in the router output configuration."},"forwardErrorCorrection":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceForwardErrorCorrectionState"}},"type":"object","required":["destinationAddress","destinationPort"]},"aws-native:mediaconnect:RouterOutputResourceSecretsManagerEncryptionKeyConfiguration":{"description":"The configuration settings for transit encryption using AWS Secrets Manager, including the secret ARN and role ARN.","properties":{"roleArn":{"type":"string","description":"The ARN of the IAM role assumed by MediaConnect to access the AWS Secrets Manager secret."},"secretArn":{"type":"string","description":"The ARN of the AWS Secrets Manager secret used for transit encryption."}},"type":"object","required":["roleArn","secretArn"]},"aws-native:mediaconnect:RouterOutputResourceSrtCallerRouterOutputConfiguration":{"description":"The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in caller mode, including the destination address and port, minimum latency, stream ID, and encryption key configuration.","properties":{"destinationAddress":{"type":"string","description":"The destination IP address for the SRT protocol in caller mode."},"destinationPort":{"type":"integer","description":"The destination port number for the SRT protocol in caller mode."},"encryptionConfiguration":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceSrtEncryptionConfiguration"},"minimumLatencyMilliseconds":{"type":"integer","description":"The minimum latency in milliseconds for the SRT protocol in caller mode."},"streamId":{"type":"string","description":"The stream ID for the SRT protocol in caller mode."}},"type":"object","required":["destinationAddress","destinationPort","minimumLatencyMilliseconds"]},"aws-native:mediaconnect:RouterOutputResourceSrtEncryptionConfiguration":{"description":"Contains the configuration settings for encrypting SRT streams, including the encryption key details and encryption parameters.","properties":{"encryptionKey":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceSecretsManagerEncryptionKeyConfiguration"}},"type":"object","required":["encryptionKey"]},"aws-native:mediaconnect:RouterOutputResourceSrtListenerRouterOutputConfiguration":{"description":"The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and encryption key configuration.","properties":{"encryptionConfiguration":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceSrtEncryptionConfiguration"},"minimumLatencyMilliseconds":{"type":"integer","description":"The minimum latency in milliseconds for the SRT protocol in listener mode."},"port":{"type":"integer","description":"The port number for the SRT protocol in listener mode."}},"type":"object","required":["minimumLatencyMilliseconds","port"]},"aws-native:mediaconnect:RouterOutputResourceStandardRouterOutputConfiguration":{"description":"The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.","properties":{"networkInterfaceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the network interface associated with the standard router output."},"protocol":{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceRouterOutputProtocol"},"protocolConfiguration":{"oneOf":[{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceRouterOutputProtocolConfiguration0Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceRouterOutputProtocolConfiguration1Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceRouterOutputProtocolConfiguration2Properties"},{"$ref":"#/types/aws-native:mediaconnect:RouterOutputResourceRouterOutputProtocolConfiguration3Properties"}]}},"type":"object","required":["networkInterfaceArn","protocolConfiguration"]},"aws-native:mediaconnect:RouterOutputResourceTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:medialive:ChannelPlacementGroupState":{"description":"The current state of the ChannelPlacementGroupState","type":"string","enum":[{"name":"Unassigned","value":"UNASSIGNED"},{"name":"Assigning","value":"ASSIGNING"},{"name":"Assigned","value":"ASSIGNED"},{"name":"Deleting","value":"DELETING"},{"name":"Deleted","value":"DELETED"},{"name":"Unassigning","value":"UNASSIGNING"}]},"aws-native:medialive:ChannelPlacementGroupTags":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:medialive:CloudWatchAlarmTemplateComparisonOperator":{"description":"The comparison operator used to compare the specified statistic and the threshold.","type":"string","enum":[{"name":"GreaterThanOrEqualToThreshold","value":"GreaterThanOrEqualToThreshold"},{"name":"GreaterThanThreshold","value":"GreaterThanThreshold"},{"name":"LessThanThreshold","value":"LessThanThreshold"},{"name":"LessThanOrEqualToThreshold","value":"LessThanOrEqualToThreshold"}]},"aws-native:medialive:CloudWatchAlarmTemplateStatistic":{"description":"The statistic to apply to the alarm's metric data.","type":"string","enum":[{"name":"SampleCount","value":"SampleCount"},{"name":"Average","value":"Average"},{"name":"Sum","value":"Sum"},{"name":"Minimum","value":"Minimum"},{"name":"Maximum","value":"Maximum"}]},"aws-native:medialive:CloudWatchAlarmTemplateTargetResourceType":{"description":"The resource type this template should dynamically generate cloudwatch metric alarms for.","type":"string","enum":[{"name":"CloudfrontDistribution","value":"CLOUDFRONT_DISTRIBUTION"},{"name":"MedialiveMultiplex","value":"MEDIALIVE_MULTIPLEX"},{"name":"MedialiveChannel","value":"MEDIALIVE_CHANNEL"},{"name":"MedialiveInputDevice","value":"MEDIALIVE_INPUT_DEVICE"},{"name":"MediapackageChannel","value":"MEDIAPACKAGE_CHANNEL"},{"name":"MediapackageOriginEndpoint","value":"MEDIAPACKAGE_ORIGIN_ENDPOINT"},{"name":"MediaconnectFlow","value":"MEDIACONNECT_FLOW"},{"name":"MediatailorPlaybackConfiguration","value":"MEDIATAILOR_PLAYBACK_CONFIGURATION"},{"name":"S3Bucket","value":"S3_BUCKET"}]},"aws-native:medialive:CloudWatchAlarmTemplateTreatMissingData":{"description":"Specifies how missing data points are treated when evaluating the alarm's condition.","type":"string","enum":[{"name":"NotBreaching","value":"notBreaching"},{"name":"Breaching","value":"breaching"},{"name":"Ignore","value":"ignore"},{"name":"Missing","value":"missing"}]},"aws-native:medialive:ClusterInterfaceMapping":{"description":"Network mappings for the cluster","properties":{"logicalInterfaceName":{"type":"string","description":"logical interface name, unique in the list"},"networkId":{"type":"string","description":"Network Id to be associated with the logical interface name, can be duplicated in list"}},"type":"object"},"aws-native:medialive:ClusterNetworkSettings":{"description":"On premises settings which will have the interface network mappings and default Output logical interface","properties":{"defaultRoute":{"type":"string","description":"Default value if the customer does not define it in channel Output API"},"interfaceMappings":{"type":"array","items":{"$ref":"#/types/aws-native:medialive:ClusterInterfaceMapping"},"description":"Network mappings for the cluster"}},"type":"object"},"aws-native:medialive:ClusterState":{"description":"The current state of the Cluster.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Deleted","value":"DELETED"}]},"aws-native:medialive:ClusterTags":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:medialive:ClusterType":{"description":"The hardware type for the cluster.","type":"string","enum":[{"name":"OnPremises","value":"ON_PREMISES"},{"name":"OutpostsRack","value":"OUTPOSTS_RACK"},{"name":"OutpostsServer","value":"OUTPOSTS_SERVER"},{"name":"Ec2","value":"EC2"}]},"aws-native:medialive:EventBridgeRuleTemplateEventType":{"description":"The type of event to match with the rule.","type":"string","enum":[{"name":"MedialiveMultiplexAlert","value":"MEDIALIVE_MULTIPLEX_ALERT"},{"name":"MedialiveMultiplexStateChange","value":"MEDIALIVE_MULTIPLEX_STATE_CHANGE"},{"name":"MedialiveChannelAlert","value":"MEDIALIVE_CHANNEL_ALERT"},{"name":"MedialiveChannelInputChange","value":"MEDIALIVE_CHANNEL_INPUT_CHANGE"},{"name":"MedialiveChannelStateChange","value":"MEDIALIVE_CHANNEL_STATE_CHANGE"},{"name":"MediapackageInputNotification","value":"MEDIAPACKAGE_INPUT_NOTIFICATION"},{"name":"MediapackageKeyProviderNotification","value":"MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION"},{"name":"MediapackageHarvestJobNotification","value":"MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION"},{"name":"SignalMapActiveAlarm","value":"SIGNAL_MAP_ACTIVE_ALARM"},{"name":"MediaconnectAlert","value":"MEDIACONNECT_ALERT"},{"name":"MediaconnectSourceHealth","value":"MEDIACONNECT_SOURCE_HEALTH"},{"name":"MediaconnectOutputHealth","value":"MEDIACONNECT_OUTPUT_HEALTH"},{"name":"MediaconnectFlowStatusChange","value":"MEDIACONNECT_FLOW_STATUS_CHANGE"}]},"aws-native:medialive:EventBridgeRuleTemplateTarget":{"description":"The target to which to send matching events.","properties":{"arn":{"type":"string","description":"Target ARNs must be either an SNS topic or CloudWatch log group."}},"type":"object","required":["arn"]},"aws-native:medialive:MultiplexOutputDestination":{"description":"Multiplex MediaConnect output destination settings.","properties":{"multiplexMediaConnectOutputDestinationSettings":{"$ref":"#/types/aws-native:medialive:MultiplexOutputDestinationMultiplexMediaConnectOutputDestinationSettingsProperties","description":"Multiplex MediaConnect output destination settings."}},"type":"object"},"aws-native:medialive:MultiplexOutputDestinationMultiplexMediaConnectOutputDestinationSettingsProperties":{"description":"Multiplex MediaConnect output destination settings.","properties":{"entitlementArn":{"type":"string","description":"The MediaConnect entitlement ARN available as a Flow source."}},"type":"object"},"aws-native:medialive:MultiplexSettings":{"description":"A key-value pair to associate with a resource.","properties":{"maximumVideoBufferDelayMilliseconds":{"type":"integer","description":"Maximum video buffer delay in milliseconds."},"transportStreamBitrate":{"type":"integer","description":"Transport stream bit rate."},"transportStreamId":{"type":"integer","description":"Transport stream ID."},"transportStreamReservedBitrate":{"type":"integer","description":"Transport stream reserved bit rate."}},"type":"object","required":["transportStreamBitrate","transportStreamId"]},"aws-native:medialive:MultiplexState":{"description":"The current state of the multiplex.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"Idle","value":"IDLE"},{"name":"Starting","value":"STARTING"},{"name":"Running","value":"RUNNING"},{"name":"Recovering","value":"RECOVERING"},{"name":"Stopping","value":"STOPPING"},{"name":"Deleting","value":"DELETING"},{"name":"Deleted","value":"DELETED"}]},"aws-native:medialive:MultiplexTags":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:medialive:MultiplexprogramMultiplexProgramPacketIdentifiersMap":{"description":"Packet identifiers map for a given Multiplex program.","properties":{"audioPids":{"type":"array","items":{"type":"integer"}},"dvbSubPids":{"type":"array","items":{"type":"integer"}},"dvbTeletextPid":{"type":"integer"},"etvPlatformPid":{"type":"integer"},"etvSignalPid":{"type":"integer"},"klvDataPids":{"type":"array","items":{"type":"integer"}},"pcrPid":{"type":"integer"},"pmtPid":{"type":"integer"},"privateMetadataPid":{"type":"integer"},"scte27Pids":{"type":"array","items":{"type":"integer"}},"scte35Pid":{"type":"integer"},"timedMetadataPid":{"type":"integer"},"videoPid":{"type":"integer"}},"type":"object"},"aws-native:medialive:MultiplexprogramMultiplexProgramPipelineDetail":{"description":"The current source for one of the pipelines in the multiplex.","properties":{"activeChannelPipeline":{"type":"string","description":"Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex."},"pipelineId":{"type":"string","description":"Identifies a specific pipeline in the multiplex."}},"type":"object"},"aws-native:medialive:MultiplexprogramMultiplexProgramServiceDescriptor":{"description":"Transport stream service descriptor configuration for the Multiplex program.","properties":{"providerName":{"type":"string","description":"Name of the provider."},"serviceName":{"type":"string","description":"Name of the service."}},"type":"object","required":["providerName","serviceName"]},"aws-native:medialive:MultiplexprogramMultiplexProgramSettings":{"description":"Multiplex Program settings configuration.","properties":{"preferredChannelPipeline":{"$ref":"#/types/aws-native:medialive:MultiplexprogramPreferredChannelPipeline","description":"Indicates which pipeline is preferred by the multiplex for program ingest."},"programNumber":{"type":"integer","description":"Unique program number."},"serviceDescriptor":{"$ref":"#/types/aws-native:medialive:MultiplexprogramMultiplexProgramServiceDescriptor","description":"Transport stream service descriptor configuration for the Multiplex program."},"videoSettings":{"$ref":"#/types/aws-native:medialive:MultiplexprogramMultiplexVideoSettings","description":"Program video settings configuration."}},"type":"object","required":["programNumber"]},"aws-native:medialive:MultiplexprogramMultiplexVideoSettings":{"description":"The video configuration for each program in a multiplex.","type":"object"},"aws-native:medialive:MultiplexprogramPreferredChannelPipeline":{"description":"Indicates which pipeline is preferred by the multiplex for program ingest.\nIf set to \\\"PIPELINE_0\\\" or \\\"PIPELINE_1\\\" and an unhealthy ingest causes the multiplex to switch to the non-preferred pipeline,\nit will switch back once that ingest is healthy again. If set to \\\"CURRENTLY_ACTIVE\\\",\nit will not switch back to the other pipeline based on it recovering to a healthy state,\nit will only switch if the active pipeline becomes unhealthy.\n","type":"string","enum":[{"name":"CurrentlyActive","value":"CURRENTLY_ACTIVE"},{"name":"Pipeline0","value":"PIPELINE_0"},{"name":"Pipeline1","value":"PIPELINE_1"}]},"aws-native:medialive:NetworkIpPool":{"description":"IP address cidr pool","properties":{"cidr":{"type":"string","description":"IP address cidr pool"}},"type":"object"},"aws-native:medialive:NetworkRoute":{"properties":{"cidr":{"type":"string","description":"Ip address cidr"},"gateway":{"type":"string","description":"IP address for the route packet paths"}},"type":"object"},"aws-native:medialive:NetworkState":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Idle","value":"IDLE"},{"name":"InUse","value":"IN_USE"},{"name":"Updating","value":"UPDATING"},{"name":"Deleted","value":"DELETED"},{"name":"DeleteFailed","value":"DELETE_FAILED"}]},"aws-native:medialive:NetworkTags":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:medialive:SdiSourceMode":{"description":"The current state of the SdiSource.","type":"string","enum":[{"name":"Quadrant","value":"QUADRANT"},{"name":"Interleave","value":"INTERLEAVE"}]},"aws-native:medialive:SdiSourceState":{"description":"The current state of the SdiSource.","type":"string","enum":[{"name":"Idle","value":"IDLE"},{"name":"InUse","value":"IN_USE"},{"name":"Deleted","value":"DELETED"}]},"aws-native:medialive:SdiSourceTags":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:medialive:SdiSourceType":{"description":"The interface mode of the SdiSource.","type":"string","enum":[{"name":"Single","value":"SINGLE"},{"name":"Quad","value":"QUAD"}]},"aws-native:medialive:SignalMapMediaResource":{"description":"An AWS resource used in media workflows.","properties":{"destinations":{"type":"array","items":{"$ref":"#/types/aws-native:medialive:SignalMapMediaResourceNeighbor"},"description":"A direct destination neighbor to an Amazon Web Services media resource."},"name":{"type":"string","description":"The logical name of an AWS media resource."},"sources":{"type":"array","items":{"$ref":"#/types/aws-native:medialive:SignalMapMediaResourceNeighbor"},"description":"A direct source neighbor to an Amazon Web Services media resource."}},"type":"object"},"aws-native:medialive:SignalMapMediaResourceNeighbor":{"description":"A direct source or destination neighbor to an AWS media resource.","properties":{"arn":{"type":"string","description":"The ARN of a resource used in AWS media workflows."},"name":{"type":"string","description":"The logical name of an AWS media resource."}},"type":"object","required":["arn"]},"aws-native:medialive:SignalMapMonitorDeployment":{"description":"Represents the latest monitor deployment of a signal map.","properties":{"detailsUri":{"type":"string","description":"URI associated with a signal map's monitor deployment."},"errorMessage":{"type":"string","description":"Error message associated with a failed monitor deployment of a signal map."},"status":{"$ref":"#/types/aws-native:medialive:SignalMapMonitorDeploymentStatus","description":"The signal map monitor deployment status."}},"type":"object","required":["status"]},"aws-native:medialive:SignalMapMonitorDeploymentStatus":{"description":"A signal map's monitor deployment status.","type":"string","enum":[{"name":"NotDeployed","value":"NOT_DEPLOYED"},{"name":"DryRunDeploymentComplete","value":"DRY_RUN_DEPLOYMENT_COMPLETE"},{"name":"DryRunDeploymentFailed","value":"DRY_RUN_DEPLOYMENT_FAILED"},{"name":"DryRunDeploymentInProgress","value":"DRY_RUN_DEPLOYMENT_IN_PROGRESS"},{"name":"DeploymentComplete","value":"DEPLOYMENT_COMPLETE"},{"name":"DeploymentFailed","value":"DEPLOYMENT_FAILED"},{"name":"DeploymentInProgress","value":"DEPLOYMENT_IN_PROGRESS"},{"name":"DeleteComplete","value":"DELETE_COMPLETE"},{"name":"DeleteFailed","value":"DELETE_FAILED"},{"name":"DeleteInProgress","value":"DELETE_IN_PROGRESS"}]},"aws-native:medialive:SignalMapStatus":{"description":"A signal map's current status which is dependent on its lifecycle actions or associated jobs.","type":"string","enum":[{"name":"CreateInProgress","value":"CREATE_IN_PROGRESS"},{"name":"CreateComplete","value":"CREATE_COMPLETE"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"UpdateInProgress","value":"UPDATE_IN_PROGRESS"},{"name":"UpdateComplete","value":"UPDATE_COMPLETE"},{"name":"UpdateReverted","value":"UPDATE_REVERTED"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"Ready","value":"READY"},{"name":"NotReady","value":"NOT_READY"}]},"aws-native:medialive:SignalMapSuccessfulMonitorDeployment":{"description":"Represents the latest successful monitor deployment of a signal map.","properties":{"detailsUri":{"type":"string","description":"URI associated with a signal map's monitor deployment."},"status":{"$ref":"#/types/aws-native:medialive:SignalMapMonitorDeploymentStatus","description":"A signal map's monitor deployment status."}},"type":"object","required":["detailsUri","status"]},"aws-native:mediapackage:AssetEgressEndpoint":{"description":"The endpoint URL used to access an Asset using one PackagingConfiguration.","properties":{"packagingConfigurationId":{"type":"string","description":"The ID of the PackagingConfiguration being applied to the Asset."},"url":{"type":"string","description":"The URL of the parent manifest for the repackaged Asset."}},"type":"object","required":["packagingConfigurationId","url"]},"aws-native:mediapackage:AssetTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:mediapackage:ChannelHlsIngest":{"description":"An HTTP Live Streaming (HLS) ingest resource configuration.","properties":{"ingestEndpoints":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackage:ChannelIngestEndpoint"},"description":"A list of endpoints to which the source stream should be sent."}},"type":"object"},"aws-native:mediapackage:ChannelIngestEndpoint":{"description":"An endpoint for ingesting source content for a Channel.","properties":{"id":{"type":"string","description":"The system generated unique identifier for the IngestEndpoint"},"password":{"type":"string","description":"The system generated password for ingest authentication."},"url":{"type":"string","description":"The ingest URL to which the source stream should be sent."},"username":{"type":"string","description":"The system generated username for ingest authentication."}},"type":"object"},"aws-native:mediapackage:ChannelLogConfiguration":{"properties":{"logGroupName":{"type":"string","description":"Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs."}},"type":"object"},"aws-native:mediapackage:ChannelTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:mediapackage:OriginEndpointAdsOnDeliveryRestrictions":{"description":"This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad.  Choosing \"NONE\" means no SCTE-35 messages become ads.  Choosing \"RESTRICTED\" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads.  Choosing \"UNRESTRICTED\" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads.  Choosing \"BOTH\" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads.  Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Restricted","value":"RESTRICTED"},{"name":"Unrestricted","value":"UNRESTRICTED"},{"name":"Both","value":"BOTH"}]},"aws-native:mediapackage:OriginEndpointAuthorization":{"description":"CDN Authorization credentials","properties":{"cdnIdentifierSecret":{"type":"string","description":"The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint."},"secretsRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager."}},"type":"object","required":["cdnIdentifierSecret","secretsRoleArn"]},"aws-native:mediapackage:OriginEndpointCmafEncryption":{"description":"A Common Media Application Format (CMAF) encryption configuration.","properties":{"constantInitializationVector":{"type":"string","description":"An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV)."},"encryptionMethod":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointCmafEncryptionEncryptionMethod","description":"The encryption method used"},"keyRotationIntervalSeconds":{"type":"integer","description":"Time (in seconds) between each encryption key rotation."},"spekeKeyProvider":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointSpekeKeyProvider","description":"Parameters for the SPEKE key provider."}},"type":"object","required":["spekeKeyProvider"]},"aws-native:mediapackage:OriginEndpointCmafEncryptionEncryptionMethod":{"description":"The encryption method used","type":"string","enum":[{"name":"SampleAes","value":"SAMPLE_AES"},{"name":"AesCtr","value":"AES_CTR"}]},"aws-native:mediapackage:OriginEndpointCmafPackage":{"description":"A Common Media Application Format (CMAF) packaging configuration.","properties":{"encryption":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointCmafEncryption","description":"Parameters for encrypting content."},"hlsManifests":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointHlsManifest"},"description":"A list of HLS manifest configurations"},"segmentDurationSeconds":{"type":"integer","description":"Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration."},"segmentPrefix":{"type":"string","description":"An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId."},"streamSelection":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointStreamSelection","description":"Limitations for outputs from the endpoint, based on the video bitrate."}},"type":"object"},"aws-native:mediapackage:OriginEndpointDashEncryption":{"description":"A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.","properties":{"keyRotationIntervalSeconds":{"type":"integer","description":"Time (in seconds) between each encryption key rotation."},"spekeKeyProvider":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointSpekeKeyProvider","description":"Parameters for the SPEKE key provider."}},"type":"object","required":["spekeKeyProvider"]},"aws-native:mediapackage:OriginEndpointDashPackage":{"description":"A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.","properties":{"adTriggers":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointDashPackageAdTriggersItem"},"description":"A list of SCTE-35 message types that are treated as ad markers in the output.  If empty, no ad markers are output.  Specify multiple items to create ad markers for all of the included message types."},"adsOnDeliveryRestrictions":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointAdsOnDeliveryRestrictions","description":"The flags on SCTE-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in AWS Elemental MediaPackage , see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html) ."},"encryption":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointDashEncryption","description":"Parameters for encrypting content."},"includeIframeOnlyStream":{"type":"boolean","description":"When enabled, an I-Frame only stream will be included in the output."},"manifestLayout":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointDashPackageManifestLayout","description":"Determines the position of some tags in the Media Presentation Description (MPD).  When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation.  When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level."},"manifestWindowSeconds":{"type":"integer","description":"Time window (in seconds) contained in each manifest."},"minBufferTimeSeconds":{"type":"integer","description":"Minimum duration (in seconds) that a player will buffer media before starting the presentation."},"minUpdatePeriodSeconds":{"type":"integer","description":"Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD)."},"periodTriggers":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointDashPackagePeriodTriggersItem"},"description":"A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains \"ADS\", new periods will be created where the Channel source contains SCTE-35 ad markers."},"profile":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointDashPackageProfile","description":"The Dynamic Adaptive Streaming over HTTP (DASH) profile type.  When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled."},"segmentDurationSeconds":{"type":"integer","description":"Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration."},"segmentTemplateFormat":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointDashPackageSegmentTemplateFormat","description":"Determines the type of SegmentTemplate included in the Media Presentation Description (MPD).  When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs.  When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs."},"streamSelection":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointStreamSelection","description":"Limitations for outputs from the endpoint, based on the video bitrate."},"suggestedPresentationDelaySeconds":{"type":"integer","description":"Duration (in seconds) to delay live content before presentation."},"utcTiming":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointDashPackageUtcTiming","description":"Determines the type of UTCTiming included in the Media Presentation Description (MPD)"},"utcTimingUri":{"type":"string","description":"Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE"}},"type":"object"},"aws-native:mediapackage:OriginEndpointDashPackageAdTriggersItem":{"type":"string","enum":[{"name":"SpliceInsert","value":"SPLICE_INSERT"},{"name":"Break","value":"BREAK"},{"name":"ProviderAdvertisement","value":"PROVIDER_ADVERTISEMENT"},{"name":"DistributorAdvertisement","value":"DISTRIBUTOR_ADVERTISEMENT"},{"name":"ProviderPlacementOpportunity","value":"PROVIDER_PLACEMENT_OPPORTUNITY"},{"name":"DistributorPlacementOpportunity","value":"DISTRIBUTOR_PLACEMENT_OPPORTUNITY"},{"name":"ProviderOverlayPlacementOpportunity","value":"PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY"},{"name":"DistributorOverlayPlacementOpportunity","value":"DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"}]},"aws-native:mediapackage:OriginEndpointDashPackageManifestLayout":{"description":"Determines the position of some tags in the Media Presentation Description (MPD).  When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation.  When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.","type":"string","enum":[{"name":"Full","value":"FULL"},{"name":"Compact","value":"COMPACT"},{"name":"DrmTopLevelCompact","value":"DRM_TOP_LEVEL_COMPACT"}]},"aws-native:mediapackage:OriginEndpointDashPackagePeriodTriggersItem":{"type":"string","enum":[{"name":"Ads","value":"ADS"}]},"aws-native:mediapackage:OriginEndpointDashPackageProfile":{"description":"The Dynamic Adaptive Streaming over HTTP (DASH) profile type.  When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Hbbtv15","value":"HBBTV_1_5"},{"name":"Hybridcast","value":"HYBRIDCAST"},{"name":"DvbDash2014","value":"DVB_DASH_2014"}]},"aws-native:mediapackage:OriginEndpointDashPackageSegmentTemplateFormat":{"description":"Determines the type of SegmentTemplate included in the Media Presentation Description (MPD).  When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs.  When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.","type":"string","enum":[{"name":"NumberWithTimeline","value":"NUMBER_WITH_TIMELINE"},{"name":"TimeWithTimeline","value":"TIME_WITH_TIMELINE"},{"name":"NumberWithDuration","value":"NUMBER_WITH_DURATION"}]},"aws-native:mediapackage:OriginEndpointDashPackageUtcTiming":{"description":"Determines the type of UTCTiming included in the Media Presentation Description (MPD)","type":"string","enum":[{"name":"HttpXsdate","value":"HTTP-XSDATE"},{"name":"HttpIso","value":"HTTP-ISO"},{"name":"HttpHead","value":"HTTP-HEAD"},{"name":"None","value":"NONE"}]},"aws-native:mediapackage:OriginEndpointEncryptionContractConfiguration":{"description":"The configuration to use for encrypting one or more content tracks separately for endpoints that use SPEKE 2.0.","properties":{"presetSpeke20Audio":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointEncryptionContractConfigurationPresetSpeke20Audio","description":"A collection of audio encryption presets."},"presetSpeke20Video":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointEncryptionContractConfigurationPresetSpeke20Video","description":"A collection of video encryption presets."}},"type":"object","required":["presetSpeke20Audio","presetSpeke20Video"]},"aws-native:mediapackage:OriginEndpointEncryptionContractConfigurationPresetSpeke20Audio":{"description":"A collection of audio encryption presets.","type":"string","enum":[{"name":"PresetAudio1","value":"PRESET-AUDIO-1"},{"name":"PresetAudio2","value":"PRESET-AUDIO-2"},{"name":"PresetAudio3","value":"PRESET-AUDIO-3"},{"name":"Shared","value":"SHARED"},{"name":"Unencrypted","value":"UNENCRYPTED"}]},"aws-native:mediapackage:OriginEndpointEncryptionContractConfigurationPresetSpeke20Video":{"description":"A collection of video encryption presets.","type":"string","enum":[{"name":"PresetVideo1","value":"PRESET-VIDEO-1"},{"name":"PresetVideo2","value":"PRESET-VIDEO-2"},{"name":"PresetVideo3","value":"PRESET-VIDEO-3"},{"name":"PresetVideo4","value":"PRESET-VIDEO-4"},{"name":"PresetVideo5","value":"PRESET-VIDEO-5"},{"name":"PresetVideo6","value":"PRESET-VIDEO-6"},{"name":"PresetVideo7","value":"PRESET-VIDEO-7"},{"name":"PresetVideo8","value":"PRESET-VIDEO-8"},{"name":"Shared","value":"SHARED"},{"name":"Unencrypted","value":"UNENCRYPTED"}]},"aws-native:mediapackage:OriginEndpointHlsEncryption":{"description":"An HTTP Live Streaming (HLS) encryption configuration.","properties":{"constantInitializationVector":{"type":"string","description":"A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated."},"encryptionMethod":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointHlsEncryptionEncryptionMethod","description":"The encryption method to use."},"keyRotationIntervalSeconds":{"type":"integer","description":"Interval (in seconds) between each encryption key rotation."},"repeatExtXKey":{"type":"boolean","description":"When enabled, the EXT-X-KEY tag will be repeated in output manifests."},"spekeKeyProvider":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointSpekeKeyProvider","description":"Parameters for the SPEKE key provider."}},"type":"object","required":["spekeKeyProvider"]},"aws-native:mediapackage:OriginEndpointHlsEncryptionEncryptionMethod":{"description":"The encryption method to use.","type":"string","enum":[{"name":"Aes128","value":"AES_128"},{"name":"SampleAes","value":"SAMPLE_AES"}]},"aws-native:mediapackage:OriginEndpointHlsManifest":{"description":"A HTTP Live Streaming (HLS) manifest configuration.","properties":{"adMarkers":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointHlsManifestAdMarkers","description":"This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0."},"adTriggers":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointHlsManifestAdTriggersItem"},"description":"A list of SCTE-35 message types that are treated as ad markers in the output.  If empty, no ad markers are output.  Specify multiple items to create ad markers for all of the included message types."},"adsOnDeliveryRestrictions":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointAdsOnDeliveryRestrictions","description":"The flags on SCTE-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in AWS Elemental MediaPackage , see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html) ."},"id":{"type":"string","description":"The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created."},"includeIframeOnlyStream":{"type":"boolean","description":"When enabled, an I-Frame only stream will be included in the output."},"manifestName":{"type":"string","description":"An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint."},"playlistType":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointHlsManifestPlaylistType","description":"The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist."},"playlistWindowSeconds":{"type":"integer","description":"Time window (in seconds) contained in each parent manifest."},"programDateTimeIntervalSeconds":{"type":"integer","description":"The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output."},"url":{"type":"string","description":"The URL of the packaged OriginEndpoint for consumption."}},"type":"object","required":["id"]},"aws-native:mediapackage:OriginEndpointHlsManifestAdMarkers":{"description":"This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Scte35Enhanced","value":"SCTE35_ENHANCED"},{"name":"Passthrough","value":"PASSTHROUGH"},{"name":"Daterange","value":"DATERANGE"}]},"aws-native:mediapackage:OriginEndpointHlsManifestAdTriggersItem":{"type":"string","enum":[{"name":"SpliceInsert","value":"SPLICE_INSERT"},{"name":"Break","value":"BREAK"},{"name":"ProviderAdvertisement","value":"PROVIDER_ADVERTISEMENT"},{"name":"DistributorAdvertisement","value":"DISTRIBUTOR_ADVERTISEMENT"},{"name":"ProviderPlacementOpportunity","value":"PROVIDER_PLACEMENT_OPPORTUNITY"},{"name":"DistributorPlacementOpportunity","value":"DISTRIBUTOR_PLACEMENT_OPPORTUNITY"},{"name":"ProviderOverlayPlacementOpportunity","value":"PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY"},{"name":"DistributorOverlayPlacementOpportunity","value":"DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"}]},"aws-native:mediapackage:OriginEndpointHlsManifestPlaylistType":{"description":"The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Event","value":"EVENT"},{"name":"Vod","value":"VOD"}]},"aws-native:mediapackage:OriginEndpointHlsPackage":{"description":"An HTTP Live Streaming (HLS) packaging configuration.","properties":{"adMarkers":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointHlsPackageAdMarkers","description":"This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0."},"adTriggers":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointHlsPackageAdTriggersItem"},"description":"A list of SCTE-35 message types that are treated as ad markers in the output.  If empty, no ad markers are output.  Specify multiple items to create ad markers for all of the included message types."},"adsOnDeliveryRestrictions":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointAdsOnDeliveryRestrictions","description":"The flags on SCTE-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in AWS Elemental MediaPackage , see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html) ."},"encryption":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointHlsEncryption","description":"Parameters for encrypting content."},"includeDvbSubtitles":{"type":"boolean","description":"When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output."},"includeIframeOnlyStream":{"type":"boolean","description":"When enabled, an I-Frame only stream will be included in the output."},"playlistType":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointHlsPackagePlaylistType","description":"The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist."},"playlistWindowSeconds":{"type":"integer","description":"Time window (in seconds) contained in each parent manifest."},"programDateTimeIntervalSeconds":{"type":"integer","description":"The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output."},"segmentDurationSeconds":{"type":"integer","description":"Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration."},"streamSelection":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointStreamSelection","description":"Limitations for outputs from the endpoint, based on the video bitrate."},"useAudioRenditionGroup":{"type":"boolean","description":"When enabled, audio streams will be placed in rendition groups in the output."}},"type":"object"},"aws-native:mediapackage:OriginEndpointHlsPackageAdMarkers":{"description":"This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source. \"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value that is greater than 0.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Scte35Enhanced","value":"SCTE35_ENHANCED"},{"name":"Passthrough","value":"PASSTHROUGH"},{"name":"Daterange","value":"DATERANGE"}]},"aws-native:mediapackage:OriginEndpointHlsPackageAdTriggersItem":{"type":"string","enum":[{"name":"SpliceInsert","value":"SPLICE_INSERT"},{"name":"Break","value":"BREAK"},{"name":"ProviderAdvertisement","value":"PROVIDER_ADVERTISEMENT"},{"name":"DistributorAdvertisement","value":"DISTRIBUTOR_ADVERTISEMENT"},{"name":"ProviderPlacementOpportunity","value":"PROVIDER_PLACEMENT_OPPORTUNITY"},{"name":"DistributorPlacementOpportunity","value":"DISTRIBUTOR_PLACEMENT_OPPORTUNITY"},{"name":"ProviderOverlayPlacementOpportunity","value":"PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY"},{"name":"DistributorOverlayPlacementOpportunity","value":"DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"}]},"aws-native:mediapackage:OriginEndpointHlsPackagePlaylistType":{"description":"The HTTP Live Streaming (HLS) playlist type. When either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Event","value":"EVENT"},{"name":"Vod","value":"VOD"}]},"aws-native:mediapackage:OriginEndpointMssEncryption":{"description":"A Microsoft Smooth Streaming (MSS) encryption configuration.","properties":{"spekeKeyProvider":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointSpekeKeyProvider","description":"Parameters for the SPEKE key provider."}},"type":"object","required":["spekeKeyProvider"]},"aws-native:mediapackage:OriginEndpointMssPackage":{"description":"A Microsoft Smooth Streaming (MSS) packaging configuration.","properties":{"encryption":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointMssEncryption","description":"Parameters for encrypting content."},"manifestWindowSeconds":{"type":"integer","description":"The time window (in seconds) contained in each manifest."},"segmentDurationSeconds":{"type":"integer","description":"The duration (in seconds) of each segment."},"streamSelection":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointStreamSelection","description":"Limitations for outputs from the endpoint, based on the video bitrate."}},"type":"object"},"aws-native:mediapackage:OriginEndpointOrigination":{"description":"Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination","type":"string","enum":[{"name":"Allow","value":"ALLOW"},{"name":"Deny","value":"DENY"}]},"aws-native:mediapackage:OriginEndpointSpekeKeyProvider":{"description":"A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.","properties":{"certificateArn":{"type":"string","description":"An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service."},"encryptionContractConfiguration":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointEncryptionContractConfiguration","description":"Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use."},"resourceId":{"type":"string","description":"The resource ID to include in key requests."},"roleArn":{"type":"string","description":"An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service."},"systemIds":{"type":"array","items":{"type":"string"},"description":"The system IDs to include in key requests."},"url":{"type":"string","description":"The URL of the external key provider service."}},"type":"object","required":["resourceId","roleArn","systemIds","url"]},"aws-native:mediapackage:OriginEndpointStreamSelection":{"description":"A StreamSelection configuration.","properties":{"maxVideoBitsPerSecond":{"type":"integer","description":"The maximum video bitrate (bps) to include in output."},"minVideoBitsPerSecond":{"type":"integer","description":"The minimum video bitrate (bps) to include in output."},"streamOrder":{"$ref":"#/types/aws-native:mediapackage:OriginEndpointStreamSelectionStreamOrder","description":"A directive that determines the order of streams in the output."}},"type":"object"},"aws-native:mediapackage:OriginEndpointStreamSelectionStreamOrder":{"description":"A directive that determines the order of streams in the output.","type":"string","enum":[{"name":"Original","value":"ORIGINAL"},{"name":"VideoBitrateAscending","value":"VIDEO_BITRATE_ASCENDING"},{"name":"VideoBitrateDescending","value":"VIDEO_BITRATE_DESCENDING"}]},"aws-native:mediapackage:OriginEndpointTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:mediapackage:PackagingConfigurationCmafEncryption":{"description":"A CMAF encryption configuration.","properties":{"spekeKeyProvider":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationSpekeKeyProvider","description":"Parameters for the SPEKE key provider."}},"type":"object","required":["spekeKeyProvider"]},"aws-native:mediapackage:PackagingConfigurationCmafPackage":{"description":"A CMAF packaging configuration.","properties":{"encryption":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationCmafEncryption","description":"Parameters for encrypting content."},"hlsManifests":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationHlsManifest"},"description":"A list of HLS manifest configurations."},"includeEncoderConfigurationInSegments":{"type":"boolean","description":"When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback."},"segmentDurationSeconds":{"type":"integer","description":"Duration (in seconds) of each segment. Actual segments are rounded to the nearest multiple of the source fragment duration."}},"type":"object","required":["hlsManifests"]},"aws-native:mediapackage:PackagingConfigurationDashEncryption":{"description":"A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.","properties":{"spekeKeyProvider":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationSpekeKeyProvider","description":"Parameters for the SPEKE key provider."}},"type":"object","required":["spekeKeyProvider"]},"aws-native:mediapackage:PackagingConfigurationDashManifest":{"description":"A DASH manifest configuration.","properties":{"manifestLayout":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationDashManifestManifestLayout","description":"Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level."},"manifestName":{"type":"string","description":"A short string that's appended to the end of the endpoint URL to create a unique path to this packaging configuration."},"minBufferTimeSeconds":{"type":"integer","description":"Minimum duration (in seconds) that a player will buffer media before starting the presentation."},"profile":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationDashManifestProfile","description":"The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled."},"scteMarkersSource":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationDashManifestScteMarkersSource","description":"The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content."},"streamSelection":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationStreamSelection","description":"Limitations for outputs from the endpoint, based on the video bitrate."}},"type":"object"},"aws-native:mediapackage:PackagingConfigurationDashManifestManifestLayout":{"description":"Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.","type":"string","enum":[{"name":"Full","value":"FULL"},{"name":"Compact","value":"COMPACT"}]},"aws-native:mediapackage:PackagingConfigurationDashManifestProfile":{"description":"The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Hbbtv15","value":"HBBTV_1_5"}]},"aws-native:mediapackage:PackagingConfigurationDashManifestScteMarkersSource":{"description":"The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content.","type":"string","enum":[{"name":"Segments","value":"SEGMENTS"},{"name":"Manifest","value":"MANIFEST"}]},"aws-native:mediapackage:PackagingConfigurationDashPackage":{"description":"A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.","properties":{"dashManifests":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationDashManifest"},"description":"A list of DASH manifest configurations."},"encryption":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationDashEncryption","description":"Parameters for encrypting content."},"includeEncoderConfigurationInSegments":{"type":"boolean","description":"When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback."},"includeIframeOnlyStream":{"type":"boolean","description":"When enabled, an I-Frame only stream will be included in the output."},"periodTriggers":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationDashPackagePeriodTriggersItem"},"description":"A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains \"ADS\", new periods will be created where the Asset contains SCTE-35 ad markers."},"segmentDurationSeconds":{"type":"integer","description":"Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source segment duration."},"segmentTemplateFormat":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationDashPackageSegmentTemplateFormat","description":"Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs."}},"type":"object","required":["dashManifests"]},"aws-native:mediapackage:PackagingConfigurationDashPackagePeriodTriggersItem":{"type":"string","enum":[{"name":"Ads","value":"ADS"}]},"aws-native:mediapackage:PackagingConfigurationDashPackageSegmentTemplateFormat":{"description":"Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.","type":"string","enum":[{"name":"NumberWithTimeline","value":"NUMBER_WITH_TIMELINE"},{"name":"TimeWithTimeline","value":"TIME_WITH_TIMELINE"},{"name":"NumberWithDuration","value":"NUMBER_WITH_DURATION"}]},"aws-native:mediapackage:PackagingConfigurationEncryptionContractConfiguration":{"description":"The configuration to use for encrypting one or more content tracks separately for endpoints that use SPEKE 2.0.","properties":{"presetSpeke20Audio":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationEncryptionContractConfigurationPresetSpeke20Audio","description":"A collection of audio encryption presets."},"presetSpeke20Video":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationEncryptionContractConfigurationPresetSpeke20Video","description":"A collection of video encryption presets."}},"type":"object","required":["presetSpeke20Audio","presetSpeke20Video"]},"aws-native:mediapackage:PackagingConfigurationEncryptionContractConfigurationPresetSpeke20Audio":{"description":"A collection of audio encryption presets.","type":"string","enum":[{"name":"PresetAudio1","value":"PRESET-AUDIO-1"},{"name":"PresetAudio2","value":"PRESET-AUDIO-2"},{"name":"PresetAudio3","value":"PRESET-AUDIO-3"},{"name":"Shared","value":"SHARED"},{"name":"Unencrypted","value":"UNENCRYPTED"}]},"aws-native:mediapackage:PackagingConfigurationEncryptionContractConfigurationPresetSpeke20Video":{"description":"A collection of video encryption presets.","type":"string","enum":[{"name":"PresetVideo1","value":"PRESET-VIDEO-1"},{"name":"PresetVideo2","value":"PRESET-VIDEO-2"},{"name":"PresetVideo3","value":"PRESET-VIDEO-3"},{"name":"PresetVideo4","value":"PRESET-VIDEO-4"},{"name":"PresetVideo5","value":"PRESET-VIDEO-5"},{"name":"PresetVideo6","value":"PRESET-VIDEO-6"},{"name":"PresetVideo7","value":"PRESET-VIDEO-7"},{"name":"PresetVideo8","value":"PRESET-VIDEO-8"},{"name":"Shared","value":"SHARED"},{"name":"Unencrypted","value":"UNENCRYPTED"}]},"aws-native:mediapackage:PackagingConfigurationHlsEncryption":{"description":"An HTTP Live Streaming (HLS) encryption configuration.","properties":{"constantInitializationVector":{"type":"string","description":"An HTTP Live Streaming (HLS) encryption configuration."},"encryptionMethod":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationHlsEncryptionEncryptionMethod","description":"The encryption method to use."},"spekeKeyProvider":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationSpekeKeyProvider","description":"Parameters for the SPEKE key provider."}},"type":"object","required":["spekeKeyProvider"]},"aws-native:mediapackage:PackagingConfigurationHlsEncryptionEncryptionMethod":{"description":"The encryption method to use.","type":"string","enum":[{"name":"Aes128","value":"AES_128"},{"name":"SampleAes","value":"SAMPLE_AES"}]},"aws-native:mediapackage:PackagingConfigurationHlsManifest":{"description":"An HTTP Live Streaming (HLS) manifest configuration.","properties":{"adMarkers":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationHlsManifestAdMarkers","description":"This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source."},"includeIframeOnlyStream":{"type":"boolean","description":"When enabled, an I-Frame only stream will be included in the output."},"manifestName":{"type":"string","description":"A short string that's appended to the end of the endpoint URL to create a unique path to this packaging configuration."},"programDateTimeIntervalSeconds":{"type":"integer","description":"The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output."},"repeatExtXKey":{"type":"boolean","description":"When enabled, the EXT-X-KEY tag will be repeated in output manifests."},"streamSelection":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationStreamSelection","description":"Video bitrate limitations for outputs from this packaging configuration."}},"type":"object"},"aws-native:mediapackage:PackagingConfigurationHlsManifestAdMarkers":{"description":"This setting controls how ad markers are included in the packaged OriginEndpoint. \"NONE\" will omit all SCTE-35 ad markers from the output. \"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. \"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35 messages in the input source.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Scte35Enhanced","value":"SCTE35_ENHANCED"},{"name":"Passthrough","value":"PASSTHROUGH"}]},"aws-native:mediapackage:PackagingConfigurationHlsPackage":{"description":"An HTTP Live Streaming (HLS) packaging configuration.","properties":{"encryption":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationHlsEncryption","description":"Parameters for encrypting content."},"hlsManifests":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationHlsManifest"},"description":"A list of HLS manifest configurations."},"includeDvbSubtitles":{"type":"boolean","description":"When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output."},"segmentDurationSeconds":{"type":"integer","description":"Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration."},"useAudioRenditionGroup":{"type":"boolean","description":"When enabled, audio streams will be placed in rendition groups in the output."}},"type":"object","required":["hlsManifests"]},"aws-native:mediapackage:PackagingConfigurationMssEncryption":{"description":"A CMAF encryption configuration.","properties":{"spekeKeyProvider":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationSpekeKeyProvider","description":"Parameters for the SPEKE key provider."}},"type":"object","required":["spekeKeyProvider"]},"aws-native:mediapackage:PackagingConfigurationMssManifest":{"description":"A Microsoft Smooth Streaming (MSS) manifest configuration.","properties":{"manifestName":{"type":"string","description":"A short string that's appended to the end of the endpoint URL to create a unique path to this packaging configuration."},"streamSelection":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationStreamSelection","description":"Video bitrate limitations for outputs from this packaging configuration."}},"type":"object"},"aws-native:mediapackage:PackagingConfigurationMssPackage":{"description":"A Microsoft Smooth Streaming (MSS) PackagingConfiguration.","properties":{"encryption":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationMssEncryption","description":"Parameters for encrypting content."},"mssManifests":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationMssManifest"},"description":"A list of MSS manifest configurations."},"segmentDurationSeconds":{"type":"integer","description":"Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration."}},"type":"object","required":["mssManifests"]},"aws-native:mediapackage:PackagingConfigurationSpekeKeyProvider":{"description":"A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.","properties":{"encryptionContractConfiguration":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationEncryptionContractConfiguration","description":"Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use."},"roleArn":{"type":"string","description":"The ARN for the IAM role that's granted by the key provider to provide access to the key provider API. Valid format: arn:aws:iam::{accountID}:role/{name}"},"systemIds":{"type":"array","items":{"type":"string"},"description":"The system IDs to include in key requests."},"url":{"type":"string","description":"The URL of the external key provider service."}},"type":"object","required":["roleArn","systemIds","url"]},"aws-native:mediapackage:PackagingConfigurationStreamSelection":{"description":"A StreamSelection configuration.","properties":{"maxVideoBitsPerSecond":{"type":"integer","description":"The maximum video bitrate (bps) to include in output."},"minVideoBitsPerSecond":{"type":"integer","description":"The minimum video bitrate (bps) to include in output."},"streamOrder":{"$ref":"#/types/aws-native:mediapackage:PackagingConfigurationStreamSelectionStreamOrder","description":"A directive that determines the order of streams in the output."}},"type":"object"},"aws-native:mediapackage:PackagingConfigurationStreamSelectionStreamOrder":{"description":"A directive that determines the order of streams in the output.","type":"string","enum":[{"name":"Original","value":"ORIGINAL"},{"name":"VideoBitrateAscending","value":"VIDEO_BITRATE_ASCENDING"},{"name":"VideoBitrateDescending","value":"VIDEO_BITRATE_DESCENDING"}]},"aws-native:mediapackage:PackagingConfigurationTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:mediapackage:PackagingGroupAuthorization":{"properties":{"cdnIdentifierSecret":{"type":"string","description":"The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization."},"secretsRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager."}},"type":"object","required":["cdnIdentifierSecret","secretsRoleArn"]},"aws-native:mediapackage:PackagingGroupLogConfiguration":{"properties":{"logGroupName":{"type":"string","description":"Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: /aws/MediaPackage/VodEgressAccessLogs."}},"type":"object"},"aws-native:mediapackage:PackagingGroupTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:mediapackagev2:ChannelGroupTag":{"properties":{"key":{"type":"string","description":"The key in the key:value pair for the tag."},"value":{"type":"string","description":"The value in the key:value pair for the tag."}},"type":"object"},"aws-native:mediapackagev2:ChannelIngestEndpoint":{"description":"\u003cp\u003eThe ingest domain URL where the source stream should be sent.\u003c/p\u003e","properties":{"id":{"type":"string","description":"\u003cp\u003eThe system-generated unique identifier for the IngestEndpoint.\u003c/p\u003e"},"url":{"type":"string","description":"\u003cp\u003eThe ingest domain URL where the source stream should be sent.\u003c/p\u003e"}},"type":"object"},"aws-native:mediapackagev2:ChannelInputSwitchConfiguration":{"description":"\u003cp\u003eThe configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.\u003c/p\u003e","properties":{"mqcsInputSwitching":{"type":"boolean","description":"\u003cp\u003eWhen true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is true. This setting is valid only when \u003ccode\u003eInputType\u003c/code\u003e is \u003ccode\u003eCMAF\u003c/code\u003e.\u003c/p\u003e"},"preferredInput":{"type":"integer","description":"For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select `1` to prefer the first ingest endpoint, or `2` to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal."}},"type":"object"},"aws-native:mediapackagev2:ChannelInputType":{"type":"string","enum":[{"name":"Hls","value":"HLS"},{"name":"Cmaf","value":"CMAF"}]},"aws-native:mediapackagev2:ChannelOutputHeaderConfiguration":{"description":"\u003cp\u003eThe settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.\u003c/p\u003e","properties":{"publishMqcs":{"type":"boolean","description":"\u003cp\u003eWhen true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when \u003ccode\u003eInputType\u003c/code\u003e is \u003ccode\u003eCMAF\u003c/code\u003e.\u003c/p\u003e"}},"type":"object"},"aws-native:mediapackagev2:ChannelTag":{"properties":{"key":{"type":"string","description":"The key in the key:value pair for the tag."},"value":{"type":"string","description":"The value in the key:value pair for the tag."}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointAdMarkerDash":{"type":"string","enum":[{"name":"Binary","value":"BINARY"},{"name":"Xml","value":"XML"}]},"aws-native:mediapackagev2:OriginEndpointAdMarkerHls":{"type":"string","enum":[{"name":"Daterange","value":"DATERANGE"},{"name":"Scte35Enhanced","value":"SCTE35_ENHANCED"}]},"aws-native:mediapackagev2:OriginEndpointCmafEncryptionMethod":{"type":"string","enum":[{"name":"Cenc","value":"CENC"},{"name":"Cbcs","value":"CBCS"}]},"aws-native:mediapackagev2:OriginEndpointContainerType":{"type":"string","enum":[{"name":"Ts","value":"TS"},{"name":"Cmaf","value":"CMAF"},{"name":"Ism","value":"ISM"}]},"aws-native:mediapackagev2:OriginEndpointDashBaseUrl":{"description":"\u003cp\u003eThe base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli-CDN workflows.\u003c/p\u003e","properties":{"dvbPriority":{"type":"integer","description":"\u003cp\u003eFor use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority.\u003c/p\u003e"},"dvbWeight":{"type":"integer","description":"\u003cp\u003eFor use with DVB-DASH profiles only. The weighting for source locations that have the same priority. \u003c/p\u003e"},"serviceLocation":{"type":"string","description":"\u003cp\u003eThe name of the source location.\u003c/p\u003e"},"url":{"type":"string","description":"\u003cp\u003eA source location for segments.\u003c/p\u003e"}},"type":"object","required":["url"]},"aws-native:mediapackagev2:OriginEndpointDashCompactness":{"type":"string","enum":[{"name":"Standard","value":"STANDARD"},{"name":"None","value":"NONE"}]},"aws-native:mediapackagev2:OriginEndpointDashDrmSignaling":{"type":"string","enum":[{"name":"Individual","value":"INDIVIDUAL"},{"name":"Referenced","value":"REFERENCED"}]},"aws-native:mediapackagev2:OriginEndpointDashDvbFontDownload":{"description":"\u003cp\u003eFor use with DVB-DASH profiles only. The settings for font downloads that you want Elemental MediaPackage to pass through to the manifest.\u003c/p\u003e","properties":{"fontFamily":{"type":"string","description":"\u003cp\u003eThe \u003ccode\u003efontFamily\u003c/code\u003e name for subtitles, as described in \u003ca href=\"https://tech.ebu.ch/publications/tech3380\"\u003eEBU-TT-D Subtitling Distribution Format\u003c/a\u003e. \u003c/p\u003e"},"mimeType":{"type":"string","description":"\u003cp\u003eThe \u003ccode\u003emimeType\u003c/code\u003e of the resource that's at the font download URL.\u003c/p\u003e \u003cp\u003eFor information about font MIME types, see the \u003ca href=\"https://dvb.org/wp-content/uploads/2021/06/A168r4_MPEG-DASH-Profile-for-Transport-of-ISO-BMFF-Based-DVB-Services_Draft-ts_103-285-v140_November_2021.pdf\"\u003eMPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks\u003c/a\u003e document. \u003c/p\u003e"},"url":{"type":"string","description":"\u003cp\u003eThe URL for downloading fonts for subtitles.\u003c/p\u003e"}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointDashDvbMetricsReporting":{"description":"\u003cp\u003eFor use with DVB-DASH profiles only. The settings for error reporting from the playback device that you want Elemental MediaPackage to pass through to the manifest.\u003c/p\u003e","properties":{"probability":{"type":"integer","description":"\u003cp\u003eThe number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session.\u003c/p\u003e"},"reportingUrl":{"type":"string","description":"\u003cp\u003eThe URL where playback devices send error reports.\u003c/p\u003e"}},"type":"object","required":["reportingUrl"]},"aws-native:mediapackagev2:OriginEndpointDashDvbSettings":{"description":"\u003cp\u003eFor endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.\u003c/p\u003e","properties":{"errorMetrics":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashDvbMetricsReporting"},"description":"\u003cp\u003ePlayback device error reporting settings.\u003c/p\u003e"},"fontDownload":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashDvbFontDownload","description":"Subtitle font settings."}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointDashManifestConfiguration":{"description":"\u003cp\u003eRetrieve the DASH manifest configuration.\u003c/p\u003e","properties":{"baseUrls":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashBaseUrl"},"description":"\u003cp\u003eThe base URL to use for retrieving segments.\u003c/p\u003e"},"compactness":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashCompactness","description":"The layout of the DASH manifest that MediaPackage produces. `STANDARD` indicates a default manifest, which is compacted. `NONE` indicates a full manifest.\n\nFor information about compactness, see [DASH manifest compactness](https://docs.aws.amazon.com/mediapackage/latest/userguide/compacted.html) in the *AWS Elemental MediaPackage v2 User Guide* ."},"drmSignaling":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashDrmSignaling","description":"Determines how the DASH manifest signals the DRM content."},"dvbSettings":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashDvbSettings","description":"For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest."},"filterConfiguration":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointFilterConfiguration","description":"Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest."},"manifestName":{"type":"string","description":"\u003cp\u003eA short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. \u003c/p\u003e"},"manifestWindowSeconds":{"type":"integer","description":"\u003cp\u003eThe total duration (in seconds) of the manifest's content.\u003c/p\u003e"},"minBufferTimeSeconds":{"type":"integer","description":"\u003cp\u003eMinimum amount of content (in seconds) that a player must keep available in the buffer.\u003c/p\u003e"},"minUpdatePeriodSeconds":{"type":"integer","description":"\u003cp\u003eMinimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.\u003c/p\u003e"},"periodTriggers":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashPeriodTrigger"},"description":"\u003cp\u003eA list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see \u003ca href=\"https://docs.aws.amazon.com/mediapackage/latest/userguide/multi-period.html\"\u003eMulti-period DASH in AWS Elemental MediaPackage\u003c/a\u003e.\u003c/p\u003e"},"profiles":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashProfile"},"description":"\u003cp\u003eThe profile that the output is compliant with.\u003c/p\u003e"},"programInformation":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashProgramInformation","description":"Details about the content that you want MediaPackage to pass through in the manifest to the playback device."},"scteDash":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointScteDash","description":"The SCTE configuration."},"segmentTemplateFormat":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashSegmentTemplateFormat","description":"Determines the type of variable used in the `media` URL of the `SegmentTemplate` tag in the manifest. Also specifies if segment timeline information is included in `SegmentTimeline` or `SegmentTemplate` .\n\nValue description:\n\n- `NUMBER_WITH_TIMELINE` - The `$Number$` variable is used in the `media` URL. The value of this variable is the sequential number of the segment. A full `SegmentTimeline` object is presented in each `SegmentTemplate` ."},"subtitleConfiguration":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashSubtitleConfiguration","description":"The configuration for DASH subtitles."},"suggestedPresentationDelaySeconds":{"type":"integer","description":"\u003cp\u003eThe amount of time (in seconds) that the player should be from the end of the manifest.\u003c/p\u003e"},"utcTiming":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashUtcTiming","description":"Determines the type of UTC timing included in the DASH Media Presentation Description (MPD)."}},"type":"object","required":["manifestName"]},"aws-native:mediapackagev2:OriginEndpointDashPeriodTrigger":{"type":"string","enum":[{"name":"Avails","value":"AVAILS"},{"name":"DrmKeyRotation","value":"DRM_KEY_ROTATION"},{"name":"SourceChanges","value":"SOURCE_CHANGES"},{"name":"SourceDisruptions","value":"SOURCE_DISRUPTIONS"},{"name":"None","value":"NONE"}]},"aws-native:mediapackagev2:OriginEndpointDashProfile":{"type":"string","enum":[{"name":"DvbDash","value":"DVB_DASH"}]},"aws-native:mediapackagev2:OriginEndpointDashProgramInformation":{"description":"\u003cp\u003eDetails about the content that you want MediaPackage to pass through in the manifest to the playback device.\u003c/p\u003e","properties":{"copyright":{"type":"string","description":"\u003cp\u003eA copyright statement about the content.\u003c/p\u003e"},"languageCode":{"type":"string","description":"\u003cp\u003eThe language code for this manifest.\u003c/p\u003e"},"moreInformationUrl":{"type":"string","description":"\u003cp\u003eAn absolute URL that contains more information about this content.\u003c/p\u003e"},"source":{"type":"string","description":"\u003cp\u003eInformation about the content provider.\u003c/p\u003e"},"title":{"type":"string","description":"\u003cp\u003eThe title for the manifest.\u003c/p\u003e"}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointDashSegmentTemplateFormat":{"type":"string","enum":[{"name":"NumberWithTimeline","value":"NUMBER_WITH_TIMELINE"}]},"aws-native:mediapackagev2:OriginEndpointDashSubtitleConfiguration":{"description":"\u003cp\u003eThe configuration for DASH subtitles.\u003c/p\u003e","properties":{"ttmlConfiguration":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashTtmlConfiguration","description":"Settings for TTML subtitles."}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointDashTtmlConfiguration":{"description":"\u003cp\u003eThe settings for TTML subtitles.\u003c/p\u003e","properties":{"ttmlProfile":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashTtmlProfile","description":"The profile that MediaPackage uses when signaling subtitles in the manifest. `IMSC` is the default profile. `EBU-TT-D` produces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see [EBU-TT-D Subtitling Distribution Format](https://docs.aws.amazon.com/https://tech.ebu.ch/publications/tech3380) ."}},"type":"object","required":["ttmlProfile"]},"aws-native:mediapackagev2:OriginEndpointDashTtmlProfile":{"type":"string","enum":[{"name":"Imsc1","value":"IMSC_1"},{"name":"EbuTtD101","value":"EBU_TT_D_101"}]},"aws-native:mediapackagev2:OriginEndpointDashUtcTiming":{"description":"\u003cp\u003eDetermines the type of UTC timing included in the DASH Media Presentation Description (MPD).\u003c/p\u003e","properties":{"timingMode":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDashUtcTimingMode","description":"The UTC timing mode."},"timingSource":{"type":"string","description":"\u003cp\u003eThe the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.\u003c/p\u003e"}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointDashUtcTimingMode":{"type":"string","enum":[{"name":"HttpHead","value":"HTTP_HEAD"},{"name":"HttpIso","value":"HTTP_ISO"},{"name":"HttpXsdate","value":"HTTP_XSDATE"},{"name":"UtcDirect","value":"UTC_DIRECT"}]},"aws-native:mediapackagev2:OriginEndpointDrmSystem":{"type":"string","enum":[{"name":"ClearKeyAes128","value":"CLEAR_KEY_AES_128"},{"name":"Fairplay","value":"FAIRPLAY"},{"name":"Playready","value":"PLAYREADY"},{"name":"Widevine","value":"WIDEVINE"},{"name":"Irdeto","value":"IRDETO"}]},"aws-native:mediapackagev2:OriginEndpointEncryption":{"description":"\u003cp\u003eThe parameters for encrypting content.\u003c/p\u003e","properties":{"cmafExcludeSegmentDrmMetadata":{"type":"boolean","description":"\u003cp\u003eExcludes SEIG and SGPD boxes from segment metadata in CMAF containers.\u003c/p\u003e \u003cp\u003eWhen set to \u003ccode\u003etrue\u003c/code\u003e, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.\u003c/p\u003e \u003cp\u003eImportant considerations:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThis setting only affects CMAF container formats\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eKey rotation can still be handled through media playlist signaling\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003ePSSH and TENC boxes remain unaffected\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eDefault behavior is preserved when this setting is disabled\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eValid values: \u003ccode\u003etrue\u003c/code\u003e | \u003ccode\u003efalse\u003c/code\u003e \u003c/p\u003e \u003cp\u003eDefault: \u003ccode\u003efalse\u003c/code\u003e \u003c/p\u003e"},"constantInitializationVector":{"type":"string","description":"\u003cp\u003eA 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).\u003c/p\u003e"},"encryptionMethod":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointEncryptionMethod","description":"The encryption method to use."},"keyRotationIntervalSeconds":{"type":"integer","description":"\u003cp\u003eThe frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.\u003c/p\u003e \u003cp\u003eThe following example setting causes the service to rotate keys every thirty minutes: \u003ccode\u003e1800\u003c/code\u003e \u003c/p\u003e"},"spekeKeyProvider":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointSpekeKeyProvider","description":"The SPEKE key provider to use for encryption."}},"type":"object","required":["encryptionMethod","spekeKeyProvider"]},"aws-native:mediapackagev2:OriginEndpointEncryptionContractConfiguration":{"description":"\u003cp\u003eConfigure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.\u003c/p\u003e","properties":{"presetSpeke20Audio":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointPresetSpeke20Audio","description":"A collection of audio encryption presets.\n\nValue description:\n\n- `PRESET-AUDIO-1` - Use one content key to encrypt all of the audio tracks in your stream.\n- `PRESET-AUDIO-2` - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.\n- `PRESET-AUDIO-3` - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.\n- `SHARED` - Use the same content key for all of the audio and video tracks in your stream.\n- `UNENCRYPTED` - Don't encrypt any of the audio tracks in your stream."},"presetSpeke20Video":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointPresetSpeke20Video","description":"The SPEKE Version 2.0 preset video associated with the encryption contract configuration of the origin endpoint.\n\nA collection of video encryption presets.\n\nValue description:\n\n- `PRESET-VIDEO-1` - Use one content key to encrypt all of the video tracks in your stream.\n- `PRESET-VIDEO-2` - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.\n- `PRESET-VIDEO-3` - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.\n- `PRESET-VIDEO-4` - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.\n- `PRESET-VIDEO-5` - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.\n- `PRESET-VIDEO-6` - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.\n- `PRESET-VIDEO-7` - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.\n- `PRESET-VIDEO-8` - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.\n- `SHARED` - Use the same content key for all of the video and audio tracks in your stream.\n- `UNENCRYPTED` - Don't encrypt any of the video tracks in your stream."}},"type":"object","required":["presetSpeke20Audio","presetSpeke20Video"]},"aws-native:mediapackagev2:OriginEndpointEncryptionMethod":{"description":"\u003cp\u003eThe encryption type.\u003c/p\u003e","properties":{"cmafEncryptionMethod":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointCmafEncryptionMethod","description":"The encryption method to use."},"ismEncryptionMethod":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointIsmEncryptionMethod","description":"The encryption method used for Microsoft Smooth Streaming (MSS) content. This specifies how the MSS segments are encrypted to protect the content during delivery to client players."},"tsEncryptionMethod":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointTsEncryptionMethod","description":"The encryption method to use."}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointEndpointErrorCondition":{"type":"string","enum":[{"name":"StaleManifest","value":"STALE_MANIFEST"},{"name":"IncompleteManifest","value":"INCOMPLETE_MANIFEST"},{"name":"MissingDrmKey","value":"MISSING_DRM_KEY"},{"name":"SlateInput","value":"SLATE_INPUT"}]},"aws-native:mediapackagev2:OriginEndpointFilterConfiguration":{"description":"\u003cp\u003eFilter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. \u003c/p\u003e","properties":{"clipStartTime":{"type":"string","description":"\u003cp\u003eOptionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL.\u003c/p\u003e"},"drmSettings":{"type":"string","description":"\u003cp\u003eOptionally specify one or more DRM settings for all of your manifest egress requests. When you include a DRM setting, note that you cannot use an identical DRM setting query parameter for this manifest's endpoint URL.\u003c/p\u003e"},"end":{"type":"string","description":"\u003cp\u003eOptionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.\u003c/p\u003e"},"manifestFilter":{"type":"string","description":"\u003cp\u003eOptionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.\u003c/p\u003e"},"start":{"type":"string","description":"\u003cp\u003eOptionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.\u003c/p\u003e"},"timeDelaySeconds":{"type":"integer","description":"\u003cp\u003eOptionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.\u003c/p\u003e"}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointForceEndpointErrorConfiguration":{"description":"\u003cp\u003eThe failover settings for the endpoint.\u003c/p\u003e","properties":{"endpointErrorConditions":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointEndpointErrorCondition"},"description":"\u003cp\u003eThe failover conditions for the endpoint. The options are:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eSTALE_MANIFEST\u003c/code\u003e - The manifest stalled and there are no new segments or parts.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eINCOMPLETE_MANIFEST\u003c/code\u003e - There is a gap in the manifest.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eMISSING_DRM_KEY\u003c/code\u003e - Key rotation is enabled but we're unable to fetch the key for the current key period.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eSLATE_INPUT\u003c/code\u003e - The segments which contain slate content are considered to be missing content.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e"}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointHlsManifestConfiguration":{"description":"\u003cp\u003eRetrieve the HTTP live streaming (HLS) manifest configuration.\u003c/p\u003e","properties":{"childManifestName":{"type":"string","description":"\u003cp\u003eA short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.\u003c/p\u003e"},"filterConfiguration":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointFilterConfiguration","description":"Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest."},"manifestName":{"type":"string","description":"\u003cp\u003eA short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.\u003c/p\u003e"},"manifestWindowSeconds":{"type":"integer","description":"\u003cp\u003eThe total duration (in seconds) of the manifest's content.\u003c/p\u003e"},"programDateTimeIntervalSeconds":{"type":"integer","description":"\u003cp\u003eInserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.\u003c/p\u003e \u003cp\u003eIrrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.\u003c/p\u003e"},"scteHls":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointScteHls","description":"THE SCTE-35 HLS configuration associated with the HLS manifest configuration."},"startTag":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointStartTag","description":"To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag."},"url":{"type":"string","description":"\u003cp\u003eThe egress domain URL for stream delivery from MediaPackage.\u003c/p\u003e"},"urlEncodeChildManifest":{"type":"boolean","description":"\u003cp\u003eWhen enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see \u003ca href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html\"\u003eAmazon Web Services Signature Version 4 for API requests\u003c/a\u003e in \u003ci\u003eIdentity and Access Management User Guide\u003c/i\u003e.\u003c/p\u003e"}},"type":"object","required":["manifestName"]},"aws-native:mediapackagev2:OriginEndpointIsmEncryptionMethod":{"type":"string","enum":[{"name":"Cenc","value":"CENC"}]},"aws-native:mediapackagev2:OriginEndpointLowLatencyHlsManifestConfiguration":{"description":"\u003cp\u003eRetrieve the low-latency HTTP live streaming (HLS) manifest configuration.\u003c/p\u003e","properties":{"childManifestName":{"type":"string","description":"\u003cp\u003eA short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.\u003c/p\u003e"},"filterConfiguration":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointFilterConfiguration","description":"Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest."},"manifestName":{"type":"string","description":"\u003cp\u003eA short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.\u003c/p\u003e"},"manifestWindowSeconds":{"type":"integer","description":"\u003cp\u003eThe total duration (in seconds) of the manifest's content.\u003c/p\u003e"},"programDateTimeIntervalSeconds":{"type":"integer","description":"\u003cp\u003eInserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.\u003c/p\u003e \u003cp\u003eIrrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.\u003c/p\u003e"},"scteHls":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointScteHls","description":"The SCTE-35 HLS configuration associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint."},"startTag":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointStartTag","description":"To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag."},"url":{"type":"string","description":"\u003cp\u003eThe egress domain URL for stream delivery from MediaPackage.\u003c/p\u003e"},"urlEncodeChildManifest":{"type":"boolean","description":"\u003cp\u003eWhen enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see \u003ca href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html\"\u003eAmazon Web Services Signature Version 4 for API requests\u003c/a\u003e in \u003ci\u003eIdentity and Access Management User Guide\u003c/i\u003e.\u003c/p\u003e"}},"type":"object","required":["manifestName"]},"aws-native:mediapackagev2:OriginEndpointMssManifestConfiguration":{"description":"\u003cp\u003eConfiguration details for a Microsoft Smooth Streaming (MSS) manifest associated with an origin endpoint. This includes all the settings and properties that define how the MSS content is packaged and delivered.\u003c/p\u003e","properties":{"filterConfiguration":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointFilterConfiguration"},"manifestLayout":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointMssManifestLayout"},"manifestName":{"type":"string","description":"\u003cp\u003eThe name of the MSS manifest. This name is appended to the origin endpoint URL to create the unique path for accessing this specific MSS manifest.\u003c/p\u003e"},"manifestWindowSeconds":{"type":"integer","description":"\u003cp\u003eThe duration (in seconds) of the manifest window. This represents the total amount of content available in the manifest at any given time.\u003c/p\u003e"}},"type":"object","required":["manifestName"]},"aws-native:mediapackagev2:OriginEndpointMssManifestLayout":{"type":"string","enum":[{"name":"Full","value":"FULL"},{"name":"Compact","value":"COMPACT"}]},"aws-native:mediapackagev2:OriginEndpointPolicyCdnAuthConfiguration":{"properties":{"cdnIdentifierSecretArns":{"type":"array","items":{"type":"string"},"description":"The ARN for the secret in Secrets Manager that your CDN uses for authorization to access the endpoint."},"secretsRoleArn":{"type":"string","description":"The ARN for the IAM role that gives MediaPackage read access to Secrets Manager and AWS  for CDN authorization."}},"type":"object","required":["cdnIdentifierSecretArns","secretsRoleArn"]},"aws-native:mediapackagev2:OriginEndpointPresetSpeke20Audio":{"type":"string","enum":[{"name":"PresetAudio1","value":"PRESET_AUDIO_1"},{"name":"PresetAudio2","value":"PRESET_AUDIO_2"},{"name":"PresetAudio3","value":"PRESET_AUDIO_3"},{"name":"Shared","value":"SHARED"},{"name":"Unencrypted","value":"UNENCRYPTED"}]},"aws-native:mediapackagev2:OriginEndpointPresetSpeke20Video":{"type":"string","enum":[{"name":"PresetVideo1","value":"PRESET_VIDEO_1"},{"name":"PresetVideo2","value":"PRESET_VIDEO_2"},{"name":"PresetVideo3","value":"PRESET_VIDEO_3"},{"name":"PresetVideo4","value":"PRESET_VIDEO_4"},{"name":"PresetVideo5","value":"PRESET_VIDEO_5"},{"name":"PresetVideo6","value":"PRESET_VIDEO_6"},{"name":"PresetVideo7","value":"PRESET_VIDEO_7"},{"name":"PresetVideo8","value":"PRESET_VIDEO_8"},{"name":"Shared","value":"SHARED"},{"name":"Unencrypted","value":"UNENCRYPTED"}]},"aws-native:mediapackagev2:OriginEndpointScte":{"description":"\u003cp\u003eThe SCTE configuration.\u003c/p\u003e","properties":{"scteFilter":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointScteFilter"},"description":"\u003cp\u003eThe SCTE-35 message types that you want to be treated as ad markers in the output.\u003c/p\u003e"},"scteInSegments":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointScteInSegments","description":"Controls whether SCTE-35 messages are included in segment files.\n\n- None – SCTE-35 messages are not included in segments (default)\n- All – SCTE-35 messages are embedded in segment data\n\nFor DASH manifests, when set to `All` , an `InbandEventStream` tag signals that SCTE messages are present in segments. This setting works independently of manifest ad markers."}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointScteDash":{"description":"\u003cp\u003eThe SCTE configuration.\u003c/p\u003e","properties":{"adMarkerDash":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointAdMarkerDash","description":"Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.\n\nValue description:\n\n- `Binary` - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.\n- `XML` - The SCTE marker is expressed fully in XML."}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointScteFilter":{"type":"string","enum":[{"name":"SpliceInsert","value":"SPLICE_INSERT"},{"name":"Break","value":"BREAK"},{"name":"ProviderAdvertisement","value":"PROVIDER_ADVERTISEMENT"},{"name":"DistributorAdvertisement","value":"DISTRIBUTOR_ADVERTISEMENT"},{"name":"ProviderPlacementOpportunity","value":"PROVIDER_PLACEMENT_OPPORTUNITY"},{"name":"DistributorPlacementOpportunity","value":"DISTRIBUTOR_PLACEMENT_OPPORTUNITY"},{"name":"ProviderOverlayPlacementOpportunity","value":"PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY"},{"name":"DistributorOverlayPlacementOpportunity","value":"DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY"},{"name":"Program","value":"PROGRAM"}]},"aws-native:mediapackagev2:OriginEndpointScteHls":{"description":"\u003cp\u003eThe SCTE configuration.\u003c/p\u003e","properties":{"adMarkerHls":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointAdMarkerHls","description":"The SCTE-35 HLS ad-marker configuration."}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointScteInSegments":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"All","value":"ALL"}]},"aws-native:mediapackagev2:OriginEndpointSegment":{"description":"\u003cp\u003eThe segment configuration, including the segment name, duration, and other configuration values.\u003c/p\u003e","properties":{"encryption":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointEncryption","description":"Whether to use encryption for the segment."},"includeIframeOnlyStreams":{"type":"boolean","description":"\u003cp\u003eWhen selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.\u003c/p\u003e"},"scte":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointScte","description":"The SCTE-35 configuration associated with the segment."},"segmentDurationSeconds":{"type":"integer","description":"\u003cp\u003eThe duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.\u003c/p\u003e"},"segmentName":{"type":"string","description":"\u003cp\u003eThe name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.\u003c/p\u003e"},"tsIncludeDvbSubtitles":{"type":"boolean","description":"\u003cp\u003eBy default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.\u003c/p\u003e"},"tsUseAudioRenditionGroup":{"type":"boolean","description":"\u003cp\u003eWhen selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.\u003c/p\u003e"}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointSpekeKeyProvider":{"description":"\u003cp\u003eThe parameters for the SPEKE key provider.\u003c/p\u003e","properties":{"certificateArn":{"type":"string","description":"\u003cp\u003eThe ARN for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint. For this feature to work, your DRM key provider must support content key encryption.\u003c/p\u003e"},"drmSystems":{"type":"array","items":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointDrmSystem"},"description":"\u003cp\u003eThe DRM solution provider you're using to protect your content during distribution.\u003c/p\u003e"},"encryptionContractConfiguration":{"$ref":"#/types/aws-native:mediapackagev2:OriginEndpointEncryptionContractConfiguration","description":"The encryption contract configuration associated with the SPEKE key provider."},"resourceId":{"type":"string","description":"\u003cp\u003eThe unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.\u003c/p\u003e \u003cp\u003eThe following example shows a resource ID: \u003ccode\u003eMovieNight20171126093045\u003c/code\u003e \u003c/p\u003e"},"roleArn":{"type":"string","description":"\u003cp\u003eThe ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.\u003c/p\u003e \u003cp\u003eValid format: \u003ccode\u003earn:aws:iam::{accountID}:role/{name}\u003c/code\u003e. The following example shows a role ARN: \u003ccode\u003earn:aws:iam::444455556666:role/SpekeAccess\u003c/code\u003e \u003c/p\u003e"},"url":{"type":"string","description":"\u003cp\u003eThe URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.\u003c/p\u003e \u003cp\u003eThe following example shows a URL: \u003ccode\u003ehttps://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection\u003c/code\u003e \u003c/p\u003e"}},"type":"object","required":["drmSystems","encryptionContractConfiguration","resourceId","roleArn","url"]},"aws-native:mediapackagev2:OriginEndpointStartTag":{"description":"\u003cp\u003eTo insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.\u003c/p\u003e","properties":{"precise":{"type":"boolean","description":"\u003cp\u003eSpecify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES.\u003c/p\u003e"},"timeOffset":{"type":"number","description":"\u003cp\u003eSpecify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration.\u003c/p\u003e"}},"type":"object","required":["timeOffset"]},"aws-native:mediapackagev2:OriginEndpointTag":{"properties":{"key":{"type":"string","description":"The key in the key:value pair for the tag."},"value":{"type":"string","description":"The value in the key:value pair for the tag."}},"type":"object"},"aws-native:mediapackagev2:OriginEndpointTsEncryptionMethod":{"type":"string","enum":[{"name":"Aes128","value":"AES_128"},{"name":"SampleAes","value":"SAMPLE_AES"}]},"aws-native:mediatailor:ChannelAdMarkupType":{"type":"string","enum":[{"name":"Daterange","value":"DATERANGE"},{"name":"Scte35Enhanced","value":"SCTE35_ENHANCED"}]},"aws-native:mediatailor:ChannelDashPlaylistSettings":{"description":"\u003cp\u003eDash manifest configuration parameters.\u003c/p\u003e","properties":{"manifestWindowSeconds":{"type":"number","description":"\u003cp\u003eThe total duration (in seconds) of each manifest. Minimum value: \u003ccode\u003e30\u003c/code\u003e seconds. Maximum value: \u003ccode\u003e3600\u003c/code\u003e seconds.\u003c/p\u003e"},"minBufferTimeSeconds":{"type":"number","description":"\u003cp\u003eMinimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: \u003ccode\u003e2\u003c/code\u003e seconds. Maximum value: \u003ccode\u003e60\u003c/code\u003e seconds.\u003c/p\u003e"},"minUpdatePeriodSeconds":{"type":"number","description":"\u003cp\u003eMinimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: \u003ccode\u003e2\u003c/code\u003e seconds. Maximum value: \u003ccode\u003e60\u003c/code\u003e seconds.\u003c/p\u003e"},"suggestedPresentationDelaySeconds":{"type":"number","description":"\u003cp\u003eAmount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: \u003ccode\u003e2\u003c/code\u003e seconds. Maximum value: \u003ccode\u003e60\u003c/code\u003e seconds.\u003c/p\u003e"}},"type":"object"},"aws-native:mediatailor:ChannelHlsPlaylistSettings":{"description":"\u003cp\u003eHLS playlist configuration parameters.\u003c/p\u003e","properties":{"adMarkupType":{"type":"array","items":{"$ref":"#/types/aws-native:mediatailor:ChannelAdMarkupType"},"description":"\u003cp\u003eDetermines the type of SCTE 35 tags to use in ad markup. Specify \u003ccode\u003eDATERANGE\u003c/code\u003e to use \u003ccode\u003eDATERANGE\u003c/code\u003e tags (for live or VOD content). Specify \u003ccode\u003eSCTE35_ENHANCED\u003c/code\u003e to use \u003ccode\u003eEXT-X-CUE-OUT\u003c/code\u003e and \u003ccode\u003eEXT-X-CUE-IN\u003c/code\u003e tags (for VOD content only).\u003c/p\u003e"},"manifestWindowSeconds":{"type":"number","description":"\u003cp\u003eThe total duration (in seconds) of each manifest. Minimum value: \u003ccode\u003e30\u003c/code\u003e seconds. Maximum value: \u003ccode\u003e3600\u003c/code\u003e seconds.\u003c/p\u003e"}},"type":"object"},"aws-native:mediatailor:ChannelLogConfigurationForChannel":{"description":"\u003cp\u003eThe log configuration for the channel.\u003c/p\u003e","properties":{"logTypes":{"type":"array","items":{"$ref":"#/types/aws-native:mediatailor:ChannelLogType"},"description":"\u003cp\u003eThe log types.\u003c/p\u003e"}},"type":"object"},"aws-native:mediatailor:ChannelLogType":{"type":"string","enum":[{"name":"AsRun","value":"AS_RUN"}]},"aws-native:mediatailor:ChannelPlaybackMode":{"type":"string","enum":[{"name":"Loop","value":"LOOP"},{"name":"Linear","value":"LINEAR"}]},"aws-native:mediatailor:ChannelRequestOutputItem":{"description":"\u003cp\u003eThe output configuration for this channel.\u003c/p\u003e","properties":{"dashPlaylistSettings":{"$ref":"#/types/aws-native:mediatailor:ChannelDashPlaylistSettings","description":"DASH manifest configuration parameters."},"hlsPlaylistSettings":{"$ref":"#/types/aws-native:mediatailor:ChannelHlsPlaylistSettings","description":"HLS playlist configuration parameters."},"manifestName":{"type":"string","description":"\u003cp\u003eThe name of the manifest for the channel. The name appears in the \u003ccode\u003ePlaybackUrl\u003c/code\u003e.\u003c/p\u003e"},"sourceGroup":{"type":"string","description":"\u003cp\u003eA string used to match which \u003ccode\u003eHttpPackageConfiguration\u003c/code\u003e is used for each \u003ccode\u003eVodSource\u003c/code\u003e.\u003c/p\u003e"}},"type":"object","required":["manifestName","sourceGroup"]},"aws-native:mediatailor:ChannelSlateSource":{"description":"\u003cp\u003eSlate VOD source configuration.\u003c/p\u003e","properties":{"sourceLocationName":{"type":"string","description":"\u003cp\u003eThe name of the source location where the slate VOD source is stored.\u003c/p\u003e"},"vodSourceName":{"type":"string","description":"\u003cp\u003eThe slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.\u003c/p\u003e"}},"type":"object"},"aws-native:mediatailor:ChannelTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:mediatailor:ChannelTier":{"type":"string","enum":[{"name":"Basic","value":"BASIC"},{"name":"Standard","value":"STANDARD"}]},"aws-native:mediatailor:ChannelTimeShiftConfiguration":{"description":"\u003cp\u003eThe configuration for time-shifted viewing.\u003c/p\u003e","properties":{"maxTimeDelaySeconds":{"type":"number","description":"\u003cp\u003eThe maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).\u003c/p\u003e"}},"type":"object","required":["maxTimeDelaySeconds"]},"aws-native:mediatailor:LiveSourceHttpPackageConfiguration":{"description":"\u003cp\u003eThe HTTP package configuration properties for the requested VOD source.\u003c/p\u003e","properties":{"path":{"type":"string","description":"\u003cp\u003eThe relative path to the URL for this VOD source. This is combined with \u003ccode\u003eSourceLocation::HttpConfiguration::BaseUrl\u003c/code\u003e to form a valid URL.\u003c/p\u003e"},"sourceGroup":{"type":"string","description":"\u003cp\u003eThe name of the source group. This has to match one of the \u003ccode\u003eChannel::Outputs::SourceGroup\u003c/code\u003e.\u003c/p\u003e"},"type":{"$ref":"#/types/aws-native:mediatailor:LiveSourceType","description":"The streaming protocol for this package configuration. Supported values are `HLS` and `DASH` ."}},"type":"object","required":["path","sourceGroup","type"]},"aws-native:mediatailor:LiveSourceTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:mediatailor:LiveSourceType":{"type":"string","enum":[{"name":"Dash","value":"DASH"},{"name":"Hls","value":"HLS"}]},"aws-native:mediatailor:PlaybackConfigurationAdConditioningConfiguration":{"description":"\u003cp\u003eThe setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns.\u003c/p\u003e","properties":{"streamingMediaFileConditioning":{"$ref":"#/types/aws-native:mediatailor:PlaybackConfigurationStreamingMediaFileConditioning","description":"For ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS. `TRANSCODE` indicates that MediaTailor must transcode the ads. `NONE` indicates that you have already transcoded the ads outside of MediaTailor and don't need them transcoded as part of the ad insertion workflow. For more information about ad conditioning see [Using preconditioned ads](https://docs.aws.amazon.com/mediatailor/latest/ug/precondition-ads.html) in the AWS Elemental MediaTailor user guide."}},"type":"object","required":["streamingMediaFileConditioning"]},"aws-native:mediatailor:PlaybackConfigurationAdDecisionServerConfiguration":{"description":"The configuration for the request to the specified Ad Decision Server URL.","properties":{"httpRequest":{"$ref":"#/types/aws-native:mediatailor:PlaybackConfigurationHttpRequest"}},"type":"object","required":["httpRequest"]},"aws-native:mediatailor:PlaybackConfigurationAdMarkerPassthrough":{"description":"For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest. No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.","properties":{"enabled":{"type":"boolean","description":"Enables ad marker passthrough for your configuration."}},"type":"object"},"aws-native:mediatailor:PlaybackConfigurationAdsInteractionLog":{"properties":{"excludeEventTypes":{"type":"array","items":{"type":"string"},"description":"Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration."},"publishOptInEventTypes":{"type":"array","items":{"type":"string"},"description":"Indicates that MediaTailor emits RAW_ADS_RESPONSE logs for playback sessions that are initialized with this configuration."}},"type":"object"},"aws-native:mediatailor:PlaybackConfigurationAvailSuppression":{"description":"The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).","properties":{"fillPolicy":{"$ref":"#/types/aws-native:mediatailor:PlaybackConfigurationAvailSuppressionFillPolicy","description":"Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break. Valid values are FULL_AVAIL_ONLY and PARTIAL_AVAIL"},"mode":{"$ref":"#/types/aws-native:mediatailor:PlaybackConfigurationAvailSuppressionMode","description":"Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value."},"value":{"type":"string","description":"A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge."}},"type":"object"},"aws-native:mediatailor:PlaybackConfigurationAvailSuppressionFillPolicy":{"description":"Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break. Valid values are FULL_AVAIL_ONLY and PARTIAL_AVAIL","type":"string","enum":[{"name":"PartialAvail","value":"PARTIAL_AVAIL"},{"name":"FullAvailOnly","value":"FULL_AVAIL_ONLY"}]},"aws-native:mediatailor:PlaybackConfigurationAvailSuppressionMode":{"description":"Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.","type":"string","enum":[{"name":"Off","value":"OFF"},{"name":"BehindLiveEdge","value":"BEHIND_LIVE_EDGE"},{"name":"AfterLiveEdge","value":"AFTER_LIVE_EDGE"}]},"aws-native:mediatailor:PlaybackConfigurationBumper":{"description":"The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).","properties":{"endUrl":{"type":"string","description":"The URL for the end bumper asset."},"startUrl":{"type":"string","description":"The URL for the start bumper asset."}},"type":"object"},"aws-native:mediatailor:PlaybackConfigurationCdnConfiguration":{"description":"The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.","properties":{"adSegmentUrlPrefix":{"type":"string","description":"A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.\u0026lt;region\u003e.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments."},"contentSegmentUrlPrefix":{"type":"string","description":"A content delivery network (CDN) to cache content segments, so that content requests don't always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments."}},"type":"object"},"aws-native:mediatailor:PlaybackConfigurationDashConfiguration":{"description":"The configuration for DASH PUT operations.","properties":{"manifestEndpointPrefix":{"type":"string","description":"The URL generated by MediaTailor to initiate a DASH playback session. The session uses server-side reporting."},"mpdLocation":{"type":"string","description":"The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value."},"originManifestType":{"$ref":"#/types/aws-native:mediatailor:PlaybackConfigurationDashConfigurationOriginManifestType","description":"The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD."}},"type":"object"},"aws-native:mediatailor:PlaybackConfigurationDashConfigurationOriginManifestType":{"description":"The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.","type":"string","enum":[{"name":"SinglePeriod","value":"SINGLE_PERIOD"},{"name":"MultiPeriod","value":"MULTI_PERIOD"}]},"aws-native:mediatailor:PlaybackConfigurationHlsConfiguration":{"properties":{"manifestEndpointPrefix":{"type":"string","description":"The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting."}},"type":"object"},"aws-native:mediatailor:PlaybackConfigurationHttpRequest":{"description":"The configuration for the request to the Ad Decision Server URL.","properties":{"body":{"type":"string","description":"The body of the request to the Ad Decision Server URL. The maximum length is 100,000 characters."},"compressRequest":{"$ref":"#/types/aws-native:mediatailor:PlaybackConfigurationHttpRequestCompressRequest","description":"The compression type of the request sent to the Ad Decision Server URL. Only the POST HTTP Method permits compression other than NONE."},"headers":{"type":"object","additionalProperties":{"type":"string"}},"httpMethod":{"$ref":"#/types/aws-native:mediatailor:PlaybackConfigurationHttpRequestHttpMethod","description":"Supported HTTP Methods for the request to the Ad Decision Server URL."}},"type":"object"},"aws-native:mediatailor:PlaybackConfigurationHttpRequestCompressRequest":{"description":"The compression type of the request sent to the Ad Decision Server URL. Only the POST HTTP Method permits compression other than NONE.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Gzip","value":"GZIP"}]},"aws-native:mediatailor:PlaybackConfigurationHttpRequestHttpMethod":{"description":"Supported HTTP Methods for the request to the Ad Decision Server URL.","type":"string","enum":[{"name":"Get","value":"GET"},{"name":"Post","value":"POST"}]},"aws-native:mediatailor:PlaybackConfigurationInsertionMode":{"type":"string","enum":[{"name":"StitchedOnly","value":"STITCHED_ONLY"},{"name":"PlayerSelect","value":"PLAYER_SELECT"}]},"aws-native:mediatailor:PlaybackConfigurationLivePreRollConfiguration":{"description":"The configuration for pre-roll ad insertion.","properties":{"adDecisionServerUrl":{"type":"string","description":"The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters."},"maxDurationSeconds":{"type":"integer","description":"The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns."}},"type":"object"},"aws-native:mediatailor:PlaybackConfigurationLogConfiguration":{"properties":{"adsInteractionLog":{"$ref":"#/types/aws-native:mediatailor:PlaybackConfigurationAdsInteractionLog","description":"The event types that MediaTailor emits in logs for interactions with the ADS."},"enabledLoggingStrategies":{"type":"array","items":{"type":"string"},"description":"The method used for collecting logs from AWS Elemental MediaTailor. To configure MediaTailor to send logs directly to Amazon CloudWatch Logs, choose LEGACY_CLOUDWATCH. To configure MediaTailor to send logs to CloudWatch, which then vends the logs to your destination of choice, choose VENDED_LOGS. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream. To use vended logs, you must configure the delivery destination in Amazon CloudWatch"},"manifestServiceInteractionLog":{"$ref":"#/types/aws-native:mediatailor:PlaybackConfigurationManifestServiceInteractionLog","description":"The event types that MediaTailor emits in logs for interactions with the origin server."},"percentEnabled":{"type":"integer","description":"The percentage of session logs that MediaTailor sends to your CloudWatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode."}},"type":"object","required":["percentEnabled"]},"aws-native:mediatailor:PlaybackConfigurationManifestProcessingRules":{"description":"The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.","properties":{"adMarkerPassthrough":{"$ref":"#/types/aws-native:mediatailor:PlaybackConfigurationAdMarkerPassthrough","description":"For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest. No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0."}},"type":"object"},"aws-native:mediatailor:PlaybackConfigurationManifestServiceInteractionLog":{"properties":{"excludeEventTypes":{"type":"array","items":{"type":"string"},"description":"Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration."}},"type":"object"},"aws-native:mediatailor:PlaybackConfigurationStreamingMediaFileConditioning":{"type":"string","enum":[{"name":"Transcode","value":"TRANSCODE"},{"name":"None","value":"NONE"}]},"aws-native:mediatailor:PlaybackConfigurationTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:mediatailor:SourceLocationAccessConfiguration":{"description":"\u003cp\u003eAccess configuration parameters.\u003c/p\u003e","properties":{"accessType":{"$ref":"#/types/aws-native:mediatailor:SourceLocationAccessType","description":"The type of authentication used to access content from `HttpConfiguration::BaseUrl` on your source location. Accepted value: `S3_SIGV4` .\n\n`S3_SIGV4` - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.\n\nBefore you can use `S3_SIGV4` , you must meet these requirements:\n\n• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.\n\n• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.\n\n• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations."},"secretsManagerAccessTokenConfiguration":{"$ref":"#/types/aws-native:mediatailor:SourceLocationSecretsManagerAccessTokenConfiguration","description":"AWS Secrets Manager access token configuration parameters."}},"type":"object"},"aws-native:mediatailor:SourceLocationAccessType":{"type":"string","enum":[{"name":"S3Sigv4","value":"S3_SIGV4"},{"name":"SecretsManagerAccessToken","value":"SECRETS_MANAGER_ACCESS_TOKEN"},{"name":"AutodetectSigv4","value":"AUTODETECT_SIGV4"}]},"aws-native:mediatailor:SourceLocationDefaultSegmentDeliveryConfiguration":{"description":"\u003cp\u003eThe optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.\u003c/p\u003e","properties":{"baseUrl":{"type":"string","description":"\u003cp\u003eThe hostname of the server that will be used to serve segments. This string must include the protocol, such as \u003cb\u003ehttps://\u003c/b\u003e.\u003c/p\u003e"}},"type":"object"},"aws-native:mediatailor:SourceLocationHttpConfiguration":{"description":"\u003cp\u003eThe HTTP configuration for the source location.\u003c/p\u003e","properties":{"baseUrl":{"type":"string","description":"\u003cp\u003eThe base URL for the source location host server. This string must include the protocol, such as \u003cb\u003ehttps://\u003c/b\u003e.\u003c/p\u003e"}},"type":"object","required":["baseUrl"]},"aws-native:mediatailor:SourceLocationSecretsManagerAccessTokenConfiguration":{"description":"\u003cp\u003eAWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see \u003ca href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html\"\u003eWorking with AWS Secrets Manager access token authentication\u003c/a\u003e.\u003c/p\u003e","properties":{"headerName":{"type":"string","description":"\u003cp\u003eThe name of the HTTP header used to supply the access token in requests to the source location.\u003c/p\u003e"},"secretArn":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.\u003c/p\u003e"},"secretStringKey":{"type":"string","description":"\u003cp\u003eThe AWS Secrets Manager \u003ca href=\"https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html#SecretsManager-CreateSecret-request-SecretString.html\"\u003eSecretString\u003c/a\u003e key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.\u003c/p\u003e"}},"type":"object"},"aws-native:mediatailor:SourceLocationSegmentDeliveryConfiguration":{"description":"\u003cp\u003eThe segment delivery configuration settings.\u003c/p\u003e","properties":{"baseUrl":{"type":"string","description":"\u003cp\u003eThe base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as \u003ccode\u003ehttps://example.com/some/path\u003c/code\u003e. To use a relative URL specify the relative path, such as \u003ccode\u003e/some/path*\u003c/code\u003e.\u003c/p\u003e"},"name":{"type":"string","description":"\u003cp\u003eA unique identifier used to distinguish between multiple segment delivery configurations in a source location.\u003c/p\u003e"}},"type":"object"},"aws-native:mediatailor:SourceLocationTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:mediatailor:VodSourceHttpPackageConfiguration":{"description":"\u003cp\u003eThe HTTP package configuration properties for the requested VOD source.\u003c/p\u003e","properties":{"path":{"type":"string","description":"\u003cp\u003eThe relative path to the URL for this VOD source. This is combined with \u003ccode\u003eSourceLocation::HttpConfiguration::BaseUrl\u003c/code\u003e to form a valid URL.\u003c/p\u003e"},"sourceGroup":{"type":"string","description":"\u003cp\u003eThe name of the source group. This has to match one of the \u003ccode\u003eChannel::Outputs::SourceGroup\u003c/code\u003e.\u003c/p\u003e"},"type":{"$ref":"#/types/aws-native:mediatailor:VodSourceType","description":"The streaming protocol for this package configuration. Supported values are `HLS` and `DASH` ."}},"type":"object","required":["path","sourceGroup","type"]},"aws-native:mediatailor:VodSourceTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:mediatailor:VodSourceType":{"type":"string","enum":[{"name":"Dash","value":"DASH"},{"name":"Hls","value":"HLS"}]},"aws-native:memorydb:AclTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:memorydb:AuthenticationModeProperties":{"description":"Denotes whether the user requires a password to authenticate.\n\n*Example:*\n\n`mynewdbuser: Type: AWS::MemoryDB::User Properties: AccessString: on ~* \u0026* +@all AuthenticationMode: Passwords: '1234567890123456' Type: password UserName: mynewdbuser AuthenticationMode: { \"Passwords\": [\"1234567890123456\"], \"Type\": \"Password\" }`","properties":{"passwords":{"type":"array","items":{"type":"string"},"description":"Passwords used for this user account. You can create up to two passwords for each user."},"type":{"$ref":"#/types/aws-native:memorydb:UserAuthenticationModePropertiesType","description":"Type of authentication strategy for this user."}},"type":"object"},"aws-native:memorydb:ClusterDataTieringStatus":{"type":"string","enum":[{"name":"True","value":"true"},{"name":"False","value":"false"}]},"aws-native:memorydb:ClusterEndpoint":{"properties":{"address":{"type":"string","description":"The DNS address of the primary read-write node."},"port":{"type":"integer","description":"The port number that the engine is listening on. "}},"type":"object"},"aws-native:memorydb:ClusterSupportedIpDiscoveryTypes":{"type":"string","enum":[{"name":"Ipv4","value":"ipv4"},{"name":"Ipv6","value":"ipv6"}]},"aws-native:memorydb:ClusterSupportedNetworkTypes":{"type":"string","enum":[{"name":"Ipv4","value":"ipv4"},{"name":"Ipv6","value":"ipv6"},{"name":"DualStack","value":"dual_stack"}]},"aws-native:memorydb:ClusterTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for the tag. May not be null."},"value":{"type":"string","description":"The tag's value. May be null."}},"type":"object","required":["key","value"]},"aws-native:memorydb:MultiRegionClusterTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for the tag. May not be null."},"value":{"type":"string","description":"The tag's value. May be null."}},"type":"object","required":["key","value"]},"aws-native:memorydb:MultiRegionClusterUpdateStrategy":{"description":"An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.","type":"string","enum":[{"name":"Coordinated","value":"COORDINATED"},{"name":"Uncoordinated","value":"UNCOORDINATED"}]},"aws-native:memorydb:ParameterGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for the tag. May not be null."},"value":{"type":"string","description":"The tag's value. May be null."}},"type":"object","required":["key","value"]},"aws-native:memorydb:SubnetGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key for the tag. May not be null."},"value":{"type":"string","description":"The tag's value. May be null."}},"type":"object","required":["key","value"]},"aws-native:memorydb:UserAuthenticationModePropertiesType":{"description":"Type of authentication strategy for this user.","type":"string","enum":[{"name":"Password","value":"password"},{"name":"Iam","value":"iam"}]},"aws-native:memorydb:UserTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with 'aws:'. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:msk:ClusterBrokerLogs":{"properties":{"cloudWatchLogs":{"$ref":"#/types/aws-native:msk:ClusterCloudWatchLogs"},"firehose":{"$ref":"#/types/aws-native:msk:ClusterFirehose","description":"Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs."},"s3":{"$ref":"#/types/aws-native:msk:ClusterS3","description":"Details of the Amazon S3 destination for broker logs."}},"type":"object"},"aws-native:msk:ClusterBrokerNodeGroupInfo":{"properties":{"brokerAzDistribution":{"type":"string","description":"This parameter is currently not in use.","replaceOnChanges":true},"clientSubnets":{"type":"array","items":{"type":"string"},"description":"The list of subnets to connect to in the client virtual private cloud (VPC). Amazon creates elastic network interfaces (ENIs) inside these subnets. Client applications use ENIs to produce and consume data.\n\nIf you use the US West (N. California) Region, specify exactly two subnets. For other Regions where Amazon MSK is available, you can specify either two or three subnets. The subnets that you specify must be in distinct Availability Zones. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify.\n\nClient subnets can't occupy the Availability Zone with ID `use1-az3` .","replaceOnChanges":true},"connectivityInfo":{"$ref":"#/types/aws-native:msk:ClusterConnectivityInfo","description":"Information about the cluster's connectivity setting."},"instanceType":{"type":"string","description":"The type of Amazon EC2 instances to use for brokers. Depending on the [broker type](https://docs.aws.amazon.com/msk/latest/developerguide/broker-instance-types.html) , Amazon MSK supports the following broker sizes:\n\n*Standard broker sizes*\n\n- kafka.t3.small\n\n\u003e You can't select the kafka.t3.small instance type when the metadata mode is KRaft.\n- kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge\n- kafka.m7g.large, kafka.m7g.xlarge, kafka.m7g.2xlarge, kafka.m7g.4xlarge, kafka.m7g.8xlarge, kafka.m7g.12xlarge, kafka.m7g.16xlarge\n\n*Express broker sizes*\n\n- express.m7g.large, express.m7g.xlarge, express.m7g.2xlarge, express.m7g.4xlarge, express.m7g.8xlarge, express.m7g.12xlarge, express.m7g.16xlarge\n\n\u003e Some broker sizes might not be available in certian AWS Regions. See the updated [Pricing tools](https://docs.aws.amazon.com/msk/pricing/) section on the Amazon MSK pricing page for the latest list of available instances by Region."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"The security groups to associate with the ENIs in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC. If you specify security groups that were shared with you, you must ensure that you have permissions to them. Specifically, you need the `ec2:DescribeSecurityGroups` permission.","replaceOnChanges":true},"storageInfo":{"$ref":"#/types/aws-native:msk:ClusterStorageInfo","description":"Contains information about storage volumes attached to Amazon MSK broker nodes."}},"type":"object","required":["clientSubnets","instanceType"]},"aws-native:msk:ClusterClientAuthentication":{"properties":{"sasl":{"$ref":"#/types/aws-native:msk:ClusterSasl","description":"Details for client authentication using SASL. To turn on SASL, you must also turn on `EncryptionInTransit` by setting `inCluster` to true. You must set `clientBroker` to either `TLS` or `TLS_PLAINTEXT` . If you choose `TLS_PLAINTEXT` , then you must also set `unauthenticated` to true."},"tls":{"$ref":"#/types/aws-native:msk:ClusterTls","description":"Details for ClientAuthentication using TLS. To turn on TLS access control, you must also turn on `EncryptionInTransit` by setting `inCluster` to true and `clientBroker` to `TLS` ."},"unauthenticated":{"$ref":"#/types/aws-native:msk:ClusterUnauthenticated","description":"Details for ClientAuthentication using no authentication."}},"type":"object"},"aws-native:msk:ClusterCloudWatchLogs":{"properties":{"enabled":{"type":"boolean","description":"Specifies whether broker logs get sent to the specified CloudWatch Logs destination."},"logGroup":{"type":"string","description":"The CloudWatch log group that is the destination for broker logs."}},"type":"object","required":["enabled"]},"aws-native:msk:ClusterConfigurationInfo":{"properties":{"arn":{"type":"string","description":"ARN of the configuration to use."},"revision":{"type":"integer","description":"The revision of the configuration to use."}},"type":"object","required":["arn","revision"]},"aws-native:msk:ClusterConnectivityInfo":{"properties":{"networkType":{"$ref":"#/types/aws-native:msk:ClusterNetworkType"},"publicAccess":{"$ref":"#/types/aws-native:msk:ClusterPublicAccess","description":"Access control settings for the cluster's brokers."},"vpcConnectivity":{"$ref":"#/types/aws-native:msk:ClusterVpcConnectivity","description":"VPC connection control settings for brokers."}},"type":"object"},"aws-native:msk:ClusterEbsStorageInfo":{"properties":{"provisionedThroughput":{"$ref":"#/types/aws-native:msk:ClusterProvisionedThroughput","description":"EBS volume provisioned throughput information."},"volumeSize":{"type":"integer","description":"The size in GiB of the EBS volume for the data drive on each broker node."}},"type":"object"},"aws-native:msk:ClusterEncryptionAtRest":{"properties":{"dataVolumeKmsKeyId":{"type":"string","description":"The ARN of the Amazon KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it."}},"type":"object","required":["dataVolumeKmsKeyId"]},"aws-native:msk:ClusterEncryptionInTransit":{"properties":{"clientBroker":{"$ref":"#/types/aws-native:msk:ClusterEncryptionInTransitClientBroker","description":"Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.\n\n- `TLS` : Indicates that client-broker communication is enabled with TLS only.\n- `TLS_PLAINTEXT` : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.\n- `PLAINTEXT` : Indicates that client-broker communication is enabled in plaintext only.\n\nThe default value is `TLS` ."},"inCluster":{"type":"boolean","description":"When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.\n\nThe default value is true.","replaceOnChanges":true}},"type":"object"},"aws-native:msk:ClusterEncryptionInTransitClientBroker":{"description":"Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.\n\n- `TLS` : Indicates that client-broker communication is enabled with TLS only.\n- `TLS_PLAINTEXT` : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.\n- `PLAINTEXT` : Indicates that client-broker communication is enabled in plaintext only.\n\nThe default value is `TLS` .","type":"string","enum":[{"name":"Tls","value":"TLS"},{"name":"TlsPlaintext","value":"TLS_PLAINTEXT"},{"name":"Plaintext","value":"PLAINTEXT"}]},"aws-native:msk:ClusterEncryptionInfo":{"properties":{"encryptionAtRest":{"$ref":"#/types/aws-native:msk:ClusterEncryptionAtRest","description":"The data-volume encryption details.","replaceOnChanges":true},"encryptionInTransit":{"$ref":"#/types/aws-native:msk:ClusterEncryptionInTransit","description":"The details for encryption in transit."}},"type":"object"},"aws-native:msk:ClusterEnhancedMonitoring":{"description":"Specifies the level of monitoring for the MSK cluster.","type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"PerBroker","value":"PER_BROKER"},{"name":"PerTopicPerBroker","value":"PER_TOPIC_PER_BROKER"},{"name":"PerTopicPerPartition","value":"PER_TOPIC_PER_PARTITION"}]},"aws-native:msk:ClusterFirehose":{"properties":{"deliveryStream":{"type":"string","description":"The Kinesis Data Firehose delivery stream that is the destination for broker logs."},"enabled":{"type":"boolean","description":"Specifies whether broker logs get send to the specified Kinesis Data Firehose delivery stream."}},"type":"object","required":["enabled"]},"aws-native:msk:ClusterIam":{"properties":{"enabled":{"type":"boolean","description":"SASL/IAM authentication is enabled or not."}},"type":"object","required":["enabled"]},"aws-native:msk:ClusterJmxExporter":{"properties":{"enabledInBroker":{"type":"boolean","description":"Indicates whether you want to enable or disable the JMX Exporter."}},"type":"object","required":["enabledInBroker"]},"aws-native:msk:ClusterLoggingInfo":{"properties":{"brokerLogs":{"$ref":"#/types/aws-native:msk:ClusterBrokerLogs","description":"You can configure your MSK cluster to send broker logs to different destination types. This configuration specifies the details of these destinations."}},"type":"object","required":["brokerLogs"]},"aws-native:msk:ClusterNetworkType":{"type":"string","enum":[{"name":"Ipv4","value":"IPV4"},{"name":"Dual","value":"DUAL"}]},"aws-native:msk:ClusterNodeExporter":{"properties":{"enabledInBroker":{"type":"boolean","description":"Indicates whether you want to enable or disable the Node Exporter."}},"type":"object","required":["enabledInBroker"]},"aws-native:msk:ClusterOpenMonitoring":{"properties":{"prometheus":{"$ref":"#/types/aws-native:msk:ClusterPrometheus","description":"Prometheus exporter settings."}},"type":"object","required":["prometheus"]},"aws-native:msk:ClusterPrometheus":{"properties":{"jmxExporter":{"$ref":"#/types/aws-native:msk:ClusterJmxExporter","description":"Indicates whether you want to enable or disable the JMX Exporter."},"nodeExporter":{"$ref":"#/types/aws-native:msk:ClusterNodeExporter","description":"Indicates whether you want to enable or disable the Node Exporter."}},"type":"object"},"aws-native:msk:ClusterProvisionedThroughput":{"properties":{"enabled":{"type":"boolean","description":"Provisioned throughput is on or off."},"volumeThroughput":{"type":"integer","description":"Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second."}},"type":"object"},"aws-native:msk:ClusterPublicAccess":{"properties":{"type":{"type":"string","description":"DISABLED means that public access is turned off. SERVICE_PROVIDED_EIPS means that public access is turned on."}},"type":"object"},"aws-native:msk:ClusterRebalancing":{"properties":{"status":{"$ref":"#/types/aws-native:msk:ClusterRebalancingStatus"}},"type":"object","required":["status"]},"aws-native:msk:ClusterRebalancingStatus":{"type":"string","enum":[{"name":"Paused","value":"PAUSED"},{"name":"Active","value":"ACTIVE"}]},"aws-native:msk:ClusterS3":{"properties":{"bucket":{"type":"string","description":"The name of the S3 bucket that is the destination for broker logs."},"enabled":{"type":"boolean","description":"Specifies whether broker logs get sent to the specified Amazon S3 destination."},"prefix":{"type":"string","description":"The S3 prefix that is the destination for broker logs."}},"type":"object","required":["enabled"]},"aws-native:msk:ClusterSasl":{"properties":{"iam":{"$ref":"#/types/aws-native:msk:ClusterIam","description":"Details for ClientAuthentication using IAM."},"scram":{"$ref":"#/types/aws-native:msk:ClusterScram","description":"Details for SASL/SCRAM client authentication."}},"type":"object"},"aws-native:msk:ClusterScram":{"properties":{"enabled":{"type":"boolean","description":"SASL/SCRAM authentication is enabled or not."}},"type":"object","required":["enabled"]},"aws-native:msk:ClusterStorageInfo":{"properties":{"ebsStorageInfo":{"$ref":"#/types/aws-native:msk:ClusterEbsStorageInfo","description":"EBS volume information."}},"type":"object"},"aws-native:msk:ClusterStorageMode":{"description":"This controls storage mode for supported storage tiers.","type":"string","enum":[{"name":"Local","value":"LOCAL"},{"name":"Tiered","value":"TIERED"}]},"aws-native:msk:ClusterTls":{"properties":{"certificateAuthorityArnList":{"type":"array","items":{"type":"string"},"description":"List of AWS Private CA ARNs."},"enabled":{"type":"boolean","description":"TLS authentication is enabled or not."}},"type":"object"},"aws-native:msk:ClusterUnauthenticated":{"properties":{"enabled":{"type":"boolean","description":"Unauthenticated is enabled or not."}},"type":"object","required":["enabled"]},"aws-native:msk:ClusterVpcConnectivity":{"properties":{"clientAuthentication":{"$ref":"#/types/aws-native:msk:ClusterVpcConnectivityClientAuthentication","description":"VPC connection control settings for brokers."}},"type":"object"},"aws-native:msk:ClusterVpcConnectivityClientAuthentication":{"properties":{"sasl":{"$ref":"#/types/aws-native:msk:ClusterVpcConnectivitySasl","description":"Details for VpcConnectivity ClientAuthentication using SASL."},"tls":{"$ref":"#/types/aws-native:msk:ClusterVpcConnectivityTls","description":"Details for VpcConnectivity ClientAuthentication using TLS."}},"type":"object"},"aws-native:msk:ClusterVpcConnectivityIam":{"properties":{"enabled":{"type":"boolean","description":"SASL/IAM authentication is enabled or not."}},"type":"object","required":["enabled"]},"aws-native:msk:ClusterVpcConnectivitySasl":{"properties":{"iam":{"$ref":"#/types/aws-native:msk:ClusterVpcConnectivityIam","description":"Details for ClientAuthentication using IAM for VpcConnectivity."},"scram":{"$ref":"#/types/aws-native:msk:ClusterVpcConnectivityScram","description":"Details for SASL/SCRAM client authentication for VpcConnectivity."}},"type":"object"},"aws-native:msk:ClusterVpcConnectivityScram":{"properties":{"enabled":{"type":"boolean","description":"SASL/SCRAM authentication is enabled or not."}},"type":"object","required":["enabled"]},"aws-native:msk:ClusterVpcConnectivityTls":{"properties":{"enabled":{"type":"boolean","description":"TLS authentication is enabled or not."}},"type":"object","required":["enabled"]},"aws-native:msk:ConfigurationLatestRevision":{"properties":{"creationTime":{"type":"string","description":"The time when the configuration revision was created."},"description":{"type":"string","description":"The description of the configuration revision."},"revision":{"type":"integer","description":"The revision number."}},"type":"object"},"aws-native:msk:ReplicatorAmazonMskCluster":{"description":"Details of an Amazon MSK cluster.","properties":{"mskClusterArn":{"type":"string","description":"The ARN of an Amazon MSK cluster."}},"type":"object","required":["mskClusterArn"]},"aws-native:msk:ReplicatorConsumerGroupReplication":{"description":"Configuration relating to consumer group replication.","properties":{"consumerGroupsToExclude":{"type":"array","items":{"type":"string"},"description":"List of regular expression patterns indicating the consumer groups that should not be replicated."},"consumerGroupsToReplicate":{"type":"array","items":{"type":"string"},"description":"List of regular expression patterns indicating the consumer groups to copy."},"detectAndCopyNewConsumerGroups":{"type":"boolean","description":"Whether to periodically check for new consumer groups."},"synchroniseConsumerGroupOffsets":{"type":"boolean","description":"Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster."}},"type":"object","required":["consumerGroupsToReplicate"]},"aws-native:msk:ReplicatorKafkaCluster":{"description":"Details of a Kafka cluster for replication.","properties":{"amazonMskCluster":{"$ref":"#/types/aws-native:msk:ReplicatorAmazonMskCluster","description":"Details of an Amazon MSK cluster. Exactly one of AmazonMskCluster is required."},"vpcConfig":{"$ref":"#/types/aws-native:msk:ReplicatorKafkaClusterClientVpcConfig","description":"Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster."}},"type":"object","required":["amazonMskCluster","vpcConfig"]},"aws-native:msk:ReplicatorKafkaClusterClientVpcConfig":{"description":"Details of an Amazon VPC which has network connectivity to the Kafka cluster.","properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The AWS security groups to associate with the elastic network interfaces in order to specify what the replicator has access to. If a security group is not specified, the default security group associated with the VPC is used."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets."}},"type":"object","required":["subnetIds"]},"aws-native:msk:ReplicatorReplicationInfo":{"description":"Specifies configuration for replication between a source and target Kafka cluster.","properties":{"consumerGroupReplication":{"$ref":"#/types/aws-native:msk:ReplicatorConsumerGroupReplication","description":"Configuration relating to consumer group replication."},"sourceKafkaClusterArn":{"type":"string","description":"Amazon Resource Name of the source Kafka cluster.","replaceOnChanges":true},"targetCompressionType":{"$ref":"#/types/aws-native:msk:ReplicatorReplicationInfoTargetCompressionType","description":"The type of compression to use writing records to target Kafka cluster.","replaceOnChanges":true},"targetKafkaClusterArn":{"type":"string","description":"Amazon Resource Name of the target Kafka cluster.","replaceOnChanges":true},"topicReplication":{"$ref":"#/types/aws-native:msk:ReplicatorTopicReplication","description":"Configuration relating to topic replication."}},"type":"object","required":["consumerGroupReplication","sourceKafkaClusterArn","targetCompressionType","targetKafkaClusterArn","topicReplication"]},"aws-native:msk:ReplicatorReplicationInfoTargetCompressionType":{"description":"The type of compression to use writing records to target Kafka cluster.","type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Gzip","value":"GZIP"},{"name":"Snappy","value":"SNAPPY"},{"name":"Lz4","value":"LZ4"},{"name":"Zstd","value":"ZSTD"}]},"aws-native:msk:ReplicatorReplicationStartingPosition":{"description":"Configuration for specifying the position in the topics to start replicating from.","properties":{"type":{"$ref":"#/types/aws-native:msk:ReplicatorReplicationStartingPositionType","description":"The type of replication starting position."}},"type":"object"},"aws-native:msk:ReplicatorReplicationStartingPositionType":{"description":"The type of replication starting position.","type":"string","enum":[{"name":"Latest","value":"LATEST"},{"name":"Earliest","value":"EARLIEST"}]},"aws-native:msk:ReplicatorReplicationTopicNameConfiguration":{"description":"Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.","properties":{"type":{"$ref":"#/types/aws-native:msk:ReplicatorReplicationTopicNameConfigurationType","description":"The type of replication topic name configuration, identical to upstream topic name or prefixed with source cluster alias."}},"type":"object"},"aws-native:msk:ReplicatorReplicationTopicNameConfigurationType":{"description":"The type of replicated topic name.","type":"string","enum":[{"name":"PrefixedWithSourceClusterAlias","value":"PREFIXED_WITH_SOURCE_CLUSTER_ALIAS"},{"name":"Identical","value":"IDENTICAL"}]},"aws-native:msk:ReplicatorTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:msk:ReplicatorTopicReplication":{"properties":{"copyAccessControlListsForTopics":{"type":"boolean","description":"Whether to periodically configure remote topic ACLs to match their corresponding upstream topics."},"copyTopicConfigurations":{"type":"boolean","description":"Whether to periodically configure remote topics to match their corresponding upstream topics."},"detectAndCopyNewTopics":{"type":"boolean","description":"Whether to periodically check for new topics and partitions."},"startingPosition":{"$ref":"#/types/aws-native:msk:ReplicatorReplicationStartingPosition","description":"Configuration for specifying the position in the topics to start replicating from.","replaceOnChanges":true},"topicNameConfiguration":{"$ref":"#/types/aws-native:msk:ReplicatorReplicationTopicNameConfiguration","description":"Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.","replaceOnChanges":true},"topicsToExclude":{"type":"array","items":{"type":"string"},"description":"List of regular expression patterns indicating the topics that should not be replicated."},"topicsToReplicate":{"type":"array","items":{"type":"string"},"description":"List of regular expression patterns indicating the topics to copy."}},"type":"object","required":["topicsToReplicate"]},"aws-native:msk:ServerlessClusterClientAuthentication":{"properties":{"sasl":{"$ref":"#/types/aws-native:msk:ServerlessClusterSasl","description":"Details for client authentication using SASL. To turn on SASL, you must also turn on `EncryptionInTransit` by setting `inCluster` to true. You must set `clientBroker` to either `TLS` or `TLS_PLAINTEXT` . If you choose `TLS_PLAINTEXT` , then you must also set `unauthenticated` to true."}},"type":"object","required":["sasl"]},"aws-native:msk:ServerlessClusterIam":{"properties":{"enabled":{"type":"boolean","description":"SASL/IAM authentication is enabled or not."}},"type":"object","required":["enabled"]},"aws-native:msk:ServerlessClusterSasl":{"properties":{"iam":{"$ref":"#/types/aws-native:msk:ServerlessClusterIam","description":"Details for ClientAuthentication using IAM."}},"type":"object","required":["iam"]},"aws-native:msk:ServerlessClusterVpcConfig":{"properties":{"securityGroups":{"type":"array","items":{"type":"string"}},"subnetIds":{"type":"array","items":{"type":"string"}}},"type":"object","required":["subnetIds"]},"aws-native:msk:VpcConnectionAuthentication":{"description":"The type of private link authentication","type":"string","enum":[{"name":"SaslIam","value":"SASL_IAM"},{"name":"SaslScram","value":"SASL_SCRAM"},{"name":"Tls","value":"TLS"}]},"aws-native:mwaa:EnvironmentEndpointManagement":{"description":"Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.","type":"string","enum":[{"name":"Customer","value":"CUSTOMER"},{"name":"Service","value":"SERVICE"}]},"aws-native:mwaa:EnvironmentLoggingConfiguration":{"description":"Logging configuration for the environment.","properties":{"dagProcessingLogs":{"$ref":"#/types/aws-native:mwaa:EnvironmentModuleLoggingConfiguration","description":"Defines the processing logs sent to CloudWatch Logs and the logging level to send."},"schedulerLogs":{"$ref":"#/types/aws-native:mwaa:EnvironmentModuleLoggingConfiguration","description":"Defines the scheduler logs sent to CloudWatch Logs and the logging level to send."},"taskLogs":{"$ref":"#/types/aws-native:mwaa:EnvironmentModuleLoggingConfiguration","description":"Defines the task logs sent to CloudWatch Logs and the logging level to send."},"webserverLogs":{"$ref":"#/types/aws-native:mwaa:EnvironmentModuleLoggingConfiguration","description":"Defines the web server logs sent to CloudWatch Logs and the logging level to send."},"workerLogs":{"$ref":"#/types/aws-native:mwaa:EnvironmentModuleLoggingConfiguration","description":"Defines the worker logs sent to CloudWatch Logs and the logging level to send."}},"type":"object"},"aws-native:mwaa:EnvironmentLoggingLevel":{"type":"string","enum":[{"name":"Critical","value":"CRITICAL"},{"name":"Error","value":"ERROR"},{"name":"Warning","value":"WARNING"},{"name":"Info","value":"INFO"},{"name":"Debug","value":"DEBUG"}]},"aws-native:mwaa:EnvironmentModuleLoggingConfiguration":{"description":"Logging configuration for a specific airflow component.","properties":{"cloudWatchLogGroupArn":{"type":"string","description":"The ARN of the CloudWatch Logs log group for each type of Apache Airflow log type that you have enabled.\n\n\u003e `CloudWatchLogGroupArn` is available only as a return value, accessible when specified as an attribute in the [`Fn:GetAtt`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#aws-resource-mwaa-environment-return-values) intrinsic function. Any value you provide for `CloudWatchLogGroupArn` is discarded by Amazon MWAA."},"enabled":{"type":"boolean","description":"Indicates whether to enable the Apache Airflow log type (e.g. `DagProcessingLogs` ) in CloudWatch Logs."},"logLevel":{"$ref":"#/types/aws-native:mwaa:EnvironmentLoggingLevel","description":"Defines the Apache Airflow logs to send for the log type (e.g. `DagProcessingLogs` ) to CloudWatch Logs."}},"type":"object"},"aws-native:mwaa:EnvironmentNetworkConfiguration":{"description":"Configures the network resources of the environment.","properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"A list of security groups to use for the environment."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones.","replaceOnChanges":true}},"type":"object"},"aws-native:mwaa:EnvironmentWebserverAccessMode":{"description":"Choice for mode of webserver access including over public internet or via private VPC endpoint.","type":"string","enum":[{"name":"PrivateOnly","value":"PRIVATE_ONLY"},{"name":"PublicOnly","value":"PUBLIC_ONLY"}]},"aws-native:mwaa:EnvironmentWorkerReplacementStrategy":{"description":"The worker replacement strategy to use when updating the environment. Valid values: `FORCED`, `GRACEFUL`. FORCED means Apache Airflow workers will be stopped and replaced without waiting for tasks to complete before an update. GRACEFUL means Apache Airflow workers will be able to complete running tasks for up to 12 hours during an update before being stopped and replaced.","type":"string","enum":[{"name":"Forced","value":"FORCED"},{"name":"Graceful","value":"GRACEFUL"}]},"aws-native:mwaaserverless:WorkflowEncryptionConfiguration":{"properties":{"kmsKeyId":{"type":"string"},"type":{"$ref":"#/types/aws-native:mwaaserverless:WorkflowEncryptionConfigurationType"}},"type":"object","required":["type"]},"aws-native:mwaaserverless:WorkflowEncryptionConfigurationType":{"type":"string","enum":[{"name":"AwsManagedKey","value":"AWS_MANAGED_KEY"},{"name":"CustomerManagedKey","value":"CUSTOMER_MANAGED_KEY"}]},"aws-native:mwaaserverless:WorkflowLoggingConfiguration":{"properties":{"logGroupName":{"type":"string"}},"type":"object","required":["logGroupName"]},"aws-native:mwaaserverless:WorkflowNetworkConfiguration":{"properties":{"securityGroupIds":{"type":"array","items":{"type":"string"}},"subnetIds":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:mwaaserverless:WorkflowS3Location":{"properties":{"bucket":{"type":"string"},"objectKey":{"type":"string"},"versionId":{"type":"string"}},"type":"object","required":["bucket","objectKey"]},"aws-native:mwaaserverless:WorkflowScheduleConfiguration":{"properties":{"cronExpression":{"type":"string"}},"type":"object"},"aws-native:mwaaserverless:WorkflowStatus":{"type":"string","enum":[{"name":"Ready","value":"READY"},{"name":"Deleting","value":"DELETING"}]},"aws-native:neptune:DbClusterDbClusterRole":{"description":"Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.","properties":{"featureName":{"type":"string","description":"The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune API Reference."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster."}},"type":"object","required":["roleArn"]},"aws-native:neptune:DbClusterParameterGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:neptune:DbClusterServerlessScalingConfiguration":{"description":"Contains the scaling configuration of an Neptune Serverless DB cluster.","properties":{"maxCapacity":{"type":"number","description":"The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128."},"minCapacity":{"type":"number","description":"The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128."}},"type":"object","required":["maxCapacity","minCapacity"]},"aws-native:neptune:DbClusterTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key"]},"aws-native:neptune:DbInstanceTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:neptune:DbParameterGroupTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:neptune:DbSubnetGroupTag":{"description":"An optional array of key-value pairs to apply to this DB subnet group.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:neptune:EventSubscriptionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with `aws:` or `rds:` . The string can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\")."},"value":{"type":"string","description":"A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with `aws:` or `rds:` . The string can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\")."}},"type":"object","required":["key","value"]},"aws-native:neptunegraph:GraphTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key"]},"aws-native:neptunegraph:GraphVectorSearchConfiguration":{"description":"The vector search configuration.","properties":{"vectorSearchDimension":{"type":"integer","description":"The vector search dimension"}},"type":"object","required":["vectorSearchDimension"]},"aws-native:networkfirewall:FirewallAvailabilityZoneMapping":{"properties":{"availabilityZone":{"type":"string","description":"A AvailabilityZone"}},"type":"object","required":["availabilityZone"]},"aws-native:networkfirewall:FirewallEnabledAnalysisType":{"description":"An analysis type.","type":"string","enum":[{"name":"TlsSni","value":"TLS_SNI"},{"name":"HttpHost","value":"HTTP_HOST"}]},"aws-native:networkfirewall:FirewallPolicy":{"properties":{"enableTlsSessionHolding":{"type":"boolean","description":"When true, prevents TCP and TLS packets from reaching destination servers until TLS Inspection has evaluated Server Name Indication (SNI) rules. Requires an associated TLS Inspection configuration."},"policyVariables":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyPolicyVariablesProperties","description":"Contains variables that you can use to override default Suricata settings in your firewall policy."},"statefulDefaultActions":{"type":"array","items":{"type":"string"},"description":"The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.\n\nValid values of the stateful default action:\n\n- aws:drop_strict\n- aws:drop_established\n- aws:alert_strict\n- aws:alert_established\n\nFor more information, see [Strict evaluation order](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide* ."},"statefulEngineOptions":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyStatefulEngineOptions","description":"Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings."},"statefulRuleGroupReferences":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyStatefulRuleGroupReference"},"description":"References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules."},"statelessCustomActions":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyCustomAction"},"description":"The custom action definitions that are available for use in the firewall policy's `StatelessDefaultActions` setting. You name each custom action that you define, and then you can use it by name in your default actions specifications."},"statelessDefaultActions":{"type":"array","items":{"type":"string"},"description":"The actions to take on a packet if it doesn't match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify `aws:forward_to_sfe` .\n\nYou must specify one of the standard actions: `aws:pass` , `aws:drop` , or `aws:forward_to_sfe` . In addition, you can specify custom actions that are compatible with your standard section choice.\n\nFor example, you could specify `[\"aws:pass\"]` or you could specify `[\"aws:pass\", \"customActionName\"]` . For information about compatibility, see the custom action descriptions."},"statelessFragmentDefaultActions":{"type":"array","items":{"type":"string"},"description":"The actions to take on a fragmented packet if it doesn't match any of the stateless rules in the policy. If you want non-matching fragmented packets to be forwarded for stateful inspection, specify `aws:forward_to_sfe` .\n\nYou must specify one of the standard actions: `aws:pass` , `aws:drop` , or `aws:forward_to_sfe` . In addition, you can specify custom actions that are compatible with your standard section choice.\n\nFor example, you could specify `[\"aws:pass\"]` or you could specify `[\"aws:pass\", \"customActionName\"]` . For information about compatibility, see the custom action descriptions."},"statelessRuleGroupReferences":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyStatelessRuleGroupReference"},"description":"References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules."},"tlsInspectionConfigurationArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the TLS inspection configuration."}},"type":"object","required":["statelessDefaultActions","statelessFragmentDefaultActions"]},"aws-native:networkfirewall:FirewallPolicyActionDefinition":{"properties":{"publishMetricAction":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyPublishMetricAction","description":"Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.\n\nYou can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it."}},"type":"object"},"aws-native:networkfirewall:FirewallPolicyCustomAction":{"properties":{"actionDefinition":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyActionDefinition","description":"The custom action associated with the action name."},"actionName":{"type":"string","description":"The descriptive name of the custom action. You can't change the name of a custom action after you create it."}},"type":"object","required":["actionDefinition","actionName"]},"aws-native:networkfirewall:FirewallPolicyDimension":{"properties":{"value":{"type":"string","description":"The value to use in the custom metric dimension."}},"type":"object","required":["value"]},"aws-native:networkfirewall:FirewallPolicyIpSet":{"properties":{"definition":{"type":"array","items":{"type":"string"},"description":"The list of IP addresses and address ranges, in CIDR notation."}},"type":"object"},"aws-native:networkfirewall:FirewallPolicyOverrideAction":{"type":"string","enum":[{"name":"DropToAlert","value":"DROP_TO_ALERT"}]},"aws-native:networkfirewall:FirewallPolicyPolicyVariablesProperties":{"description":"Contains variables that you can use to override default Suricata settings in your firewall policy.","properties":{"ruleVariables":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyIpSet"}}},"type":"object"},"aws-native:networkfirewall:FirewallPolicyPublishMetricAction":{"properties":{"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyDimension"}}},"type":"object","required":["dimensions"]},"aws-native:networkfirewall:FirewallPolicyRuleOrder":{"type":"string","enum":[{"name":"DefaultActionOrder","value":"DEFAULT_ACTION_ORDER"},{"name":"StrictOrder","value":"STRICT_ORDER"}]},"aws-native:networkfirewall:FirewallPolicyStatefulEngineOptions":{"properties":{"flowTimeouts":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyStatefulEngineOptionsFlowTimeoutsProperties","description":"Configures the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle."},"ruleOrder":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyRuleOrder","description":"Indicates how to manage the order of stateful rule evaluation for the policy. `DEFAULT_ACTION_ORDER` is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see [Evaluation order for stateful rules](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide* ."},"streamExceptionPolicy":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyStreamExceptionPolicy","description":"Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.\n\n- `DROP` - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.\n- `CONTINUE` - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to `drop http` traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a `flow:stateless` rule would still match, as would the `aws:drop_strict` default action.\n- `REJECT` - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic."}},"type":"object"},"aws-native:networkfirewall:FirewallPolicyStatefulEngineOptionsFlowTimeoutsProperties":{"description":"Configures the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle.","properties":{"tcpIdleTimeoutSeconds":{"type":"integer"}},"type":"object"},"aws-native:networkfirewall:FirewallPolicyStatefulRuleGroupOverride":{"properties":{"action":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyOverrideAction","description":"The action that changes the rule group from `DROP` to `ALERT` . This only applies to managed rule groups."}},"type":"object"},"aws-native:networkfirewall:FirewallPolicyStatefulRuleGroupReference":{"properties":{"deepThreatInspection":{"type":"boolean","description":"AWS Network Firewall plans to augment the active threat defense managed rule group with an additional deep threat inspection capability. When this capability is released, AWS will analyze service logs of network traffic processed by these rule groups to identify threat indicators across customers. AWS will use these threat indicators to improve the active threat defense managed rule groups and protect the security of AWS customers and services.\n\n\u003e Customers can opt-out of deep threat inspection at any time through the AWS Network Firewall console or API. When customers opt out, AWS Network Firewall will not use the network traffic processed by those customers' active threat defense rule groups for rule group improvement."},"override":{"$ref":"#/types/aws-native:networkfirewall:FirewallPolicyStatefulRuleGroupOverride","description":"The action that allows the policy owner to override the behavior of the rule group within a policy."},"priority":{"type":"integer","description":"An integer setting that indicates the order in which to run the stateful rule groups in a single firewall policy. This setting only applies to firewall policies that specify the `STRICT_ORDER` rule order in the stateful engine options settings.\n\nNetwork Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.\n\nYou can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on."},"resourceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the stateful rule group."}},"type":"object","required":["resourceArn"]},"aws-native:networkfirewall:FirewallPolicyStatelessRuleGroupReference":{"properties":{"priority":{"type":"integer","description":"An integer setting that indicates the order in which to run the stateless rule groups in a single firewall policy. Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy."},"resourceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the stateless rule group."}},"type":"object","required":["priority","resourceArn"]},"aws-native:networkfirewall:FirewallPolicyStreamExceptionPolicy":{"type":"string","enum":[{"name":"Drop","value":"DROP"},{"name":"Continue","value":"CONTINUE"},{"name":"Reject","value":"REJECT"}]},"aws-native:networkfirewall:FirewallPolicyTag":{"properties":{"key":{"type":"string","description":"The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive."},"value":{"type":"string","description":"The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive."}},"type":"object","required":["key","value"]},"aws-native:networkfirewall:FirewallSubnetMapping":{"properties":{"ipAddressType":{"type":"string","description":"A IPAddressType"},"subnetId":{"type":"string","description":"A SubnetId."}},"type":"object","required":["subnetId"]},"aws-native:networkfirewall:FirewallTag":{"properties":{"key":{"type":"string","description":"The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive."},"value":{"type":"string","description":"The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive."}},"type":"object","required":["key","value"]},"aws-native:networkfirewall:LoggingConfiguration":{"properties":{"logDestinationConfigs":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:LoggingConfigurationLogDestinationConfig"},"description":"Defines the logging destinations for the logs for a firewall. Network Firewall generates logs for stateful rule groups."}},"type":"object","required":["logDestinationConfigs"]},"aws-native:networkfirewall:LoggingConfigurationLogDestinationConfig":{"properties":{"logDestination":{"type":"object","additionalProperties":{"type":"string"},"description":"A key-value pair to configure the logDestinations."},"logDestinationType":{"$ref":"#/types/aws-native:networkfirewall:LoggingConfigurationLogDestinationConfigLogDestinationType","description":"The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream."},"logType":{"$ref":"#/types/aws-native:networkfirewall:LoggingConfigurationLogDestinationConfigLogType","description":"The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.\n\n- `ALERT` - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see the `StatefulRule` property.\n- `FLOW` - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.\n- `TLS` - Logs for events that are related to TLS inspection. For more information, see [Inspecting SSL/TLS traffic with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-configurations.html) in the *Network Firewall Developer Guide* ."}},"type":"object","required":["logDestination","logDestinationType","logType"]},"aws-native:networkfirewall:LoggingConfigurationLogDestinationConfigLogDestinationType":{"description":"The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream.","type":"string","enum":[{"name":"S3","value":"S3"},{"name":"CloudWatchLogs","value":"CloudWatchLogs"},{"name":"KinesisDataFirehose","value":"KinesisDataFirehose"}]},"aws-native:networkfirewall:LoggingConfigurationLogDestinationConfigLogType":{"description":"The type of log to record. You can record the following types of logs from your Network Firewall stateful engine.\n\n- `ALERT` - Logs for traffic that matches your stateful rules and that have an action that sends an alert. A stateful rule sends alerts for the rule actions DROP, ALERT, and REJECT. For more information, see the `StatefulRule` property.\n- `FLOW` - Standard network traffic flow logs. The stateful rules engine records flow logs for all network traffic that it receives. Each flow log record captures the network flow for a specific standard stateless rule group.\n- `TLS` - Logs for events that are related to TLS inspection. For more information, see [Inspecting SSL/TLS traffic with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-configurations.html) in the *Network Firewall Developer Guide* .","type":"string","enum":[{"name":"Alert","value":"ALERT"},{"name":"Flow","value":"FLOW"},{"name":"Tls","value":"TLS"}]},"aws-native:networkfirewall:RuleGroup":{"properties":{"referenceSets":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupReferenceSets","description":"The reference sets for the stateful rule group."},"ruleVariables":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupRuleVariables","description":"Settings that are available for use in the rules in the rule group. You can only use these for stateful rule groups."},"rulesSource":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupRulesSource","description":"The stateful rules or stateless rules for the rule group."},"statefulRuleOptions":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupStatefulRuleOptions","description":"Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings. Some limitations apply; for more information, see [Strict evaluation order](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-limitations-caveats.html) in the *AWS Network Firewall Developer Guide* ."}},"type":"object","required":["rulesSource"]},"aws-native:networkfirewall:RuleGroupActionDefinition":{"properties":{"publishMetricAction":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupPublishMetricAction","description":"Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.\n\nYou can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it."}},"type":"object"},"aws-native:networkfirewall:RuleGroupAddress":{"properties":{"addressDefinition":{"type":"string","description":"Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.\n\nExamples:\n\n- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` .\n- To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` .\n- To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128` .\n- To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64` .\n\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) ."}},"type":"object","required":["addressDefinition"]},"aws-native:networkfirewall:RuleGroupCustomAction":{"properties":{"actionDefinition":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupActionDefinition","description":"The custom action associated with the action name."},"actionName":{"type":"string","description":"The descriptive name of the custom action. You can't change the name of a custom action after you create it."}},"type":"object","required":["actionDefinition","actionName"]},"aws-native:networkfirewall:RuleGroupDimension":{"properties":{"value":{"type":"string","description":"The value to use in the custom metric dimension."}},"type":"object","required":["value"]},"aws-native:networkfirewall:RuleGroupGeneratedRulesType":{"type":"string","enum":[{"name":"Allowlist","value":"ALLOWLIST"},{"name":"Denylist","value":"DENYLIST"},{"name":"Alertlist","value":"ALERTLIST"},{"name":"Rejectlist","value":"REJECTLIST"}]},"aws-native:networkfirewall:RuleGroupHeader":{"properties":{"destination":{"type":"string","description":"The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify `ANY` .\n\nSpecify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.\n\nExamples:\n\n- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` .\n- To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` .\n- To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128` .\n- To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64` .\n\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) ."},"destinationPort":{"type":"string","description":"The destination port to inspect for. You can specify an individual port, for example `1994` and you can specify a port range, for example `1990:1994` . To match with any port, specify `ANY` ."},"direction":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupHeaderDirection","description":"The direction of traffic flow to inspect. If set to `ANY` , the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to `FORWARD` , the inspection only matches traffic going from the source to the destination."},"protocol":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupHeaderProtocol","description":"The protocol to inspect for. To specify all, you can use `IP` , because all traffic on AWS and on the internet is IP."},"source":{"type":"string","description":"The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify `ANY` .\n\nSpecify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.\n\nExamples:\n\n- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` .\n- To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` .\n- To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128` .\n- To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64` .\n\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) ."},"sourcePort":{"type":"string","description":"The source port to inspect for. You can specify an individual port, for example `1994` and you can specify a port range, for example `1990:1994` . To match with any port, specify `ANY` ."}},"type":"object","required":["destination","destinationPort","direction","protocol","source","sourcePort"]},"aws-native:networkfirewall:RuleGroupHeaderDirection":{"description":"The direction of traffic flow to inspect. If set to `ANY` , the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to `FORWARD` , the inspection only matches traffic going from the source to the destination.","type":"string","enum":[{"name":"Forward","value":"FORWARD"},{"name":"Any","value":"ANY"}]},"aws-native:networkfirewall:RuleGroupHeaderProtocol":{"description":"The protocol to inspect for. To specify all, you can use `IP` , because all traffic on AWS and on the internet is IP.","type":"string","enum":[{"name":"Ip","value":"IP"},{"name":"Tcp","value":"TCP"},{"name":"Udp","value":"UDP"},{"name":"Icmp","value":"ICMP"},{"name":"Http","value":"HTTP"},{"name":"Ftp","value":"FTP"},{"name":"Tls","value":"TLS"},{"name":"Smb","value":"SMB"},{"name":"Dns","value":"DNS"},{"name":"Dcerpc","value":"DCERPC"},{"name":"Ssh","value":"SSH"},{"name":"Smtp","value":"SMTP"},{"name":"Imap","value":"IMAP"},{"name":"Msn","value":"MSN"},{"name":"Krb5","value":"KRB5"},{"name":"Ikev2","value":"IKEV2"},{"name":"Tftp","value":"TFTP"},{"name":"Ntp","value":"NTP"},{"name":"Dhcp","value":"DHCP"}]},"aws-native:networkfirewall:RuleGroupIpSet":{"properties":{"definition":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:networkfirewall:RuleGroupIpSetReference":{"properties":{"referenceArn":{"type":"string"}},"type":"object"},"aws-native:networkfirewall:RuleGroupMatchAttributes":{"properties":{"destinationPorts":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupPortRange"},"description":"The destination port to inspect for. You can specify an individual port, for example `1994` and you can specify a port range, for example `1990:1994` . To match with any port, specify `ANY` .\n\nThis setting is only used for protocols 6 (TCP) and 17 (UDP)."},"destinations":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupAddress"},"description":"The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address."},"protocols":{"type":"array","items":{"type":"integer"},"description":"The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol."},"sourcePorts":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupPortRange"},"description":"The source port to inspect for. You can specify an individual port, for example `1994` and you can specify a port range, for example `1990:1994` . To match with any port, specify `ANY` .\n\nIf not specified, this matches with any source port.\n\nThis setting is only used for protocols 6 (TCP) and 17 (UDP)."},"sources":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupAddress"},"description":"The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address."},"tcpFlags":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupTcpFlagField"},"description":"The TCP flags and masks to inspect for. If not specified, this matches with any settings. This setting is only used for protocol 6 (TCP)."}},"type":"object"},"aws-native:networkfirewall:RuleGroupPortRange":{"properties":{"fromPort":{"type":"integer","description":"The lower limit of the port range. This must be less than or equal to the `ToPort` specification."},"toPort":{"type":"integer","description":"The upper limit of the port range. This must be greater than or equal to the `FromPort` specification."}},"type":"object","required":["fromPort","toPort"]},"aws-native:networkfirewall:RuleGroupPortSet":{"properties":{"definition":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:networkfirewall:RuleGroupPublishMetricAction":{"properties":{"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupDimension"}}},"type":"object","required":["dimensions"]},"aws-native:networkfirewall:RuleGroupReferenceSets":{"properties":{"ipSetReferences":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupIpSetReference"},"description":"The IP set references to use in the stateful rule group."}},"type":"object"},"aws-native:networkfirewall:RuleGroupRuleDefinition":{"properties":{"actions":{"type":"array","items":{"type":"string"},"description":"The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action and you can add custom actions.\n\n\u003e Network Firewall only forwards a packet for stateful rule inspection if you specify `aws:forward_to_sfe` for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify `aws:forward_to_sfe` for the `StatelessDefaultActions` setting for the firewall policy. \n\nFor every rule, you must specify exactly one of the following standard actions.\n\n- *aws:pass* - Discontinues all inspection of the packet and permits it to go to its intended destination.\n- *aws:drop* - Discontinues all inspection of the packet and blocks it from going to its intended destination.\n- *aws:forward_to_sfe* - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.\n\nAdditionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this `Actions` setting.\n\nTo provide more than one action in this setting, separate the settings with a comma. For example, if you have a publish metrics custom action that you've named `MyMetricsAction` , then you could specify the standard action `aws:pass` combined with the custom action using `[\"aws:pass\", \"MyMetricsAction\"]` ."},"matchAttributes":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupMatchAttributes","description":"Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags."}},"type":"object","required":["actions","matchAttributes"]},"aws-native:networkfirewall:RuleGroupRuleOption":{"properties":{"keyword":{"type":"string","description":"The Suricata rule option keywords. For Network Firewall , the keyword signature ID (sid) is required in the format `sid:112233` . The sid must be unique within the rule group. For information about Suricata rule option keywords, see [Rule options](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options) ."},"settings":{"type":"array","items":{"type":"string"},"description":"The Suricata rule option settings. Settings have zero or more values, and the number of possible settings and required settings depends on the keyword. The format for Settings is `number` . For information about Suricata rule option settings, see [Rule options](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options) ."}},"type":"object","required":["keyword"]},"aws-native:networkfirewall:RuleGroupRuleOrder":{"type":"string","enum":[{"name":"DefaultActionOrder","value":"DEFAULT_ACTION_ORDER"},{"name":"StrictOrder","value":"STRICT_ORDER"}]},"aws-native:networkfirewall:RuleGroupRuleVariables":{"properties":{"ipSets":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupIpSet"},"description":"A list of IP addresses and address ranges, in CIDR notation."},"portSets":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupPortSet"},"description":"A list of port ranges."}},"type":"object"},"aws-native:networkfirewall:RuleGroupRulesSource":{"properties":{"rulesSourceList":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupRulesSourceList","description":"Stateful inspection criteria for a domain list rule group."},"rulesString":{"type":"string","description":"Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.\n\nThese rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.\n\n\u003e You can't use the `priority` keyword if the `RuleOrder` option in StatefulRuleOptions is set to `STRICT_ORDER` ."},"statefulRules":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupStatefulRule"},"description":"An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata `Rules` format, see [Rules Format](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-7.0.3/rules/intro.html) ."},"statelessRulesAndCustomActions":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupStatelessRulesAndCustomActions","description":"Stateless inspection criteria to be used in a stateless rule group."}},"type":"object"},"aws-native:networkfirewall:RuleGroupRulesSourceList":{"properties":{"generatedRulesType":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupGeneratedRulesType","description":"Whether you want to apply allow, reject, alert, or drop behavior to the domains in your target list.\n\n\u003e When logging is enabled and you choose Alert, traffic that matches the domain specifications generates an alert in the firewall's logs. Then, traffic either passes, is rejected, or drops based on other rules in the firewall policy."},"targetTypes":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupTargetType"},"description":"The types of targets to inspect for. Valid values are `TLS_SNI` and `HTTP_HOST` ."},"targets":{"type":"array","items":{"type":"string"},"description":"The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:\n\n- Explicit names. For example, `abc.example.com` matches only the domain `abc.example.com` .\n- Names that use a domain wildcard, which you indicate with an initial ' `.` '. For example, `.example.com` matches `example.com` and matches all subdomains of `example.com` , such as `abc.example.com` and `www.example.com` ."}},"type":"object","required":["generatedRulesType","targetTypes","targets"]},"aws-native:networkfirewall:RuleGroupStatefulRule":{"properties":{"action":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupStatefulRuleAction","description":"Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.\n\nThe actions for a stateful rule are defined as follows:\n\n- *PASS* - Permits the packets to go to the intended destination.\n- *DROP* - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the firewall logging configuration.\n- *REJECT* - Drops traffic that matches the conditions of the stateful rule and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a `RST` bit contained in the TCP header flags. `REJECT` is available only for TCP traffic.\n- *ALERT* - Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the firewall logging configuration.\n\nYou can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with `ALERT` action, verify in the logs that the rule is filtering as you want, then change the action to `DROP` .\n- *REJECT* - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a `RST` bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the firewall logging configuration.\n\n`REJECT` isn't currently available for use with IMAP and FTP protocols."},"header":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupHeader","description":"The stateful inspection criteria for this rule, used to inspect traffic flows."},"ruleOptions":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupRuleOption"},"description":"Additional settings for a stateful rule, provided as keywords and settings."}},"type":"object","required":["action","header","ruleOptions"]},"aws-native:networkfirewall:RuleGroupStatefulRuleAction":{"description":"Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.\n\nThe actions for a stateful rule are defined as follows:\n\n- *PASS* - Permits the packets to go to the intended destination.\n- *DROP* - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the firewall logging configuration.\n- *REJECT* - Drops traffic that matches the conditions of the stateful rule and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a `RST` bit contained in the TCP header flags. `REJECT` is available only for TCP traffic.\n- *ALERT* - Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the firewall logging configuration.\n\nYou can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with `ALERT` action, verify in the logs that the rule is filtering as you want, then change the action to `DROP` .\n- *REJECT* - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a `RST` bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the firewall logging configuration.\n\n`REJECT` isn't currently available for use with IMAP and FTP protocols.","type":"string","enum":[{"name":"Pass","value":"PASS"},{"name":"Drop","value":"DROP"},{"name":"Alert","value":"ALERT"},{"name":"Reject","value":"REJECT"}]},"aws-native:networkfirewall:RuleGroupStatefulRuleOptions":{"properties":{"ruleOrder":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupRuleOrder","description":"Indicates how to manage the order of the rule evaluation for the rule group. `DEFAULT_ACTION_ORDER` is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see [Evaluation order for stateful rules](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide* ."}},"type":"object"},"aws-native:networkfirewall:RuleGroupStatelessRule":{"properties":{"priority":{"type":"integer","description":"Indicates the order in which to run this rule relative to all of the rules that are defined for a stateless rule group. Network Firewall evaluates the rules in a rule group starting with the lowest priority setting. You must ensure that the priority settings are unique for the rule group.\n\nEach stateless rule group uses exactly one `StatelessRulesAndCustomActions` object, and each `StatelessRulesAndCustomActions` contains exactly one `StatelessRules` object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any single `StatelessRules` object.\n\nYou can change the priority settings of your rules at any time. To make it easier to insert rules later, number them so there's a wide range in between, for example use 100, 200, and so on."},"ruleDefinition":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupRuleDefinition","description":"Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria."}},"type":"object","required":["priority","ruleDefinition"]},"aws-native:networkfirewall:RuleGroupStatelessRulesAndCustomActions":{"properties":{"customActions":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupCustomAction"},"description":"Defines an array of individual custom action definitions that are available for use by the stateless rules in this `StatelessRulesAndCustomActions` specification. You name each custom action that you define, and then you can use it by name in your stateless rule definition `Actions` specification."},"statelessRules":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupStatelessRule"},"description":"Defines the set of stateless rules for use in a stateless rule group."}},"type":"object","required":["statelessRules"]},"aws-native:networkfirewall:RuleGroupSummaryRuleOption":{"type":"string","enum":[{"name":"Sid","value":"SID"},{"name":"Msg","value":"MSG"},{"name":"Metadata","value":"METADATA"}]},"aws-native:networkfirewall:RuleGroupTag":{"properties":{"key":{"type":"string","description":"The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive."},"value":{"type":"string","description":"The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive."}},"type":"object","required":["key","value"]},"aws-native:networkfirewall:RuleGroupTargetType":{"type":"string","enum":[{"name":"TlsSni","value":"TLS_SNI"},{"name":"HttpHost","value":"HTTP_HOST"}]},"aws-native:networkfirewall:RuleGroupTcpFlag":{"type":"string","enum":[{"name":"Fin","value":"FIN"},{"name":"Syn","value":"SYN"},{"name":"Rst","value":"RST"},{"name":"Psh","value":"PSH"},{"name":"Ack","value":"ACK"},{"name":"Urg","value":"URG"},{"name":"Ece","value":"ECE"},{"name":"Cwr","value":"CWR"}]},"aws-native:networkfirewall:RuleGroupTcpFlagField":{"properties":{"flags":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupTcpFlag"},"description":"Used in conjunction with the `Masks` setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in the `Masks` setting.\n\nFor the flags that are specified in the masks setting, the following must be true for the packet to match:\n\n- The ones that are set in this flags setting must be set in the packet.\n- The ones that are not set in this flags setting must also not be set in the packet."},"masks":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupTcpFlag"},"description":"The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting."}},"type":"object","required":["flags"]},"aws-native:networkfirewall:RuleGroupTypeEnum":{"description":"Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains\nstateless rules. If it is stateful, it contains stateful rules.","type":"string","enum":[{"name":"Stateless","value":"STATELESS"},{"name":"Stateful","value":"STATEFUL"}]},"aws-native:networkfirewall:SummaryConfigurationProperties":{"description":"A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by `DescribeRuleGroupSummary` .\n\n- The `RuleOptions` specified in `SummaryConfiguration`\n- Rule metadata organization preferences","properties":{"ruleOptions":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:RuleGroupSummaryRuleOption"},"description":"Specifies the selected rule options returned by `DescribeRuleGroupSummary` ."}},"type":"object"},"aws-native:networkfirewall:TlsInspectionConfigurationAddress":{"properties":{"addressDefinition":{"type":"string","description":"Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.\n\nExamples:\n\n- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` .\n- To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` .\n- To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128` .\n- To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64` .\n\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) ."}},"type":"object","required":["addressDefinition"]},"aws-native:networkfirewall:TlsInspectionConfigurationPortRange":{"properties":{"fromPort":{"type":"integer","description":"The lower limit of the port range. This must be less than or equal to the `ToPort` specification."},"toPort":{"type":"integer","description":"The upper limit of the port range. This must be greater than or equal to the `FromPort` specification."}},"type":"object","required":["fromPort","toPort"]},"aws-native:networkfirewall:TlsInspectionConfigurationRevokedStatusAction":{"type":"string","enum":[{"name":"Pass","value":"PASS"},{"name":"Drop","value":"DROP"},{"name":"Reject","value":"REJECT"}]},"aws-native:networkfirewall:TlsInspectionConfigurationServerCertificate":{"properties":{"resourceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate that's used for inbound SSL/TLS inspection."}},"type":"object"},"aws-native:networkfirewall:TlsInspectionConfigurationServerCertificateConfiguration":{"properties":{"certificateAuthorityArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.\n\nThe following limitations apply:\n\n- You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.\n- You can't use certificates issued by Private Certificate Authority .\n\nFor more information about configuring certificates for outbound inspection, see [Using SSL/TLS certificates with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-certificate-requirements.html) in the *AWS Network Firewall Developer Guide* .\n\nFor information about working with certificates in ACM, see [Importing certificates](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *Certificate Manager User Guide* ."},"checkCertificateRevocationStatus":{"$ref":"#/types/aws-native:networkfirewall:TlsInspectionConfigurationServerCertificateConfigurationCheckCertificateRevocationStatusProperties","description":"When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a `CertificateAuthorityArn` in [ServerCertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-networkfirewall-servercertificateconfiguration.html) ."},"scopes":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:TlsInspectionConfigurationServerCertificateScope"},"description":"A list of scopes."},"serverCertificates":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:TlsInspectionConfigurationServerCertificate"},"description":"The list of server certificates to use for inbound SSL/TLS inspection."}},"type":"object"},"aws-native:networkfirewall:TlsInspectionConfigurationServerCertificateConfigurationCheckCertificateRevocationStatusProperties":{"description":"When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a `CertificateAuthorityArn` in [ServerCertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-networkfirewall-servercertificateconfiguration.html) .","properties":{"revokedStatusAction":{"$ref":"#/types/aws-native:networkfirewall:TlsInspectionConfigurationRevokedStatusAction"},"unknownStatusAction":{"$ref":"#/types/aws-native:networkfirewall:TlsInspectionConfigurationUnknownStatusAction"}},"type":"object"},"aws-native:networkfirewall:TlsInspectionConfigurationServerCertificateScope":{"properties":{"destinationPorts":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:TlsInspectionConfigurationPortRange"},"description":"The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.\n\nYou can specify individual ports, for example `1994` , and you can specify port ranges, such as `1990:1994` ."},"destinations":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:TlsInspectionConfigurationAddress"},"description":"The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this\nmatches with any destination address."},"protocols":{"type":"array","items":{"type":"integer"},"description":"The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.\n\nNetwork Firewall currently supports only TCP."},"sourcePorts":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:TlsInspectionConfigurationPortRange"},"description":"The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.\n\nYou can specify individual ports, for example `1994` , and you can specify port ranges, such as `1990:1994` ."},"sources":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:TlsInspectionConfigurationAddress"},"description":"The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this\nmatches with any source address."}},"type":"object"},"aws-native:networkfirewall:TlsInspectionConfigurationTag":{"properties":{"key":{"type":"string","description":"The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive."},"value":{"type":"string","description":"The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive."}},"type":"object","required":["key","value"]},"aws-native:networkfirewall:TlsInspectionConfigurationTlsInspectionConfiguration":{"properties":{"serverCertificateConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:networkfirewall:TlsInspectionConfigurationServerCertificateConfiguration"},"description":"Lists the server certificate configurations that are associated with the TLS configuration."}},"type":"object"},"aws-native:networkfirewall:TlsInspectionConfigurationUnknownStatusAction":{"type":"string","enum":[{"name":"Pass","value":"PASS"},{"name":"Drop","value":"DROP"},{"name":"Reject","value":"REJECT"}]},"aws-native:networkfirewall:VpcEndpointAssociationSubnetMapping":{"properties":{"ipAddressType":{"type":"string","description":"A IPAddressType"},"subnetId":{"type":"string","description":"A SubnetId."}},"type":"object","required":["subnetId"]},"aws-native:networkfirewall:VpcEndpointAssociationTag":{"properties":{"key":{"type":"string","description":"The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive."},"value":{"type":"string","description":"The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:ConnectAttachmentOptions":{"description":"Connect attachment options for protocol","properties":{"protocol":{"type":"string","description":"Tunnel protocol for connect attachment"}},"type":"object"},"aws-native:networkmanager:ConnectAttachmentProposedNetworkFunctionGroupChange":{"description":"The attachment to move from one network function group to another.","properties":{"attachmentPolicyRuleNumber":{"type":"integer","description":"The rule number in the policy document that applies to this change."},"networkFunctionGroupName":{"type":"string","description":"The name of the network function group to change."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:networkmanager:ConnectAttachmentTag"},"description":"The key-value tags that changed for the network function group."}},"type":"object"},"aws-native:networkmanager:ConnectAttachmentProposedSegmentChange":{"description":"The attachment to move from one segment to another.","properties":{"attachmentPolicyRuleNumber":{"type":"integer","description":"The rule number in the policy document that applies to this change."},"segmentName":{"type":"string","description":"The name of the segment to change."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:networkmanager:ConnectAttachmentTag"},"description":"The list of key-value tags that changed for the segment."}},"type":"object"},"aws-native:networkmanager:ConnectAttachmentTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:ConnectPeerBgpConfiguration":{"description":"Bgp configuration for connect peer","properties":{"coreNetworkAddress":{"type":"string","description":"The address of a core network."},"coreNetworkAsn":{"type":"number","description":"The ASN of the Coret Network."},"peerAddress":{"type":"string","description":"The address of a core network Connect peer."},"peerAsn":{"type":"number","description":"The ASN of the Connect peer."}},"type":"object"},"aws-native:networkmanager:ConnectPeerBgpOptions":{"description":"Bgp options","properties":{"peerAsn":{"type":"number","description":"The Peer ASN of the BGP."}},"type":"object"},"aws-native:networkmanager:ConnectPeerConfiguration":{"properties":{"bgpConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:networkmanager:ConnectPeerBgpConfiguration"},"description":"The Connect peer BGP configurations."},"coreNetworkAddress":{"type":"string","description":"The IP address of a core network."},"insideCidrBlocks":{"type":"array","items":{"type":"string"},"description":"The inside IP addresses used for a Connect peer configuration."},"peerAddress":{"type":"string","description":"The IP address of the Connect peer."},"protocol":{"type":"string","description":"The protocol used for a Connect peer configuration."}},"type":"object"},"aws-native:networkmanager:ConnectPeerTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:CoreNetworkEdge":{"properties":{"asn":{"type":"number","description":"The ASN of a core network edge."},"edgeLocation":{"type":"string","description":"The Region where a core network edge is located."},"insideCidrBlocks":{"type":"array","items":{"type":"string"},"description":"The inside IP addresses used for core network edges."}},"type":"object"},"aws-native:networkmanager:CoreNetworkNetworkFunctionGroup":{"properties":{"edgeLocations":{"type":"array","items":{"type":"string"},"description":"The core network edge locations."},"name":{"type":"string","description":"Name of network function group"},"segments":{"$ref":"#/types/aws-native:networkmanager:CoreNetworkNetworkFunctionGroupSegmentsProperties","description":"The segments associated with the network function group."}},"type":"object"},"aws-native:networkmanager:CoreNetworkNetworkFunctionGroupSegmentsProperties":{"description":"The segments associated with the network function group.","properties":{"sendTo":{"type":"array","items":{"type":"string"}},"sendVia":{"type":"array","items":{"type":"string"}}},"type":"object"},"aws-native:networkmanager:CoreNetworkSegment":{"properties":{"edgeLocations":{"type":"array","items":{"type":"string"},"description":"The Regions where the edges are located."},"name":{"type":"string","description":"Name of segment"},"sharedSegments":{"type":"array","items":{"type":"string"},"description":"The shared segments of a core network."}},"type":"object"},"aws-native:networkmanager:CoreNetworkTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:DeviceAwsLocation":{"description":"The Amazon Web Services location of the device, if applicable.","properties":{"subnetArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the subnet that the device is located in."},"zone":{"type":"string","description":"The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost."}},"type":"object"},"aws-native:networkmanager:DeviceLocation":{"description":"The site location.","properties":{"address":{"type":"string","description":"The physical address."},"latitude":{"type":"string","description":"The latitude."},"longitude":{"type":"string","description":"The longitude."}},"type":"object"},"aws-native:networkmanager:DeviceTag":{"description":"A key-value pair to associate with a device resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:DirectConnectGatewayAttachmentProposedNetworkFunctionGroupChange":{"description":"The attachment to move from one network function group to another.","properties":{"attachmentPolicyRuleNumber":{"type":"integer","description":"The rule number in the policy document that applies to this change."},"networkFunctionGroupName":{"type":"string","description":"The name of the network function group to change."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:networkmanager:DirectConnectGatewayAttachmentTag"},"description":"The key-value tags that changed for the network function group."}},"type":"object"},"aws-native:networkmanager:DirectConnectGatewayAttachmentProposedSegmentChange":{"description":"The attachment to move from one segment to another.","properties":{"attachmentPolicyRuleNumber":{"type":"integer","description":"The rule number in the policy document that applies to this change."},"segmentName":{"type":"string","description":"The name of the segment to change."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:networkmanager:DirectConnectGatewayAttachmentTag"},"description":"The key-value tags that changed for the segment."}},"type":"object"},"aws-native:networkmanager:DirectConnectGatewayAttachmentTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:GlobalNetworkTag":{"description":"A key-value pair to associate with a global network resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:LinkBandwidth":{"description":"The bandwidth for the link.","properties":{"downloadSpeed":{"type":"integer","description":"Download speed in Mbps."},"uploadSpeed":{"type":"integer","description":"Upload speed in Mbps."}},"type":"object"},"aws-native:networkmanager:LinkTag":{"description":"A key-value pair to associate with a link resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:SiteLocation":{"description":"The location of the site","properties":{"address":{"type":"string","description":"The physical address."},"latitude":{"type":"string","description":"The latitude."},"longitude":{"type":"string","description":"The longitude."}},"type":"object"},"aws-native:networkmanager:SiteTag":{"description":"A key-value pair to associate with a site resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:SiteToSiteVpnAttachmentProposedNetworkFunctionGroupChange":{"description":"The attachment to move from one network function group to another.","properties":{"attachmentPolicyRuleNumber":{"type":"integer","description":"The rule number in the policy document that applies to this change."},"networkFunctionGroupName":{"type":"string","description":"The name of the network function group to change."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:networkmanager:SiteToSiteVpnAttachmentTag"},"description":"The key-value tags that changed for the network function group."}},"type":"object"},"aws-native:networkmanager:SiteToSiteVpnAttachmentProposedSegmentChange":{"description":"The attachment to move from one segment to another.","properties":{"attachmentPolicyRuleNumber":{"type":"integer","description":"The rule number in the policy document that applies to this change."},"segmentName":{"type":"string","description":"The name of the segment to change."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:networkmanager:SiteToSiteVpnAttachmentTag"},"description":"The key-value tags that changed for the segment."}},"type":"object"},"aws-native:networkmanager:SiteToSiteVpnAttachmentTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:TransitGatewayPeeringTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:TransitGatewayRouteTableAttachmentProposedNetworkFunctionGroupChange":{"description":"The attachment to move from one network function group to another.","properties":{"attachmentPolicyRuleNumber":{"type":"integer","description":"The rule number in the policy document that applies to this change."},"networkFunctionGroupName":{"type":"string","description":"The name of the network function group to change."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:networkmanager:TransitGatewayRouteTableAttachmentTag"},"description":"The key-value tags that changed for the network function group."}},"type":"object"},"aws-native:networkmanager:TransitGatewayRouteTableAttachmentProposedSegmentChange":{"description":"The attachment to move from one segment to another.","properties":{"attachmentPolicyRuleNumber":{"type":"integer","description":"The rule number in the policy document that applies to this change."},"segmentName":{"type":"string","description":"The name of the segment to change."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:networkmanager:TransitGatewayRouteTableAttachmentTag"},"description":"The key-value tags that changed for the segment."}},"type":"object"},"aws-native:networkmanager:TransitGatewayRouteTableAttachmentTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:VpcAttachmentProposedNetworkFunctionGroupChange":{"description":"The attachment to move from one network function group to another.","properties":{"attachmentPolicyRuleNumber":{"type":"integer","description":"The rule number in the policy document that applies to this change."},"networkFunctionGroupName":{"type":"string","description":"The name of the network function group to change."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:networkmanager:VpcAttachmentTag"},"description":"The key-value tags that changed for the network function group."}},"type":"object"},"aws-native:networkmanager:VpcAttachmentProposedSegmentChange":{"description":"The attachment to move from one segment to another.","properties":{"attachmentPolicyRuleNumber":{"type":"integer","description":"The rule number in the policy document that applies to this change."},"segmentName":{"type":"string","description":"The name of the segment to change."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:networkmanager:VpcAttachmentTag"},"description":"The key-value tags that changed for the segment."}},"type":"object"},"aws-native:networkmanager:VpcAttachmentTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:networkmanager:VpcAttachmentVpcOptions":{"description":"Vpc options of the attachment.","properties":{"applianceModeSupport":{"type":"boolean","description":"Indicates whether to enable ApplianceModeSupport Support for Vpc Attachment. Valid Values: true | false"},"dnsSupport":{"type":"boolean","description":"Indicates whether to enable private DNS Support for Vpc Attachment. Valid Values: true | false"},"ipv6Support":{"type":"boolean","description":"Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable"},"securityGroupReferencingSupport":{"type":"boolean","description":"Indicates whether to enable Security Group Referencing Support for Vpc Attachment. Valid Values: true | false"}},"type":"object"},"aws-native:nimblestudio:LaunchProfileStreamConfiguration":{"properties":{"automaticTerminationMode":{"type":"string"},"clipboardMode":{"type":"string"},"ec2InstanceTypes":{"type":"array","items":{"type":"string"}},"maxSessionLengthInMinutes":{"type":"number"},"maxStoppedSessionLengthInMinutes":{"type":"number"},"sessionBackup":{"$ref":"#/types/aws-native:nimblestudio:LaunchProfileStreamConfigurationSessionBackup"},"sessionPersistenceMode":{"type":"string"},"sessionStorage":{"$ref":"#/types/aws-native:nimblestudio:LaunchProfileStreamConfigurationSessionStorage"},"streamingImageIds":{"type":"array","items":{"type":"string"}},"volumeConfiguration":{"$ref":"#/types/aws-native:nimblestudio:LaunchProfileVolumeConfiguration"}},"type":"object","required":["clipboardMode","ec2InstanceTypes","streamingImageIds"]},"aws-native:nimblestudio:LaunchProfileStreamConfigurationSessionBackup":{"properties":{"maxBackupsToRetain":{"type":"number"},"mode":{"type":"string"}},"type":"object"},"aws-native:nimblestudio:LaunchProfileStreamConfigurationSessionStorage":{"properties":{"mode":{"type":"array","items":{"type":"string"}},"root":{"$ref":"#/types/aws-native:nimblestudio:LaunchProfileStreamingSessionStorageRoot"}},"type":"object","required":["mode"]},"aws-native:nimblestudio:LaunchProfileStreamingSessionStorageRoot":{"properties":{"linux":{"type":"string"},"windows":{"type":"string"}},"type":"object"},"aws-native:nimblestudio:LaunchProfileVolumeConfiguration":{"properties":{"iops":{"type":"number"},"size":{"type":"number"},"throughput":{"type":"number"}},"type":"object"},"aws-native:nimblestudio:StreamingImageEncryptionConfiguration":{"properties":{"keyArn":{"type":"string"},"keyType":{"type":"string"}},"type":"object","required":["keyType"]},"aws-native:nimblestudio:StudioComponentActiveDirectoryComputerAttribute":{"properties":{"name":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:nimblestudio:StudioComponentActiveDirectoryConfiguration":{"properties":{"computerAttributes":{"type":"array","items":{"$ref":"#/types/aws-native:nimblestudio:StudioComponentActiveDirectoryComputerAttribute"}},"directoryId":{"type":"string"},"organizationalUnitDistinguishedName":{"type":"string"}},"type":"object"},"aws-native:nimblestudio:StudioComponentComputeFarmConfiguration":{"properties":{"activeDirectoryUser":{"type":"string"},"endpoint":{"type":"string"}},"type":"object"},"aws-native:nimblestudio:StudioComponentConfiguration":{"properties":{"activeDirectoryConfiguration":{"$ref":"#/types/aws-native:nimblestudio:StudioComponentActiveDirectoryConfiguration"},"computeFarmConfiguration":{"$ref":"#/types/aws-native:nimblestudio:StudioComponentComputeFarmConfiguration"},"licenseServiceConfiguration":{"$ref":"#/types/aws-native:nimblestudio:StudioComponentLicenseServiceConfiguration"},"sharedFileSystemConfiguration":{"$ref":"#/types/aws-native:nimblestudio:StudioComponentSharedFileSystemConfiguration"}},"type":"object"},"aws-native:nimblestudio:StudioComponentInitializationScript":{"properties":{"launchProfileProtocolVersion":{"type":"string"},"platform":{"type":"string"},"runContext":{"type":"string"},"script":{"type":"string"}},"type":"object"},"aws-native:nimblestudio:StudioComponentLicenseServiceConfiguration":{"properties":{"endpoint":{"type":"string"}},"type":"object"},"aws-native:nimblestudio:StudioComponentScriptParameterKeyValue":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"aws-native:nimblestudio:StudioComponentSharedFileSystemConfiguration":{"properties":{"endpoint":{"type":"string"},"fileSystemId":{"type":"string"},"linuxMountPoint":{"type":"string"},"shareName":{"type":"string"},"windowsMountDrive":{"type":"string"}},"type":"object"},"aws-native:nimblestudio:StudioEncryptionConfiguration":{"properties":{"keyArn":{"type":"string"},"keyType":{"type":"string"}},"type":"object","required":["keyType"]},"aws-native:oam:LinkConfiguration":{"properties":{"logGroupConfiguration":{"$ref":"#/types/aws-native:oam:LinkFilter","description":"Use this structure to filter which log groups are to share log events from this source account to the monitoring account."},"metricConfiguration":{"$ref":"#/types/aws-native:oam:LinkFilter","description":"Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account."}},"type":"object"},"aws-native:oam:LinkFilter":{"properties":{"filter":{"type":"string","description":"When used in `MetricConfiguration` this field specifies which metric namespaces are to be shared with the monitoring account\n\nWhen used in `LogGroupConfiguration` this field specifies which log groups are to share their log events with the monitoring account. Use the term `LogGroupName` and one or more of the following operands.\n\nUse single quotation marks (') around log group names and metric namespaces.\n\nThe matching of log group names and metric namespaces is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are `AND` and `OR` .\n\n- `=` and `!=`\n- `AND`\n- `OR`\n- `LIKE` and `NOT LIKE` . These can be used only as prefix searches. Include a `%` at the end of the string that you want to search for and include.\n- `IN` and `NOT IN` , using parentheses `( )`\n\nExamples:\n\n- `Namespace NOT LIKE 'AWS/%'` includes only namespaces that don't start with `AWS/` , such as custom namespaces.\n- `Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3')` includes only the metrics in the EC2, Elastic Load Balancing , and Amazon S3 namespaces.\n- `Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%'` includes only the EC2 namespace and your custom namespaces.\n- `LogGroupName IN ('This-Log-Group', 'Other-Log-Group')` includes only the log groups with names `This-Log-Group` and `Other-Log-Group` .\n- `LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2')` includes all log groups except the log groups with names `Private-Log-Group` and `Private-Log-Group-2` .\n- `LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%'` includes all log groups that have names that start with `aws/lambda/` or `AWSLogs` .\n\n\u003e If you are updating a link that uses filters, you can specify `*` as the only value for the `filter` parameter to delete the filter and share all log groups with the monitoring account."}},"type":"object","required":["filter"]},"aws-native:oam:LinkResourceType":{"type":"string","enum":[{"name":"AwsCloudWatchMetric","value":"AWS::CloudWatch::Metric"},{"name":"AwsLogsLogGroup","value":"AWS::Logs::LogGroup"},{"name":"AwsxRayTrace","value":"AWS::XRay::Trace"},{"name":"AwsApplicationInsightsApplication","value":"AWS::ApplicationInsights::Application"},{"name":"AwsInternetMonitorMonitor","value":"AWS::InternetMonitor::Monitor"},{"name":"AwsApplicationSignalsService","value":"AWS::ApplicationSignals::Service"},{"name":"AwsApplicationSignalsServiceLevelObjective","value":"AWS::ApplicationSignals::ServiceLevelObjective"}]},"aws-native:observabilityadmin:OrganizationCentralizationRuleCentralizationRule":{"properties":{"destination":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationCentralizationRuleCentralizationRuleDestination","description":"Configuration determining where the telemetry data should be centralized, backed up, as well as encryption configuration for the primary and backup destinations."},"source":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationCentralizationRuleCentralizationRuleSource","description":"Configuration determining the source of the telemetry data to be centralized."}},"type":"object","required":["destination","source"]},"aws-native:observabilityadmin:OrganizationCentralizationRuleCentralizationRuleDestination":{"properties":{"account":{"type":"string","description":"The destination account (within the organization) to which the telemetry data should be centralized."},"destinationLogsConfiguration":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationCentralizationRuleDestinationLogsConfiguration","description":"Log specific configuration for centralization destination log groups."},"region":{"type":"string","description":"The primary destination region to which telemetry data should be centralized."}},"type":"object","required":["region"]},"aws-native:observabilityadmin:OrganizationCentralizationRuleCentralizationRuleSource":{"properties":{"regions":{"type":"array","items":{"type":"string"},"description":"The list of source regions from which telemetry data should be centralized."},"scope":{"type":"string","description":"The organizational scope from which telemetry data should be centralized, specified using organization id, accounts or organizational unit ids."},"sourceLogsConfiguration":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationCentralizationRuleSourceLogsConfiguration","description":"Log specific configuration for centralization source log groups."}},"type":"object","required":["regions"]},"aws-native:observabilityadmin:OrganizationCentralizationRuleDestinationLogsConfiguration":{"properties":{"backupConfiguration":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationCentralizationRuleLogsBackupConfiguration","description":"Configuration defining the backup region and an optional KMS key for the backup destination."},"logGroupNameConfiguration":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationCentralizationRuleLogGroupNameConfiguration"},"logsEncryptionConfiguration":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationCentralizationRuleLogsEncryptionConfiguration","description":"The encryption configuration for centralization destination log groups."}},"type":"object"},"aws-native:observabilityadmin:OrganizationCentralizationRuleLogGroupNameConfiguration":{"properties":{"logGroupNamePattern":{"type":"string"}},"type":"object","required":["logGroupNamePattern"]},"aws-native:observabilityadmin:OrganizationCentralizationRuleLogsBackupConfiguration":{"properties":{"kmsKeyArn":{"type":"string","description":"KMS Key ARN belonging to the primary destination account and backup region, to encrypt newly created central log groups in the backup destination."},"region":{"type":"string","description":"Logs specific backup destination region within the primary destination account to which log data should be centralized."}},"type":"object","required":["region"]},"aws-native:observabilityadmin:OrganizationCentralizationRuleLogsEncryptionConfiguration":{"properties":{"encryptionConflictResolutionStrategy":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationCentralizationRuleLogsEncryptionConfigurationEncryptionConflictResolutionStrategy","description":"Conflict resolution strategy for centralization if the encryption strategy is set to CUSTOMER_MANAGED and the destination log group is encrypted with an AWS_OWNED KMS Key. ALLOW lets centralization go through while SKIP prevents centralization into the destination log group."},"encryptionStrategy":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationCentralizationRuleLogsEncryptionConfigurationEncryptionStrategy","description":"Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups."},"kmsKeyArn":{"type":"string","description":"KMS Key ARN belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination."}},"type":"object","required":["encryptionStrategy"]},"aws-native:observabilityadmin:OrganizationCentralizationRuleLogsEncryptionConfigurationEncryptionConflictResolutionStrategy":{"description":"Conflict resolution strategy for centralization if the encryption strategy is set to CUSTOMER_MANAGED and the destination log group is encrypted with an AWS_OWNED KMS Key. ALLOW lets centralization go through while SKIP prevents centralization into the destination log group.","type":"string","enum":[{"name":"Allow","value":"ALLOW"},{"name":"Skip","value":"SKIP"}]},"aws-native:observabilityadmin:OrganizationCentralizationRuleLogsEncryptionConfigurationEncryptionStrategy":{"description":"Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.","type":"string","enum":[{"name":"CustomerManaged","value":"CUSTOMER_MANAGED"},{"name":"AwsOwned","value":"AWS_OWNED"}]},"aws-native:observabilityadmin:OrganizationCentralizationRuleSourceLogsConfiguration":{"properties":{"encryptedLogGroupStrategy":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationCentralizationRuleSourceLogsConfigurationEncryptedLogGroupStrategy","description":"A strategy determining whether to centralize source log groups that are encrypted with customer managed KMS keys (CMK). ALLOW will consider CMK encrypted source log groups for centralization while SKIP will skip CMK encrypted source log groups from centralization."},"logGroupSelectionCriteria":{"type":"string","description":"The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters."}},"type":"object","required":["encryptedLogGroupStrategy","logGroupSelectionCriteria"]},"aws-native:observabilityadmin:OrganizationCentralizationRuleSourceLogsConfigurationEncryptedLogGroupStrategy":{"description":"A strategy determining whether to centralize source log groups that are encrypted with customer managed KMS keys (CMK). ALLOW will consider CMK encrypted source log groups for centralization while SKIP will skip CMK encrypted source log groups from centralization.","type":"string","enum":[{"name":"Allow","value":"ALLOW"},{"name":"Skip","value":"SKIP"}]},"aws-native:observabilityadmin:OrganizationCentralizationRuleTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:observabilityadmin:OrganizationTelemetryRuleAction":{"description":"The enumerated action to take.","type":"string","enum":[{"name":"Allow","value":"ALLOW"},{"name":"Block","value":"BLOCK"},{"name":"Count","value":"COUNT"},{"name":"Captcha","value":"CAPTCHA"},{"name":"Challenge","value":"CHALLENGE"},{"name":"ExcludedAsCount","value":"EXCLUDED_AS_COUNT"}]},"aws-native:observabilityadmin:OrganizationTelemetryRuleActionCondition":{"description":"The condition of the action desired in the filter.","properties":{"action":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleAction"}},"type":"object"},"aws-native:observabilityadmin:OrganizationTelemetryRuleAdvancedEventSelector":{"description":"An advanced event selector that includes optional name and field selectors","properties":{"fieldSelectors":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleAdvancedFieldSelector"},"description":"Contains all selector statements in an advanced event selector."},"name":{"type":"string","description":"An optional descriptive name for the advanced event selector"}},"type":"object","required":["fieldSelectors"]},"aws-native:observabilityadmin:OrganizationTelemetryRuleAdvancedFieldSelector":{"description":"A single selector statement in an advanced event selector.","properties":{"endsWith":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the last few characters of the event record field specified as the value of Field."},"equals":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the exact value of the event record field specified as the value of Field."},"field":{"type":"string","description":"A field in a CloudTrail event record on which to filter events to be logged"},"notEndsWith":{"type":"array","items":{"type":"string"},"description":"An operator that excludes events that match the last few characters of the event record field specified as the value of Field."},"notEquals":{"type":"array","items":{"type":"string"},"description":"An operator that excludes events that match the exact value of the event record field specified as the value of Field."},"notStartsWith":{"type":"array","items":{"type":"string"},"description":"An operator that excludes events that match the first few characters of the event record field specified as the value of Field."},"startsWith":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the first few characters of the event record field specified as the value of Field."}},"type":"object"},"aws-native:observabilityadmin:OrganizationTelemetryRuleCloudtrailParameters":{"description":"Telemetry parameters for Cloudtrail","properties":{"advancedEventSelectors":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleAdvancedEventSelector"},"description":"Create fine-grained selectors for AWS CloudTrail management and data."}},"type":"object","required":["advancedEventSelectors"]},"aws-native:observabilityadmin:OrganizationTelemetryRuleCondition":{"description":"A condition for a filter.","properties":{"actionCondition":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleActionCondition"},"labelNameCondition":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleLabelNameCondition"}},"type":"object"},"aws-native:observabilityadmin:OrganizationTelemetryRuleDestinationType":{"description":"Type of telemetry destination","type":"string","enum":[{"name":"CloudWatchLogs","value":"cloud-watch-logs"}]},"aws-native:observabilityadmin:OrganizationTelemetryRuleElbLoadBalancerLoggingParameters":{"description":"Telemetry parameters for ELB/NLB Load Balancer Logs","properties":{"fieldDelimiter":{"type":"string","description":"A delimiter to delineate log fields"},"outputFormat":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleElbLoadBalancerLoggingParametersOutputFormat","description":"The format for ELB access log entries (plain text or JSON format)."}},"type":"object"},"aws-native:observabilityadmin:OrganizationTelemetryRuleElbLoadBalancerLoggingParametersOutputFormat":{"description":"The format for ELB access log entries (plain text or JSON format).","type":"string","enum":[{"name":"Plain","value":"plain"},{"name":"Json","value":"json"}]},"aws-native:observabilityadmin:OrganizationTelemetryRuleFieldToMatch":{"description":"The field that we want to match this rule to.","properties":{"method":{"type":"string","description":"The method with which to match this rule."},"queryString":{"type":"string","description":"The query string to find the resource to match this field to."},"singleHeader":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleSingleHeader"},"uriPath":{"type":"string","description":"This is the URI path to match this rule to."}},"type":"object"},"aws-native:observabilityadmin:OrganizationTelemetryRuleFilter":{"description":"A filter to be applied","properties":{"behavior":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleFilterBehavior"},"conditions":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleCondition"}},"requirement":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleFilterRequirement"}},"type":"object"},"aws-native:observabilityadmin:OrganizationTelemetryRuleFilterBehavior":{"description":"The behavior required of the filter.","type":"string","enum":[{"name":"Keep","value":"KEEP"},{"name":"Drop","value":"DROP"}]},"aws-native:observabilityadmin:OrganizationTelemetryRuleFilterRequirement":{"description":"The requirement portion of the filter.","type":"string","enum":[{"name":"MeetsAll","value":"MEETS_ALL"},{"name":"MeetsAny","value":"MEETS_ANY"}]},"aws-native:observabilityadmin:OrganizationTelemetryRuleLabelNameCondition":{"description":"The label name of the condition.","properties":{"labelName":{"type":"string","description":"The label name of the condition."}},"type":"object"},"aws-native:observabilityadmin:OrganizationTelemetryRuleLoggingFilter":{"description":"Default handling for logs that don't match any of the specified filtering conditions.","properties":{"defaultBehavior":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleFilterBehavior","description":"The default action (KEEP or DROP) for log records that don't match any filter conditions."},"filters":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleFilter"},"description":"A list of filter conditions that determine log record handling behavior."}},"type":"object"},"aws-native:observabilityadmin:OrganizationTelemetryRuleResourceType":{"description":"Resource Type associated with the Organization Telemetry Rule","type":"string","enum":[{"name":"Awsec2vpc","value":"AWS::EC2::VPC"},{"name":"AwswaFv2WebAcl","value":"AWS::WAFv2::WebACL"},{"name":"AwsCloudTrail","value":"AWS::CloudTrail"},{"name":"AwseksCluster","value":"AWS::EKS::Cluster"},{"name":"AwsElasticLoadBalancingV2LoadBalancer","value":"AWS::ElasticLoadBalancingV2::LoadBalancer"}]},"aws-native:observabilityadmin:OrganizationTelemetryRuleSingleHeader":{"description":"Header for the field to match.","properties":{"name":{"type":"string","description":"The name of the header"}},"type":"object","required":["name"]},"aws-native:observabilityadmin:OrganizationTelemetryRuleTag":{"description":"A key-value pair to associate with a resource","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:observabilityadmin:OrganizationTelemetryRuleTelemetryDestinationConfiguration":{"description":"The destination configuration for telemetry data","properties":{"cloudtrailParameters":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleCloudtrailParameters","description":"Configuration parameters specific to AWS CloudTrail when CloudTrail is the source type."},"destinationPattern":{"type":"string","description":"The pattern used to generate the destination path or name, supporting macros like \u003cresourceId\u003e and \u003caccountId\u003e."},"destinationType":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleDestinationType","description":"The type of destination for the telemetry data (e.g., \"Amazon CloudWatch Logs\", \"S3\")."},"elbLoadBalancerLoggingParameters":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleElbLoadBalancerLoggingParameters","description":"Configuration parameters specific to ELB load balancer logging when ELB is the resource type."},"retentionInDays":{"type":"integer","description":"The number of days to retain the telemetry data in the destination."},"vpcFlowLogParameters":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleVpcFlowLogParameters","description":"Configuration parameters specific to VPC Flow Logs when VPC is the resource type."},"wafLoggingParameters":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleWafLoggingParameters","description":"Configuration parameters specific to WAF logging when WAF is the resource type."}},"type":"object"},"aws-native:observabilityadmin:OrganizationTelemetryRuleTelemetryRule":{"description":"The telemetry rule","properties":{"destinationConfiguration":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleTelemetryDestinationConfiguration","description":"Configuration specifying where and how the telemetry data should be delivered."},"resourceType":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleResourceType","description":"The type of AWS resource to configure telemetry for (e.g., \"AWS::EC2::VPC\", \"AWS::EKS::Cluster\", \"AWS::WAFv2::WebACL\")."},"scope":{"type":"string","description":"The organizational scope to which the rule applies, specified using accounts or organizational units."},"selectionCriteria":{"type":"string","description":"Criteria for selecting which resources the rule applies to, such as resource tags."},"telemetrySourceTypes":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleTelemetrySourceType"},"description":"The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS. TelemetrySourceTypes must be correlated with the specific resource type."},"telemetryType":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleTelemetryType","description":"The type of telemetry to collect (Logs, Metrics, or Traces)."}},"type":"object","required":["resourceType","telemetryType"]},"aws-native:observabilityadmin:OrganizationTelemetryRuleTelemetrySourceType":{"description":"The telemetry source type that goes into the array.","type":"string","enum":[{"name":"VpcFlowLogs","value":"VPC_FLOW_LOGS"},{"name":"Route53ResolverQueryLogs","value":"ROUTE53_RESOLVER_QUERY_LOGS"},{"name":"EksAuditLogs","value":"EKS_AUDIT_LOGS"},{"name":"EksAuthenticatorLogs","value":"EKS_AUTHENTICATOR_LOGS"},{"name":"EksControllerManagerLogs","value":"EKS_CONTROLLER_MANAGER_LOGS"},{"name":"EksSchedulerLogs","value":"EKS_SCHEDULER_LOGS"},{"name":"EksApiLogs","value":"EKS_API_LOGS"}]},"aws-native:observabilityadmin:OrganizationTelemetryRuleTelemetryType":{"description":"Telemetry Type associated with the Organization Telemetry Rule","type":"string","enum":[{"name":"Logs","value":"Logs"}]},"aws-native:observabilityadmin:OrganizationTelemetryRuleVpcFlowLogParameters":{"description":"Telemetry parameters for VPC Flow logs","properties":{"logFormat":{"type":"string","description":"The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format."},"maxAggregationInterval":{"type":"integer","description":"The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s."},"trafficType":{"type":"string","description":"The type of traffic captured for the flow log. Default is ALL"}},"type":"object"},"aws-native:observabilityadmin:OrganizationTelemetryRuleWafLogType":{"description":"The type of logs to generate for WAF.","type":"string","enum":[{"name":"WafLogs","value":"WAF_LOGS"}]},"aws-native:observabilityadmin:OrganizationTelemetryRuleWafLoggingParameters":{"description":"Telemetry parameters for WAF v2 Web ACL","properties":{"logType":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleWafLogType","description":"The type of WAF logs to collect (currently supports WAF_LOGS)."},"loggingFilter":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleLoggingFilter","description":"A filter configuration that determines which WAF log records to include or exclude."},"redactedFields":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:OrganizationTelemetryRuleFieldToMatch"},"description":"Fields not to be included in the logs."}},"type":"object"},"aws-native:observabilityadmin:S3TableIntegrationEncryptionConfig":{"description":"Encryption configuration for the S3 Table Integration","properties":{"kmsKeyArn":{"type":"string","description":"The ARN of the KMS key used to encrypt the S3 Table Integration"},"sseAlgorithm":{"$ref":"#/types/aws-native:observabilityadmin:S3TableIntegrationEncryptionConfigSseAlgorithm","description":"The server-side encryption algorithm used to encrypt the S3 Table(s) data"}},"type":"object","required":["sseAlgorithm"]},"aws-native:observabilityadmin:S3TableIntegrationEncryptionConfigSseAlgorithm":{"description":"The server-side encryption algorithm used to encrypt the S3 Table(s) data","type":"string","enum":[{"name":"Aes256","value":"AES256"},{"name":"Awskms","value":"aws:kms"}]},"aws-native:observabilityadmin:S3TableIntegrationLogSource":{"description":"CloudWatch Logs data source to associate with the S3 Table Integration","properties":{"identifier":{"type":"string","description":"The ID of the CloudWatch Logs data source association"},"name":{"type":"string","description":"The name of the CloudWatch Logs data source"},"type":{"type":"string","description":"The type of the CloudWatch Logs data source"}},"type":"object","required":["name","type"]},"aws-native:observabilityadmin:S3TableIntegrationTag":{"description":"A key-value pair to associate with a resource","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:observabilityadmin:TelemetryPipelinesTag":{"description":"A key-value pair to associate with a resource","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:observabilityadmin:TelemetryPipelinesTelemetryPipeline":{"properties":{"arn":{"type":"string","description":"The Amazon Resource Name (ARN) of the telemetry pipeline."},"configuration":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryPipelinesTelemetryPipelineConfiguration","description":"The configuration that defines how the telemetry pipeline processes data. For more information, see the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Creating-pipelines.html) ."},"createdTimeStamp":{"type":"number","description":"The timestamp when the telemetry pipeline was created."},"lastUpdateTimeStamp":{"type":"number","description":"The timestamp when the telemetry pipeline was last updated."},"name":{"type":"string","description":"The name of the telemetry pipeline."},"status":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryPipelinesTelemetryPipelineStatus","description":"The current status of the telemetry pipeline."},"statusReason":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryPipelinesTelemetryPipelineStatusReason","description":"Additional information about the pipeline status, including reasons for failure states."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryPipelinesTag"},"description":"An array of key-value pairs to apply to this resource"}},"type":"object"},"aws-native:observabilityadmin:TelemetryPipelinesTelemetryPipelineConfiguration":{"properties":{"body":{"type":"string","description":"The pipeline configuration body that defines the data processing rules and transformations."}},"type":"object","required":["body"]},"aws-native:observabilityadmin:TelemetryPipelinesTelemetryPipelineStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"UpdateFailed","value":"UPDATE_FAILED"}]},"aws-native:observabilityadmin:TelemetryPipelinesTelemetryPipelineStatusReason":{"properties":{"description":{"type":"string","description":"A description of the pipeline status reason, providing additional context about the current state."}},"type":"object"},"aws-native:observabilityadmin:TelemetryRule":{"description":"The telemetry rule","properties":{"destinationConfiguration":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleTelemetryDestinationConfiguration","description":"Configuration specifying where and how the telemetry data should be delivered."},"resourceType":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleResourceType","description":"The type of AWS resource to configure telemetry for (e.g., \"AWS::EC2::VPC\", \"AWS::EKS::Cluster\", \"AWS::WAFv2::WebACL\")."},"selectionCriteria":{"type":"string","description":"Criteria for selecting which resources the rule applies to, such as resource tags."},"telemetrySourceTypes":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleTelemetrySourceType"},"description":"The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS. TelemetrySourceTypes must be correlated with the specific resource type."},"telemetryType":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleTelemetryType","description":"The type of telemetry to collect (Logs, Metrics, or Traces)."}},"type":"object","required":["resourceType","telemetryType"]},"aws-native:observabilityadmin:TelemetryRuleAction":{"description":"The enumerated action to take.","type":"string","enum":[{"name":"Allow","value":"ALLOW"},{"name":"Block","value":"BLOCK"},{"name":"Count","value":"COUNT"},{"name":"Captcha","value":"CAPTCHA"},{"name":"Challenge","value":"CHALLENGE"},{"name":"ExcludedAsCount","value":"EXCLUDED_AS_COUNT"}]},"aws-native:observabilityadmin:TelemetryRuleActionCondition":{"description":"The condition of the action desired in the filter.","properties":{"action":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleAction"}},"type":"object"},"aws-native:observabilityadmin:TelemetryRuleAdvancedEventSelector":{"description":"An advanced event selector that includes optional name and field selectors","properties":{"fieldSelectors":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleAdvancedFieldSelector"},"description":"Contains all selector statements in an advanced event selector."},"name":{"type":"string","description":"An optional descriptive name for the advanced event selector"}},"type":"object","required":["fieldSelectors"]},"aws-native:observabilityadmin:TelemetryRuleAdvancedFieldSelector":{"description":"A single selector statement in an advanced event selector.","properties":{"endsWith":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the last few characters of the event record field specified as the value of Field."},"equals":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the exact value of the event record field specified as the value of Field."},"field":{"type":"string","description":"A field in a CloudTrail event record on which to filter events to be logged"},"notEndsWith":{"type":"array","items":{"type":"string"},"description":"An operator that excludes events that match the last few characters of the event record field specified as the value of Field."},"notEquals":{"type":"array","items":{"type":"string"},"description":"An operator that excludes events that match the exact value of the event record field specified as the value of Field."},"notStartsWith":{"type":"array","items":{"type":"string"},"description":"An operator that excludes events that match the first few characters of the event record field specified as the value of Field."},"startsWith":{"type":"array","items":{"type":"string"},"description":"An operator that includes events that match the first few characters of the event record field specified as the value of Field."}},"type":"object"},"aws-native:observabilityadmin:TelemetryRuleCloudtrailParameters":{"description":"Telemetry parameters for Cloudtrail","properties":{"advancedEventSelectors":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleAdvancedEventSelector"},"description":"Create fine-grained selectors for AWS CloudTrail management and data."}},"type":"object","required":["advancedEventSelectors"]},"aws-native:observabilityadmin:TelemetryRuleCondition":{"description":"A condition for a filter.","properties":{"actionCondition":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleActionCondition"},"labelNameCondition":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleLabelNameCondition"}},"type":"object"},"aws-native:observabilityadmin:TelemetryRuleDestinationType":{"description":"Type of telemetry destination","type":"string","enum":[{"name":"CloudWatchLogs","value":"cloud-watch-logs"}]},"aws-native:observabilityadmin:TelemetryRuleElbLoadBalancerLoggingParameters":{"description":"Telemetry parameters for ELB/NLB Load Balancer Logs","properties":{"fieldDelimiter":{"type":"string","description":"A delimiter to delineate log fields"},"outputFormat":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleElbLoadBalancerLoggingParametersOutputFormat","description":"The format for ELB access log entries (plain text or JSON format)."}},"type":"object"},"aws-native:observabilityadmin:TelemetryRuleElbLoadBalancerLoggingParametersOutputFormat":{"description":"The format for ELB access log entries (plain text or JSON format).","type":"string","enum":[{"name":"Plain","value":"plain"},{"name":"Json","value":"json"}]},"aws-native:observabilityadmin:TelemetryRuleFieldToMatch":{"description":"The field that we want to match this rule to.","properties":{"method":{"type":"string","description":"The method with which to match this rule."},"queryString":{"type":"string","description":"The query string to find the resource to match this field to."},"singleHeader":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleSingleHeader"},"uriPath":{"type":"string","description":"This is the URI path to match this rule to."}},"type":"object"},"aws-native:observabilityadmin:TelemetryRuleFilter":{"description":"A filter to be applied","properties":{"behavior":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleFilterBehavior"},"conditions":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleCondition"}},"requirement":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleFilterRequirement"}},"type":"object"},"aws-native:observabilityadmin:TelemetryRuleFilterBehavior":{"description":"The behavior required of the filter.","type":"string","enum":[{"name":"Keep","value":"KEEP"},{"name":"Drop","value":"DROP"}]},"aws-native:observabilityadmin:TelemetryRuleFilterRequirement":{"description":"The requirement portion of the filter.","type":"string","enum":[{"name":"MeetsAll","value":"MEETS_ALL"},{"name":"MeetsAny","value":"MEETS_ANY"}]},"aws-native:observabilityadmin:TelemetryRuleLabelNameCondition":{"description":"The label name of the condition.","properties":{"labelName":{"type":"string","description":"The label name of the condition."}},"type":"object"},"aws-native:observabilityadmin:TelemetryRuleLoggingFilter":{"description":"Default handling for logs that don't match any of the specified filtering conditions.","properties":{"defaultBehavior":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleFilterBehavior","description":"The default action (KEEP or DROP) for log records that don't match any filter conditions."},"filters":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleFilter"},"description":"A list of filter conditions that determine log record handling behavior."}},"type":"object"},"aws-native:observabilityadmin:TelemetryRuleResourceType":{"description":"Resource Type associated with the Telemetry Rule","type":"string","enum":[{"name":"Awsec2vpc","value":"AWS::EC2::VPC"},{"name":"AwswaFv2WebAcl","value":"AWS::WAFv2::WebACL"},{"name":"AwsCloudTrail","value":"AWS::CloudTrail"},{"name":"AwseksCluster","value":"AWS::EKS::Cluster"},{"name":"AwsElasticLoadBalancingV2LoadBalancer","value":"AWS::ElasticLoadBalancingV2::LoadBalancer"},{"name":"AwsBedrockAgentCoreRuntime","value":"AWS::BedrockAgentCore::Runtime"},{"name":"AwsBedrockAgentCoreBrowser","value":"AWS::BedrockAgentCore::Browser"},{"name":"AwsBedrockAgentCoreCodeInterpreter","value":"AWS::BedrockAgentCore::CodeInterpreter"}]},"aws-native:observabilityadmin:TelemetryRuleSingleHeader":{"description":"Header for the field to match.","properties":{"name":{"type":"string","description":"The name of the header"}},"type":"object","required":["name"]},"aws-native:observabilityadmin:TelemetryRuleTag":{"description":"A key-value pair to associate with a resource","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:observabilityadmin:TelemetryRuleTelemetryDestinationConfiguration":{"description":"The destination configuration for telemetry data","properties":{"cloudtrailParameters":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleCloudtrailParameters","description":"Configuration parameters specific to AWS CloudTrail when CloudTrail is the source type."},"destinationPattern":{"type":"string","description":"The pattern used to generate the destination path or name, supporting macros like \u003cresourceId\u003e and \u003caccountId\u003e."},"destinationType":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleDestinationType","description":"The type of destination for the telemetry data (e.g., \"Amazon CloudWatch Logs\", \"S3\")."},"elbLoadBalancerLoggingParameters":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleElbLoadBalancerLoggingParameters","description":"Configuration parameters specific to ELB load balancer logging when ELB is the resource type."},"logDeliveryParameters":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleTelemetryDestinationConfigurationLogDeliveryParametersProperties","description":"Parameters for BedrockAgentCore log delivery"},"retentionInDays":{"type":"integer","description":"The number of days to retain the telemetry data in the destination."},"vpcFlowLogParameters":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleVpcFlowLogParameters","description":"Configuration parameters specific to VPC Flow Logs when VPC is the resource type."},"wafLoggingParameters":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleWafLoggingParameters","description":"Configuration parameters specific to WAF logging when WAF is the resource type."}},"type":"object"},"aws-native:observabilityadmin:TelemetryRuleTelemetryDestinationConfigurationLogDeliveryParametersProperties":{"description":"Parameters for BedrockAgentCore log delivery","properties":{"logTypes":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleTelemetryDestinationConfigurationLogDeliveryParametersPropertiesLogTypesItem"},"description":"Types of logs to deliver for BedrockAgentCore resources"}},"type":"object"},"aws-native:observabilityadmin:TelemetryRuleTelemetryDestinationConfigurationLogDeliveryParametersPropertiesLogTypesItem":{"type":"string","enum":[{"name":"ApplicationLogs","value":"APPLICATION_LOGS"},{"name":"UsageLogs","value":"USAGE_LOGS"}]},"aws-native:observabilityadmin:TelemetryRuleTelemetrySourceType":{"description":"The telemetry source type that goes into the array.","type":"string","enum":[{"name":"VpcFlowLogs","value":"VPC_FLOW_LOGS"},{"name":"Route53ResolverQueryLogs","value":"ROUTE53_RESOLVER_QUERY_LOGS"},{"name":"EksAuditLogs","value":"EKS_AUDIT_LOGS"},{"name":"EksAuthenticatorLogs","value":"EKS_AUTHENTICATOR_LOGS"},{"name":"EksControllerManagerLogs","value":"EKS_CONTROLLER_MANAGER_LOGS"},{"name":"EksSchedulerLogs","value":"EKS_SCHEDULER_LOGS"},{"name":"EksApiLogs","value":"EKS_API_LOGS"}]},"aws-native:observabilityadmin:TelemetryRuleTelemetryType":{"description":"Telemetry Type associated with the Telemetry Rule","type":"string","enum":[{"name":"Logs","value":"Logs"},{"name":"Traces","value":"Traces"}]},"aws-native:observabilityadmin:TelemetryRuleVpcFlowLogParameters":{"description":"Telemetry parameters for VPC Flow logs","properties":{"logFormat":{"type":"string","description":"The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format."},"maxAggregationInterval":{"type":"integer","description":"The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s."},"trafficType":{"type":"string","description":"The type of traffic captured for the flow log. Default is ALL"}},"type":"object"},"aws-native:observabilityadmin:TelemetryRuleWafLogType":{"description":"The type of logs to generate for WAF.","type":"string","enum":[{"name":"WafLogs","value":"WAF_LOGS"}]},"aws-native:observabilityadmin:TelemetryRuleWafLoggingParameters":{"description":"Telemetry parameters for WAF v2 Web ACL","properties":{"logType":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleWafLogType","description":"The type of WAF logs to collect (currently supports WAF_LOGS)."},"loggingFilter":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleLoggingFilter","description":"A filter configuration that determines which WAF log records to include or exclude."},"redactedFields":{"type":"array","items":{"$ref":"#/types/aws-native:observabilityadmin:TelemetryRuleFieldToMatch"},"description":"Fields not to be included in the logs."}},"type":"object"},"aws-native:odb:CloudAutonomousVmClusterComputeModel":{"description":"The compute model of the Autonomous VM cluster: ECPU or OCPU.","type":"string","enum":[{"name":"Ecpu","value":"ECPU"},{"name":"Ocpu","value":"OCPU"}]},"aws-native:odb:CloudAutonomousVmClusterLicenseModel":{"description":"The Oracle license model that applies to the Autonomous VM cluster. Valid values are LICENSE_INCLUDED or BRING_YOUR_OWN_LICENSE.","type":"string","enum":[{"name":"BringYourOwnLicense","value":"BRING_YOUR_OWN_LICENSE"},{"name":"LicenseIncluded","value":"LICENSE_INCLUDED"}]},"aws-native:odb:CloudAutonomousVmClusterMaintenanceWindow":{"description":"The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.","properties":{"daysOfWeek":{"type":"array","items":{"$ref":"#/types/aws-native:odb:CloudAutonomousVmClusterMaintenanceWindowDaysOfWeekItem"},"description":"The days of the week when maintenance can be performed."},"hoursOfDay":{"type":"array","items":{"type":"integer"},"description":"The hours of the day when maintenance can be performed."},"leadTimeInWeeks":{"type":"integer","description":"The lead time in weeks before the maintenance window."},"months":{"type":"array","items":{"$ref":"#/types/aws-native:odb:CloudAutonomousVmClusterMaintenanceWindowMonthsItem"},"description":"The months when maintenance can be performed."},"preference":{"$ref":"#/types/aws-native:odb:CloudAutonomousVmClusterMaintenanceWindowPreference","description":"The preference for the maintenance window scheduling."},"weeksOfMonth":{"type":"array","items":{"type":"integer"},"description":"The weeks of the month when maintenance can be performed."}},"type":"object"},"aws-native:odb:CloudAutonomousVmClusterMaintenanceWindowDaysOfWeekItem":{"type":"string","enum":[{"name":"Monday","value":"MONDAY"},{"name":"Tuesday","value":"TUESDAY"},{"name":"Wednesday","value":"WEDNESDAY"},{"name":"Thursday","value":"THURSDAY"},{"name":"Friday","value":"FRIDAY"},{"name":"Saturday","value":"SATURDAY"},{"name":"Sunday","value":"SUNDAY"}]},"aws-native:odb:CloudAutonomousVmClusterMaintenanceWindowMonthsItem":{"type":"string","enum":[{"name":"January","value":"JANUARY"},{"name":"February","value":"FEBRUARY"},{"name":"March","value":"MARCH"},{"name":"April","value":"APRIL"},{"name":"May","value":"MAY"},{"name":"June","value":"JUNE"},{"name":"July","value":"JULY"},{"name":"August","value":"AUGUST"},{"name":"September","value":"SEPTEMBER"},{"name":"October","value":"OCTOBER"},{"name":"November","value":"NOVEMBER"},{"name":"December","value":"DECEMBER"}]},"aws-native:odb:CloudAutonomousVmClusterMaintenanceWindowPreference":{"description":"The preference for the maintenance window scheduling.","type":"string","enum":[{"name":"NoPreference","value":"NO_PREFERENCE"},{"name":"CustomPreference","value":"CUSTOM_PREFERENCE"}]},"aws-native:odb:CloudAutonomousVmClusterTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, @, -, and \"."},"value":{"type":"string","description":"The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:odb:CloudExadataInfrastructureCustomerContact":{"description":"A contact to receive notification from Oracle about maintenance updates for a specific Exadata infrastructure.","properties":{"email":{"type":"string","description":"The email address of the contact."}},"type":"object"},"aws-native:odb:CloudExadataInfrastructureMaintenanceWindow":{"description":"The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.","properties":{"customActionTimeoutInMins":{"type":"integer","description":"The timeout duration for custom actions in minutes."},"daysOfWeek":{"type":"array","items":{"$ref":"#/types/aws-native:odb:CloudExadataInfrastructureMaintenanceWindowDaysOfWeekItem"},"description":"The days of the week when maintenance can be performed."},"hoursOfDay":{"type":"array","items":{"type":"integer"},"description":"The hours of the day when maintenance can be performed."},"isCustomActionTimeoutEnabled":{"type":"boolean","description":"Indicates whether custom action timeout is enabled."},"leadTimeInWeeks":{"type":"integer","description":"The lead time in weeks before the maintenance window."},"months":{"type":"array","items":{"$ref":"#/types/aws-native:odb:CloudExadataInfrastructureMaintenanceWindowMonthsItem"},"description":"The months when maintenance can be performed."},"patchingMode":{"type":"string","description":"The patching mode for the maintenance window."},"preference":{"type":"string","description":"The preference for the maintenance window scheduling."},"weeksOfMonth":{"type":"array","items":{"type":"integer"},"description":"The weeks of the month when maintenance can be performed."}},"type":"object"},"aws-native:odb:CloudExadataInfrastructureMaintenanceWindowDaysOfWeekItem":{"type":"string","enum":[{"name":"Monday","value":"MONDAY"},{"name":"Tuesday","value":"TUESDAY"},{"name":"Wednesday","value":"WEDNESDAY"},{"name":"Thursday","value":"THURSDAY"},{"name":"Friday","value":"FRIDAY"},{"name":"Saturday","value":"SATURDAY"},{"name":"Sunday","value":"SUNDAY"}]},"aws-native:odb:CloudExadataInfrastructureMaintenanceWindowMonthsItem":{"type":"string","enum":[{"name":"January","value":"JANUARY"},{"name":"February","value":"FEBRUARY"},{"name":"March","value":"MARCH"},{"name":"April","value":"APRIL"},{"name":"May","value":"MAY"},{"name":"June","value":"JUNE"},{"name":"July","value":"JULY"},{"name":"August","value":"AUGUST"},{"name":"September","value":"SEPTEMBER"},{"name":"October","value":"OCTOBER"},{"name":"November","value":"NOVEMBER"},{"name":"December","value":"DECEMBER"}]},"aws-native:odb:CloudExadataInfrastructureTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, @, -, and \"."},"value":{"type":"string","description":"The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:odb:CloudVmClusterDataCollectionOptions":{"description":"Information about the data collection options enabled for a VM cluster.","properties":{"isDiagnosticsEventsEnabled":{"type":"boolean","description":"Indicates whether diagnostic collection is enabled for the VM cluster."},"isHealthMonitoringEnabled":{"type":"boolean","description":"Indicates whether health monitoring is enabled for the VM cluster."},"isIncidentLogsEnabled":{"type":"boolean","description":"Indicates whether incident logs are enabled for the cloud VM cluster."}},"type":"object"},"aws-native:odb:CloudVmClusterDbNode":{"description":"A DbNode is a virtual machine that hosts Oracle database instances and provides access to shared storage servers within a VM Cluster","properties":{"backupIpId":{"type":"string","description":"The Oracle Cloud ID (OCID) of the backup IP address that's associated with the DB node."},"backupVnic2Id":{"type":"string","description":"The OCID of the second backup virtual network interface card (VNIC) for the DB node."},"cpuCoreCount":{"type":"integer","description":"The number of CPU cores enabled on the DB node."},"dbNodeArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the DB node."},"dbNodeId":{"type":"string","description":"The unique identifier of the DB node."},"dbNodeStorageSizeInGbs":{"type":"integer","description":"The amount of local node storage, in gigabytes (GB), that's allocated on the DB node."},"dbServerId":{"type":"string","description":"The unique identifier of the database server that's associated with the DB node.","replaceOnChanges":true},"dbSystemId":{"type":"string","description":"The OCID of the DB system."},"hostIpId":{"type":"string","description":"The OCID of the host IP address that's associated with the DB node."},"hostname":{"type":"string","description":"The host name for the DB node."},"memorySizeInGbs":{"type":"integer","description":"The amount of memory, in gigabytes (GB), that allocated on the DB node."},"ocid":{"type":"string","description":"The OCID of the DB node."},"status":{"type":"string","description":"The current status of the DB node."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:odb:CloudVmClusterTag"}},"vnic2Id":{"type":"string","description":"The OCID of the second VNIC."},"vnicId":{"type":"string","description":"The OCID of the VNIC."}},"type":"object","required":["dbServerId"]},"aws-native:odb:CloudVmClusterLicenseModel":{"description":"The Oracle license model applied to the VM cluster.","type":"string","enum":[{"name":"BringYourOwnLicense","value":"BRING_YOUR_OWN_LICENSE"},{"name":"LicenseIncluded","value":"LICENSE_INCLUDED"}]},"aws-native:odb:CloudVmClusterTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, @, -, and \"."},"value":{"type":"string","description":"The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:odb:OdbNetworkManagedResourceStatus":{"description":"The status of the managed resource access.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Enabling","value":"ENABLING"},{"name":"Disabled","value":"DISABLED"},{"name":"Disabling","value":"DISABLING"}]},"aws-native:odb:OdbNetworkManagedServices":{"description":"The managed services configuration for the ODB network.","properties":{"managedS3BackupAccess":{"$ref":"#/types/aws-native:odb:OdbNetworkManagedServicesManagedS3BackupAccessProperties","description":"The managed Amazon S3 backup access configuration."},"managedServicesIpv4Cidrs":{"type":"array","items":{"type":"string"},"description":"The IPv4 CIDR blocks for the managed services."},"resourceGatewayArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the resource gateway."},"s3Access":{"$ref":"#/types/aws-native:odb:OdbNetworkManagedServicesS3AccessProperties","description":"The Amazon S3 access configuration."},"serviceNetworkArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the service network."},"serviceNetworkEndpoint":{"$ref":"#/types/aws-native:odb:OdbNetworkManagedServicesServiceNetworkEndpointProperties","description":"The service network endpoint configuration."},"zeroEtlAccess":{"$ref":"#/types/aws-native:odb:OdbNetworkManagedServicesZeroEtlAccessProperties","description":"The Zero-ETL access configuration."}},"type":"object"},"aws-native:odb:OdbNetworkManagedServicesManagedS3BackupAccessProperties":{"description":"The managed Amazon S3 backup access configuration.","properties":{"ipv4Addresses":{"type":"array","items":{"type":"string"},"description":"The IPv4 addresses for the managed Amazon S3 backup access."},"status":{"$ref":"#/types/aws-native:odb:OdbNetworkManagedResourceStatus","description":"The status of the managed Amazon S3 backup access."}},"type":"object"},"aws-native:odb:OdbNetworkManagedServicesS3AccessProperties":{"description":"The Amazon S3 access configuration.","properties":{"domainName":{"type":"string","description":"The domain name for the Amazon S3 access."},"ipv4Addresses":{"type":"array","items":{"type":"string"},"description":"The IPv4 addresses for the Amazon S3 access."},"s3PolicyDocument":{"type":"string","description":"The endpoint policy for the Amazon S3 access."},"status":{"$ref":"#/types/aws-native:odb:OdbNetworkManagedResourceStatus","description":"The status of the Amazon S3 access."}},"type":"object"},"aws-native:odb:OdbNetworkManagedServicesServiceNetworkEndpointProperties":{"description":"The service network endpoint configuration.","properties":{"vpcEndpointId":{"type":"string","description":"The identifier of the VPC endpoint."},"vpcEndpointType":{"$ref":"#/types/aws-native:odb:OdbNetworkManagedServicesServiceNetworkEndpointPropertiesVpcEndpointType","description":"The type of the VPC endpoint."}},"type":"object"},"aws-native:odb:OdbNetworkManagedServicesServiceNetworkEndpointPropertiesVpcEndpointType":{"description":"The type of the VPC endpoint.","type":"string","enum":[{"name":"Servicenetwork","value":"SERVICENETWORK"}]},"aws-native:odb:OdbNetworkManagedServicesZeroEtlAccessProperties":{"description":"The Zero-ETL access configuration.","properties":{"cidr":{"type":"string","description":"The CIDR block for the Zero-ETL access."},"status":{"$ref":"#/types/aws-native:odb:OdbNetworkManagedResourceStatus","description":"The status of the Zero-ETL access."}},"type":"object"},"aws-native:odb:OdbNetworkS3Access":{"description":"Specifies the configuration for Amazon S3 access from the ODB network.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:odb:OdbNetworkTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., :, /, =, +, @, -, and \"."},"value":{"type":"string","description":"The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:odb:OdbNetworkZeroEtlAccess":{"description":"Specifies the configuration for Zero-ETL access from the ODB network.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:odb:OdbPeeringConnectionTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws:. You can use any of the following characters: Unicode letters, digits, whitespace, _, ., :, /, =, +, @, -, and \"."},"value":{"type":"string","description":"The value for the tag. You can specify a value that's 1 to 256 characters in length. You can use any of the following characters: Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key"]},"aws-native:omics:AnnotationStoreAnnotationType":{"type":"string","enum":[{"name":"Generic","value":"GENERIC"},{"name":"ChrPos","value":"CHR_POS"},{"name":"ChrPosRefAlt","value":"CHR_POS_REF_ALT"},{"name":"ChrStartEndOneBase","value":"CHR_START_END_ONE_BASE"},{"name":"ChrStartEndRefAltOneBase","value":"CHR_START_END_REF_ALT_ONE_BASE"},{"name":"ChrStartEndZeroBase","value":"CHR_START_END_ZERO_BASE"},{"name":"ChrStartEndRefAltZeroBase","value":"CHR_START_END_REF_ALT_ZERO_BASE"}]},"aws-native:omics:AnnotationStoreEncryptionType":{"type":"string","enum":[{"name":"Kms","value":"KMS"}]},"aws-native:omics:AnnotationStoreReferenceItem":{"properties":{"referenceArn":{"type":"string","description":"The reference's ARN."}},"type":"object","required":["referenceArn"]},"aws-native:omics:AnnotationStoreSchemaValueType":{"type":"string","enum":[{"name":"Long","value":"LONG"},{"name":"Int","value":"INT"},{"name":"String","value":"STRING"},{"name":"Float","value":"FLOAT"},{"name":"Double","value":"DOUBLE"},{"name":"Boolean","value":"BOOLEAN"}]},"aws-native:omics:AnnotationStoreSseConfig":{"properties":{"keyArn":{"type":"string","description":"An encryption key ARN."},"type":{"$ref":"#/types/aws-native:omics:AnnotationStoreEncryptionType","description":"The encryption type."}},"type":"object","required":["type"]},"aws-native:omics:AnnotationStoreStoreFormat":{"type":"string","enum":[{"name":"Gff","value":"GFF"},{"name":"Tsv","value":"TSV"},{"name":"Vcf","value":"VCF"}]},"aws-native:omics:AnnotationStoreStoreOptions0Properties":{"properties":{"tsvStoreOptions":{"$ref":"#/types/aws-native:omics:AnnotationStoreTsvStoreOptions"}},"type":"object","required":["tsvStoreOptions"]},"aws-native:omics:AnnotationStoreStoreOptionsProperties":{"properties":{"tsvStoreOptions":{"$ref":"#/types/aws-native:omics:AnnotationStoreTsvStoreOptions"}},"type":"object","required":["tsvStoreOptions"]},"aws-native:omics:AnnotationStoreStoreStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"Active","value":"ACTIVE"},{"name":"Failed","value":"FAILED"}]},"aws-native:omics:AnnotationStoreTsvStoreOptions":{"properties":{"annotationType":{"$ref":"#/types/aws-native:omics:AnnotationStoreAnnotationType"},"formatToHeader":{"type":"object","additionalProperties":{"type":"string"}},"schema":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:omics:AnnotationStoreSchemaValueType"}}}},"type":"object"},"aws-native:omics:ReferenceStoreEncryptionType":{"type":"string","enum":[{"name":"Kms","value":"KMS"}]},"aws-native:omics:ReferenceStoreSseConfig":{"description":"Server-side encryption (SSE) settings for a store.","properties":{"keyArn":{"type":"string","description":"An encryption key ARN."},"type":{"$ref":"#/types/aws-native:omics:ReferenceStoreEncryptionType","description":"The encryption type."}},"type":"object","required":["type"]},"aws-native:omics:SequenceStoreETagAlgorithmFamily":{"type":"string","enum":[{"name":"Md5up","value":"MD5up"},{"name":"Sha256up","value":"SHA256up"},{"name":"Sha512up","value":"SHA512up"}]},"aws-native:omics:SequenceStoreEncryptionType":{"type":"string","enum":[{"name":"Kms","value":"KMS"}]},"aws-native:omics:SequenceStoreSseConfig":{"description":"Server-side encryption (SSE) settings for a store.","properties":{"keyArn":{"type":"string","description":"An encryption key ARN."},"type":{"$ref":"#/types/aws-native:omics:SequenceStoreEncryptionType","description":"The encryption type."}},"type":"object","required":["type"]},"aws-native:omics:SequenceStoreStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"Failed","value":"FAILED"}]},"aws-native:omics:VariantStoreEncryptionType":{"type":"string","enum":[{"name":"Kms","value":"KMS"}]},"aws-native:omics:VariantStoreReferenceItem":{"properties":{"referenceArn":{"type":"string","description":"The reference's ARN."}},"type":"object","required":["referenceArn"]},"aws-native:omics:VariantStoreSseConfig":{"properties":{"keyArn":{"type":"string","description":"An encryption key ARN."},"type":{"$ref":"#/types/aws-native:omics:VariantStoreEncryptionType","description":"The encryption type."}},"type":"object","required":["type"]},"aws-native:omics:VariantStoreStoreStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"Active","value":"ACTIVE"},{"name":"Failed","value":"FAILED"}]},"aws-native:omics:WorkflowAccelerators":{"type":"string","enum":[{"name":"Gpu","value":"GPU"}]},"aws-native:omics:WorkflowContainerRegistryMap":{"properties":{"imageMappings":{"type":"array","items":{"$ref":"#/types/aws-native:omics:WorkflowImageMapping"},"description":"Image mappings specify path mappings between the ECR private repository and their corresponding external repositories."},"registryMappings":{"type":"array","items":{"$ref":"#/types/aws-native:omics:WorkflowRegistryMapping"},"description":"Mapping that provides the ECR repository path where upstream container images are pulled and synchronized."}},"type":"object"},"aws-native:omics:WorkflowDefinitionRepository":{"properties":{"connectionArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the connection to the source code repository."},"excludeFilePatterns":{"type":"array","items":{"type":"string"},"description":"A list of file patterns to exclude when retrieving the workflow definition from the repository."},"fullRepositoryId":{"type":"string","description":"The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'."},"sourceReference":{"$ref":"#/types/aws-native:omics:WorkflowSourceReference","description":"The source reference for the repository, such as a branch name, tag, or commit ID."}},"type":"object"},"aws-native:omics:WorkflowEngine":{"type":"string","enum":[{"name":"Wdl","value":"WDL"},{"name":"Nextflow","value":"NEXTFLOW"},{"name":"Cwl","value":"CWL"}]},"aws-native:omics:WorkflowImageMapping":{"properties":{"destinationImage":{"type":"string","description":"Specifies the URI of the corresponding image in the private ECR registry."},"sourceImage":{"type":"string","description":"Specifies the URI of the source image in the upstream registry."}},"type":"object"},"aws-native:omics:WorkflowParameter":{"properties":{"description":{"type":"string","description":"The parameter's description."},"optional":{"type":"boolean","description":"Whether the parameter is optional."}},"type":"object"},"aws-native:omics:WorkflowRegistryMapping":{"properties":{"ecrAccountId":{"type":"string","description":"Account ID of the account that owns the upstream container image."},"ecrRepositoryPrefix":{"type":"string","description":"The repository prefix to use in the ECR private repository."},"upstreamRegistryUrl":{"type":"string","description":"The URI of the upstream registry."},"upstreamRepositoryPrefix":{"type":"string","description":"The repository prefix of the corresponding repository in the upstream registry."}},"type":"object"},"aws-native:omics:WorkflowSourceReference":{"properties":{"type":{"$ref":"#/types/aws-native:omics:WorkflowSourceReferencetype","description":"The type of source reference, such as branch, tag, or commit."},"value":{"type":"string","description":"The value of the source reference, such as the branch name, tag name, or commit ID."}},"type":"object"},"aws-native:omics:WorkflowSourceReferencetype":{"description":"The type of source reference, such as branch, tag, or commit.","type":"string","enum":[{"name":"Branch","value":"BRANCH"},{"name":"Tag","value":"TAG"},{"name":"Commit","value":"COMMIT"}]},"aws-native:omics:WorkflowStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Updating","value":"UPDATING"},{"name":"Deleted","value":"DELETED"},{"name":"Failed","value":"FAILED"}]},"aws-native:omics:WorkflowStorageType":{"type":"string","enum":[{"name":"Static","value":"STATIC"},{"name":"Dynamic","value":"DYNAMIC"}]},"aws-native:omics:WorkflowType":{"type":"string","enum":[{"name":"Private","value":"PRIVATE"}]},"aws-native:omics:WorkflowVersionAccelerators":{"type":"string","enum":[{"name":"Gpu","value":"GPU"}]},"aws-native:omics:WorkflowVersionContainerRegistryMap":{"properties":{"imageMappings":{"type":"array","items":{"$ref":"#/types/aws-native:omics:WorkflowVersionImageMapping"},"description":"Image mappings specify path mappings between the ECR private repository and their corresponding external repositories."},"registryMappings":{"type":"array","items":{"$ref":"#/types/aws-native:omics:WorkflowVersionRegistryMapping"},"description":"Mapping that provides the ECR repository path where upstream container images are pulled and synchronized."}},"type":"object"},"aws-native:omics:WorkflowVersionDefinitionRepository":{"properties":{"connectionArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the connection to the source code repository."},"excludeFilePatterns":{"type":"array","items":{"type":"string"},"description":"A list of file patterns to exclude when retrieving the workflow definition from the repository."},"fullRepositoryId":{"type":"string","description":"The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'."},"sourceReference":{"$ref":"#/types/aws-native:omics:WorkflowVersionSourceReference","description":"The source reference for the repository, such as a branch name, tag, or commit ID."}},"type":"object"},"aws-native:omics:WorkflowVersionImageMapping":{"properties":{"destinationImage":{"type":"string","description":"Specifies the URI of the corresponding image in the private ECR registry."},"sourceImage":{"type":"string","description":"Specifies the URI of the source image in the upstream registry."}},"type":"object"},"aws-native:omics:WorkflowVersionRegistryMapping":{"properties":{"ecrAccountId":{"type":"string","description":"Account ID of the account that owns the upstream container image."},"ecrRepositoryPrefix":{"type":"string","description":"The repository prefix to use in the ECR private repository."},"upstreamRegistryUrl":{"type":"string","description":"The URI of the upstream registry."},"upstreamRepositoryPrefix":{"type":"string","description":"The repository prefix of the corresponding repository in the upstream registry."}},"type":"object"},"aws-native:omics:WorkflowVersionSourceReference":{"properties":{"type":{"$ref":"#/types/aws-native:omics:WorkflowVersionSourceReferencetype","description":"The type of source reference, such as branch, tag, or commit."},"value":{"type":"string","description":"The value of the source reference, such as the branch name, tag name, or commit ID."}},"type":"object"},"aws-native:omics:WorkflowVersionSourceReferencetype":{"description":"The type of source reference, such as branch, tag, or commit.","type":"string","enum":[{"name":"Branch","value":"BRANCH"},{"name":"Tag","value":"TAG"},{"name":"Commit","value":"COMMIT"}]},"aws-native:omics:WorkflowVersionStorageType":{"type":"string","enum":[{"name":"Static","value":"STATIC"},{"name":"Dynamic","value":"DYNAMIC"}]},"aws-native:omics:WorkflowVersionWorkflowEngine":{"type":"string","enum":[{"name":"Wdl","value":"WDL"},{"name":"Nextflow","value":"NEXTFLOW"},{"name":"Cwl","value":"CWL"}]},"aws-native:omics:WorkflowVersionWorkflowParameter":{"properties":{"description":{"type":"string","description":"The parameter's description."},"optional":{"type":"boolean","description":"Whether the parameter is optional."}},"type":"object"},"aws-native:omics:WorkflowVersionWorkflowStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Updating","value":"UPDATING"},{"name":"Deleted","value":"DELETED"},{"name":"Failed","value":"FAILED"},{"name":"Inactive","value":"INACTIVE"}]},"aws-native:omics:WorkflowVersionWorkflowType":{"type":"string","enum":[{"name":"Private","value":"PRIVATE"},{"name":"Ready2run","value":"READY2RUN"}]},"aws-native:opensearchserverless:AccessPolicyType":{"description":"The possible types for the access policy","type":"string","enum":[{"name":"Data","value":"data"}]},"aws-native:opensearchserverless:CollectionEncryptionConfig":{"description":"Encryption settings for the collection","properties":{"awsOwnedKey":{"type":"boolean","description":"Indicates whether to use an AWS owned key for encryption."},"kmsKeyArn":{"type":"string","description":"Key Management Service key used to encrypt the collection."}},"type":"object"},"aws-native:opensearchserverless:CollectionGroupCapacityLimits":{"properties":{"maxIndexingCapacityInOcu":{"type":"number","description":"The maximum indexing capacity for collections in the group."},"maxSearchCapacityInOcu":{"type":"number","description":"The maximum search capacity for collections in the group."},"minIndexingCapacityInOcu":{"type":"number","description":"The minimum indexing capacity for collections in the group."},"minSearchCapacityInOcu":{"type":"number","description":"The minimum search capacity for collections in the group."}},"type":"object"},"aws-native:opensearchserverless:CollectionGroupStandbyReplicas":{"description":"Indicates whether standby replicas are used for the collection group.","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:opensearchserverless:CollectionGroupTag":{"description":"A map of key-value pairs associated with the collection group.","properties":{"key":{"type":"string","description":"The key in the key-value pair"},"value":{"type":"string","description":"The value in the key-value pair"}},"type":"object","required":["key","value"]},"aws-native:opensearchserverless:CollectionStandbyReplicas":{"description":"The possible standby replicas for the collection","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:opensearchserverless:CollectionTag":{"description":"A key-value pair metadata associated with resource","properties":{"key":{"type":"string","description":"The key in the key-value pair"},"value":{"type":"string","description":"The value in the key-value pair"}},"type":"object","required":["key","value"]},"aws-native:opensearchserverless:CollectionType":{"description":"The possible types for the collection","type":"string","enum":[{"name":"Search","value":"SEARCH"},{"name":"Timeseries","value":"TIMESERIES"},{"name":"Vectorsearch","value":"VECTORSEARCH"}]},"aws-native:opensearchserverless:IndexPropertyMapping":{"properties":{"dimension":{"type":"integer","description":"Dimension size for vector fields, defines the number of dimensions in the vector"},"index":{"type":"boolean","description":"Whether a field should be indexed"},"method":{"$ref":"#/types/aws-native:opensearchserverless:IndexPropertyMappingMethodProperties","description":"Configuration for k-NN search method"},"properties":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:opensearchserverless:IndexPropertyMapping"},"description":"Nested fields within an object or nested field type"},"type":{"$ref":"#/types/aws-native:opensearchserverless:IndexPropertyMappingType","description":"The field data type. Must be a valid OpenSearch field type."},"value":{"type":"string","description":"Default value for the field when not specified in a document"}},"type":"object","required":["type"]},"aws-native:opensearchserverless:IndexPropertyMappingMethodProperties":{"description":"Configuration for k-NN search method","properties":{"engine":{"$ref":"#/types/aws-native:opensearchserverless:IndexPropertyMappingMethodPropertiesEngine","description":"The k-NN search engine to use"},"name":{"$ref":"#/types/aws-native:opensearchserverless:IndexPropertyMappingMethodPropertiesName","description":"The algorithm name for k-NN search"},"parameters":{"$ref":"#/types/aws-native:opensearchserverless:IndexPropertyMappingMethodPropertiesParametersProperties","description":"Additional parameters for the k-NN algorithm"},"spaceType":{"$ref":"#/types/aws-native:opensearchserverless:IndexPropertyMappingMethodPropertiesSpaceType","description":"The distance function used for k-NN search"}},"type":"object","required":["name"]},"aws-native:opensearchserverless:IndexPropertyMappingMethodPropertiesEngine":{"description":"The k-NN search engine to use","type":"string","enum":[{"name":"Nmslib","value":"nmslib"},{"name":"Faiss","value":"faiss"},{"name":"Lucene","value":"lucene"}]},"aws-native:opensearchserverless:IndexPropertyMappingMethodPropertiesName":{"description":"The algorithm name for k-NN search","type":"string","enum":[{"name":"Hnsw","value":"hnsw"},{"name":"Ivf","value":"ivf"}]},"aws-native:opensearchserverless:IndexPropertyMappingMethodPropertiesParametersProperties":{"description":"Additional parameters for the k-NN algorithm","properties":{"efConstruction":{"type":"integer","description":"The size of the dynamic list used during k-NN graph creation"},"m":{"type":"integer","description":"Number of neighbors to consider during k-NN search"}},"type":"object"},"aws-native:opensearchserverless:IndexPropertyMappingMethodPropertiesSpaceType":{"description":"The distance function used for k-NN search","type":"string","enum":[{"name":"L2","value":"l2"},{"name":"L1","value":"l1"},{"name":"Linf","value":"linf"},{"name":"Cosinesimil","value":"cosinesimil"},{"name":"Innerproduct","value":"innerproduct"},{"name":"Hamming","value":"hamming"}]},"aws-native:opensearchserverless:IndexPropertyMappingType":{"description":"The field data type. Must be a valid OpenSearch field type.","type":"string","enum":[{"name":"Text","value":"text"},{"name":"KnnVector","value":"knn_vector"}]},"aws-native:opensearchserverless:IndexSettings":{"properties":{"index":{"$ref":"#/types/aws-native:opensearchserverless:IndexSettingsIndexProperties","description":"Index settings."}},"type":"object"},"aws-native:opensearchserverless:IndexSettingsIndexProperties":{"description":"Index settings.","properties":{"knn":{"type":"boolean","description":"Enable/disable k-nearest neighbor search capability"},"knnAlgoParamEfSearch":{"type":"integer","description":"Size of the dynamic list for the nearest neighbors"},"refreshInterval":{"type":"string","description":"How often to perform refresh operation (e.g. '1s', '5s')"}},"type":"object"},"aws-native:opensearchserverless:LifecyclePolicyType":{"description":"The type of lifecycle policy","type":"string","enum":[{"name":"Retention","value":"retention"}]},"aws-native:opensearchserverless:MappingsProperties":{"description":"Index Mappings","properties":{"properties":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:opensearchserverless:IndexPropertyMapping"},"description":"Defines the fields within the mapping, including their types and configurations"}},"type":"object"},"aws-native:opensearchserverless:SecurityConfigIamFederationConfigOptions":{"description":"Describe IAM federation options in form of key value map","properties":{"groupAttribute":{"type":"string","description":"Group attribute for this IAM federation integration"},"userAttribute":{"type":"string","description":"User attribute for this IAM federation integration"}},"type":"object"},"aws-native:opensearchserverless:SecurityConfigIamIdentityCenterConfigOptions":{"description":"Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map","properties":{"applicationArn":{"type":"string","description":"The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless."},"applicationDescription":{"type":"string","description":"The description of the IAM Identity Center application used to integrate with OpenSearch Serverless"},"applicationName":{"type":"string","description":"The name of the IAM Identity Center application used to integrate with OpenSearch Serverless"},"groupAttribute":{"type":"string","description":"The group attribute for this IAM Identity Center integration. Defaults to `GroupId` ."},"instanceArn":{"type":"string","description":"The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.","replaceOnChanges":true},"userAttribute":{"type":"string","description":"The user attribute for this IAM Identity Center integration. Defaults to `UserId`"}},"type":"object","required":["instanceArn"]},"aws-native:opensearchserverless:SecurityConfigSamlConfigOptions":{"description":"Describes saml options in form of key value map","properties":{"groupAttribute":{"type":"string","description":"Group attribute for this saml integration"},"metadata":{"type":"string","description":"The XML saml provider metadata document that you want to use"},"openSearchServerlessEntityId":{"type":"string","description":"Custom entity id attribute to override default entity id for this saml integration"},"sessionTimeout":{"type":"integer","description":"Defines the session timeout in minutes"},"userAttribute":{"type":"string","description":"Custom attribute for this saml integration"}},"type":"object","required":["metadata"]},"aws-native:opensearchserverless:SecurityConfigType":{"description":"Config type for security config","type":"string","enum":[{"name":"Saml","value":"saml"},{"name":"Iamidentitycenter","value":"iamidentitycenter"},{"name":"Iamfederation","value":"iamfederation"}]},"aws-native:opensearchserverless:SecurityPolicyType":{"description":"The possible types for the network policy","type":"string","enum":[{"name":"Encryption","value":"encryption"},{"name":"Network","value":"network"}]},"aws-native:opensearchservice:ApplicationAppConfig":{"description":"A key-value pair of AppConfig","properties":{"key":{"$ref":"#/types/aws-native:opensearchservice:ApplicationAppConfigType","description":"The configuration key"},"value":{"type":"string","description":"The configuration value."}},"type":"object","required":["key","value"]},"aws-native:opensearchservice:ApplicationAppConfigType":{"description":"AppConfig type values.","type":"string","enum":[{"name":"OpensearchDashboardsDashboardAdminUsers","value":"opensearchDashboards.dashboardAdmin.users"},{"name":"OpensearchDashboardsDashboardAdminGroups","value":"opensearchDashboards.dashboardAdmin.groups"}]},"aws-native:opensearchservice:ApplicationDataSource":{"description":"Datasource arn and description","properties":{"dataSourceArn":{"$ref":"pulumi.json#/Any","description":"The ARN of the data source."},"dataSourceDescription":{"type":"string","description":"Description of the data source."}},"type":"object","required":["dataSourceArn"]},"aws-native:opensearchservice:ApplicationTag":{"description":"A key-value pair metadata associated with resource","properties":{"key":{"type":"string","description":"The key in the key-value pair"},"value":{"type":"string","description":"The value in the key-value pair"}},"type":"object","required":["key","value"]},"aws-native:opensearchservice:DomainAdvancedSecurityOptionsInput":{"properties":{"anonymousAuthDisableDate":{"type":"string","description":"Date and time when the migration period will be disabled. Only necessary when [enabling fine-grained access control on an existing domain](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing) ."},"anonymousAuthEnabled":{"type":"boolean","description":"True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when [enabling fine-grained access control on an existing domain](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing) ."},"enabled":{"type":"boolean","description":"True to enable fine-grained access control. You must also enable encryption of data at rest and node-to-node encryption. See [Fine-grained access control in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html) ."},"iamFederationOptions":{"$ref":"#/types/aws-native:opensearchservice:DomainIamFederationOptions","description":"Input configuration for IAM identity federation within advanced security options."},"internalUserDatabaseEnabled":{"type":"boolean","description":"True to enable the internal user database."},"jwtOptions":{"$ref":"#/types/aws-native:opensearchservice:DomainJwtOptions","description":"Container for information about the JWT configuration of the Amazon OpenSearch Service."},"masterUserOptions":{"$ref":"#/types/aws-native:opensearchservice:DomainMasterUserOptions","description":"Specifies information about the master user."},"samlOptions":{"$ref":"#/types/aws-native:opensearchservice:DomainSamlOptions","description":"Container for information about the SAML configuration for OpenSearch Dashboards."}},"type":"object"},"aws-native:opensearchservice:DomainAimlOptions":{"properties":{"s3VectorsEngine":{"$ref":"#/types/aws-native:opensearchservice:DomainS3VectorsEngine"},"serverlessVectorAcceleration":{"$ref":"#/types/aws-native:opensearchservice:DomainServerlessVectorAcceleration"}},"type":"object"},"aws-native:opensearchservice:DomainClusterConfig":{"properties":{"coldStorageOptions":{"$ref":"#/types/aws-native:opensearchservice:DomainColdStorageOptions","description":"Container for cold storage configuration options."},"dedicatedMasterCount":{"type":"integer","description":"The number of instances to use for the master node. If you specify this property, you must specify `true` for the `DedicatedMasterEnabled` property."},"dedicatedMasterEnabled":{"type":"boolean","description":"Indicates whether to use a dedicated master node for the OpenSearch Service domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See [Dedicated master nodes in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-dedicatedmasternodes.html) ."},"dedicatedMasterType":{"type":"string","description":"The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.search` . If you specify this property, you must specify `true` for the `DedicatedMasterEnabled` property. For valid values, see [Supported instance types in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) ."},"instanceCount":{"type":"integer","description":"The number of data nodes (instances) to use in the OpenSearch Service domain."},"instanceType":{"type":"string","description":"The instance type for your data nodes, such as `m3.medium.search` . For valid values, see [Supported instance types in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) ."},"multiAzWithStandbyEnabled":{"type":"boolean","description":"Indicates whether Multi-AZ with Standby deployment option is enabled. For more information, see [Multi-AZ with Standby](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html#managedomains-za-standby) ."},"nodeOptions":{"type":"array","items":{"$ref":"#/types/aws-native:opensearchservice:DomainNodeOption"},"description":"List of node options for the domain."},"warmCount":{"type":"integer","description":"The number of warm nodes in the cluster."},"warmEnabled":{"type":"boolean","description":"Whether to enable UltraWarm storage for the cluster. See [UltraWarm storage for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ultrawarm.html) ."},"warmType":{"type":"string","description":"The instance type for the cluster's warm nodes."},"zoneAwarenessConfig":{"$ref":"#/types/aws-native:opensearchservice:DomainZoneAwarenessConfig","description":"Specifies zone awareness configuration options. Only use if `ZoneAwarenessEnabled` is `true` ."},"zoneAwarenessEnabled":{"type":"boolean","description":"Indicates whether to enable zone awareness for the OpenSearch Service domain. When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see [Configuring a multi-AZ domain in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html) ."}},"type":"object"},"aws-native:opensearchservice:DomainCognitoOptions":{"properties":{"enabled":{"type":"boolean","description":"Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. See [Amazon Cognito authentication for OpenSearch Dashboards](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html) ."},"identityPoolId":{"type":"string","description":"The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.\n\nRequired if you enabled Cognito Authentication for OpenSearch Dashboards."},"roleArn":{"type":"string","description":"The `AmazonOpenSearchServiceCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool.\n\nRequired if you enabled Cognito Authentication for OpenSearch Dashboards."},"userPoolId":{"type":"string","description":"The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.\n\nRequired if you enabled Cognito Authentication for OpenSearch Dashboards."}},"type":"object"},"aws-native:opensearchservice:DomainColdStorageOptions":{"properties":{"enabled":{"type":"boolean","description":"Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage."}},"type":"object"},"aws-native:opensearchservice:DomainEbsOptions":{"properties":{"ebsEnabled":{"type":"boolean","description":"Specifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service domain."},"iops":{"type":"integer","description":"The number of I/O operations per second (IOPS) that the volume supports. This property applies only to the `gp3` and provisioned IOPS EBS volume types."},"throughput":{"type":"integer","description":"The throughput (in MiB/s) of the EBS volumes attached to data nodes. Applies only to the `gp3` volume type."},"volumeSize":{"type":"integer","description":"The size (in GiB) of the EBS volume for each data node. The minimum and maximum size of an EBS volume depends on the EBS volume type and the instance type to which it is attached. For more information, see [EBS volume size limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide* ."},"volumeType":{"type":"string","description":"The EBS volume type to use with the OpenSearch Service domain. If you choose `gp3` , you must also specify values for `Iops` and `Throughput` . For more information about each type, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide for Linux Instances* ."}},"type":"object"},"aws-native:opensearchservice:DomainEncryptionAtRestOptions":{"properties":{"enabled":{"type":"boolean","description":"Specify `true` to enable encryption at rest. Required if you enable fine-grained access control in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) .\n\nIf no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template, the domain is deleted and recreated in order to modify the property."},"kmsKeyId":{"type":"string","description":"The KMS key ID. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a` . Required if you enable encryption at rest.\n\nYou can also use `keyAlias` as a value.\n\nIf no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template, the domain is deleted and recreated in order to modify the property."}},"type":"object"},"aws-native:opensearchservice:DomainEndpointOptions":{"properties":{"customEndpoint":{"type":"string","description":"The fully qualified URL for your custom endpoint. Required if you enabled a custom endpoint for the domain."},"customEndpointCertificateArn":{"type":"string","description":"The Certificate Manager ARN for your domain's SSL/TLS certificate. Required if you enabled a custom endpoint for the domain."},"customEndpointEnabled":{"type":"boolean","description":"True to enable a custom endpoint for the domain. If enabled, you must also provide values for `CustomEndpoint` and `CustomEndpointCertificateArn` ."},"enforceHttps":{"type":"boolean","description":"True to require that all traffic to the domain arrive over HTTPS. Required if you enable fine-grained access control in [AdvancedSecurityOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) ."},"tlsSecurityPolicy":{"type":"string","description":"The minimum TLS version required for traffic to the domain. The policy can be one of the following values:\n\n- *Policy-Min-TLS-1-0-2019-07:* TLS security policy that supports TLS version 1.0 to TLS version 1.2\n- *Policy-Min-TLS-1-2-2019-07:* TLS security policy that supports only TLS version 1.2\n- *Policy-Min-TLS-1-2-PFS-2023-10:* TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites"}},"type":"object"},"aws-native:opensearchservice:DomainIamFederationOptions":{"properties":{"enabled":{"type":"boolean"},"rolesKey":{"type":"string"},"subjectKey":{"type":"string"}},"type":"object"},"aws-native:opensearchservice:DomainIdentityCenterOptions":{"description":"Options for configuring Identity Center","properties":{"enabledApiAccess":{"type":"boolean","description":"Whether Identity Center is enabled."},"identityCenterApplicationArn":{"type":"string","description":"The ARN of the Identity Center application."},"identityCenterInstanceArn":{"type":"string","description":"The ARN of the Identity Center instance."},"identityStoreId":{"type":"string","description":"The IdentityStoreId for Identity Center options."},"rolesKey":{"$ref":"#/types/aws-native:opensearchservice:DomainRolesKeyIdcType","description":"The roles key for Identity Center options."},"subjectKey":{"$ref":"#/types/aws-native:opensearchservice:DomainSubjectKeyIdcType","description":"The subject key for Identity Center options."}},"type":"object"},"aws-native:opensearchservice:DomainIdp":{"properties":{"entityId":{"type":"string","description":"The unique entity ID of the application in the SAML identity provider."},"metadataContent":{"type":"string","description":"The metadata of the SAML application, in XML format."}},"type":"object","required":["entityId","metadataContent"]},"aws-native:opensearchservice:DomainJwtOptions":{"properties":{"enabled":{"type":"boolean"},"publicKey":{"type":"string"},"rolesKey":{"type":"string"},"subjectKey":{"type":"string"}},"type":"object"},"aws-native:opensearchservice:DomainLogPublishingOption":{"properties":{"cloudWatchLogsLogGroupArn":{"type":"string"},"enabled":{"type":"boolean"}},"type":"object"},"aws-native:opensearchservice:DomainMasterUserOptions":{"properties":{"masterUserArn":{"type":"string","description":"Amazon Resource Name (ARN) for the master user. The ARN can point to an IAM user or role. This property is required for Amazon Cognito to work, and it must match the role configured for Cognito. Only specify if `InternalUserDatabaseEnabled` is false in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) ."},"masterUserName":{"type":"string","description":"Username for the master user. Only specify if `InternalUserDatabaseEnabled` is true in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) .\n\nIf you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead."},"masterUserPassword":{"type":"string","description":"Password for the master user. Only specify if `InternalUserDatabaseEnabled` is true in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) .\n\nIf you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead."}},"type":"object"},"aws-native:opensearchservice:DomainNodeConfig":{"properties":{"count":{"type":"integer","description":"The number of nodes of a specific type within the cluster."},"enabled":{"type":"boolean","description":"A boolean value indicating whether a specific node type is active or inactive."},"type":{"type":"string","description":"The instance type of a particular node within the cluster."}},"type":"object"},"aws-native:opensearchservice:DomainNodeOption":{"properties":{"nodeConfig":{"$ref":"#/types/aws-native:opensearchservice:DomainNodeConfig","description":"Configuration options for defining the setup of any node type."},"nodeType":{"$ref":"#/types/aws-native:opensearchservice:DomainNodeOptionNodeType","description":"Defines the type of node, such as coordinating nodes."}},"type":"object"},"aws-native:opensearchservice:DomainNodeOptionNodeType":{"description":"Defines the type of node, such as coordinating nodes.","type":"string","enum":[{"name":"Coordinator","value":"coordinator"}]},"aws-native:opensearchservice:DomainNodeToNodeEncryptionOptions":{"properties":{"enabled":{"type":"boolean","description":"Specifies to enable or disable node-to-node encryption on the domain. Required if you enable fine-grained access control in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) ."}},"type":"object"},"aws-native:opensearchservice:DomainOffPeakWindow":{"properties":{"windowStartTime":{"$ref":"#/types/aws-native:opensearchservice:DomainWindowStartTime","description":"The desired start time for an off-peak maintenance window."}},"type":"object"},"aws-native:opensearchservice:DomainOffPeakWindowOptions":{"properties":{"enabled":{"type":"boolean","description":"Specifies whether off-peak window settings are enabled for the domain."},"offPeakWindow":{"$ref":"#/types/aws-native:opensearchservice:DomainOffPeakWindow","description":"Off-peak window settings for the domain."}},"type":"object"},"aws-native:opensearchservice:DomainRolesKeyIdcType":{"description":"Roles Key Idc type values.","type":"string","enum":[{"name":"GroupName","value":"GroupName"},{"name":"GroupId","value":"GroupId"}]},"aws-native:opensearchservice:DomainS3VectorsEngine":{"properties":{"enabled":{"type":"boolean","description":"Whether to enable S3 vectors engine."}},"type":"object","required":["enabled"]},"aws-native:opensearchservice:DomainSamlOptions":{"properties":{"enabled":{"type":"boolean","description":"True to enable SAML authentication for a domain."},"idp":{"$ref":"#/types/aws-native:opensearchservice:DomainIdp","description":"The SAML Identity Provider's information."},"masterBackendRole":{"type":"string","description":"The backend role that the SAML master user is mapped to."},"masterUserName":{"type":"string","description":"The SAML master user name, which is stored in the domain's internal user database."},"rolesKey":{"type":"string","description":"Element of the SAML assertion to use for backend roles. Default is `roles` ."},"sessionTimeoutMinutes":{"type":"integer","description":"The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60."},"subjectKey":{"type":"string","description":"Element of the SAML assertion to use for the user name. Default is `NameID` ."}},"type":"object"},"aws-native:opensearchservice:DomainServerlessVectorAcceleration":{"properties":{"enabled":{"type":"boolean","description":"Whether to enable serverless vector acceleration."}},"type":"object"},"aws-native:opensearchservice:DomainServiceSoftwareOptions":{"properties":{"automatedUpdateDate":{"type":"string","description":"The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software."},"cancellable":{"type":"boolean","description":"True if you're able to cancel your service software version update. False if you can't cancel your service software update."},"currentVersion":{"type":"string","description":"The current service software version present on the domain."},"description":{"type":"string","description":"A description of the service software update status."},"newVersion":{"type":"string","description":"The new service software version, if one is available."},"optionalDeployment":{"type":"boolean","description":"True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date."},"updateAvailable":{"type":"boolean","description":"True if you're able to update your service software version. False if you can't update your service software version."},"updateStatus":{"type":"string","description":"The status of your service software update."}},"type":"object"},"aws-native:opensearchservice:DomainSnapshotOptions":{"properties":{"automatedSnapshotStartHour":{"type":"integer","description":"The hour in UTC during which the service takes an automated daily snapshot of the indexes in the OpenSearch Service domain. For example, if you specify 0, OpenSearch Service takes an automated snapshot everyday between midnight and 1 am. You can specify a value between 0 and 23."}},"type":"object"},"aws-native:opensearchservice:DomainSoftwareUpdateOptions":{"properties":{"autoSoftwareUpdateEnabled":{"type":"boolean","description":"Specifies whether automatic service software updates are enabled for the domain."}},"type":"object"},"aws-native:opensearchservice:DomainSubjectKeyIdcType":{"description":"Subject Key Idc type values.","type":"string","enum":[{"name":"UserName","value":"UserName"},{"name":"UserId","value":"UserId"},{"name":"Email","value":"Email"}]},"aws-native:opensearchservice:DomainTag":{"properties":{"key":{"type":"string","description":"The value of the tag."},"value":{"type":"string","description":"The key of the tag."}},"type":"object","required":["key","value"]},"aws-native:opensearchservice:DomainVpcOptions":{"properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The list of security group IDs that are associated with the VPC endpoints for the domain. If you don't provide a security group ID, OpenSearch Service uses the default security group for the VPC. To learn more, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon VPC User Guide* ."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"Provide one subnet ID for each Availability Zone that your domain uses. For example, you must specify three subnet IDs for a three-AZ domain. To learn more, see [VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) in the *Amazon VPC User Guide* .\n\nIf you specify more than one subnet, you must also configure `ZoneAwarenessEnabled` and `ZoneAwarenessConfig` within [ClusterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html) , otherwise you'll see the error \"You must specify exactly one subnet\" during template creation."}},"type":"object"},"aws-native:opensearchservice:DomainWindowStartTime":{"properties":{"hours":{"type":"integer","description":"The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC. The minimum value is 0 and the maximum value is 23."},"minutes":{"type":"integer","description":"The start minute of the window, in UTC. The minimum value is 0 and the maximum value is 59."}},"type":"object","required":["hours","minutes"]},"aws-native:opensearchservice:DomainZoneAwarenessConfig":{"properties":{"availabilityZoneCount":{"type":"integer","description":"If you enabled multiple Availability Zones (AZs), the number of AZs that you want the domain to use.\n\nValid values are `2` and `3` . Default is 2."}},"type":"object"},"aws-native:opensearchservice:IamIdentityCenterOptionsProperties":{"description":"Options for configuring IAM Identity Center","properties":{"enabled":{"type":"boolean","description":"Whether IAM Identity Center is enabled."},"iamIdentityCenterInstanceArn":{"$ref":"pulumi.json#/Any","description":"The ARN of the IAM Identity Center instance."},"iamRoleForIdentityCenterApplicationArn":{"type":"string","description":"The ARN of the IAM role for Identity Center application."}},"type":"object"},"aws-native:opsworkscm:ServerEngineAttribute":{"properties":{"name":{"type":"string","description":"The name of the engine attribute.\n\n*Attribute name for Chef Automate servers:*\n\n- `CHEF_AUTOMATE_ADMIN_PASSWORD`\n\n*Attribute names for Puppet Enterprise servers:*\n\n- `PUPPET_ADMIN_PASSWORD`\n- `PUPPET_R10K_REMOTE`\n- `PUPPET_R10K_PRIVATE_KEY`"},"value":{"type":"string","description":"The value of the engine attribute.\n\n*Attribute value for Chef Automate servers:*\n\n- `CHEF_AUTOMATE_PIVOTAL_KEY` : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. You can generate this key by running the following [OpenSSL](https://docs.aws.amazon.com/https://www.openssl.org/) command on Linux-based computers.\n\n`openssl genrsa -out *pivotal_key_file_name* .pem 2048`\n\nOn Windows-based computers, you can use the PuTTYgen utility to generate a base64-encoded RSA private key. For more information, see [PuTTYgen - Key Generator for PuTTY on Windows](https://docs.aws.amazon.com/https://www.ssh.com/ssh/putty/windows/puttygen) on SSH.com.\n\n*Attribute values for Puppet Enterprise servers:*\n\n- `PUPPET_ADMIN_PASSWORD` : An administrator password that you can use to sign in to the Puppet Enterprise console webpage after the server is online. The password must use between 8 and 32 ASCII characters.\n- `PUPPET_R10K_REMOTE` : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.\n- `PUPPET_R10K_PRIVATE_KEY` : If you are using a private Git repository, add `PUPPET_R10K_PRIVATE_KEY` to specify a PEM-encoded private SSH key."}},"type":"object"},"aws-native:opsworkscm:ServerTag":{"properties":{"key":{"type":"string","description":"A tag key, such as `Stage` or `Name` . A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: `+ - = . _ : /`"},"value":{"type":"string","description":"An optional tag value, such as `Production` or `test-owcm-server` . The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: `+ - = . _ : /`"}},"type":"object","required":["key","value"]},"aws-native:organizations:AccountJoinedMethod":{"description":"The method by which the account joined the organization.","type":"string","enum":[{"name":"Invited","value":"INVITED"},{"name":"Created","value":"CREATED"}]},"aws-native:organizations:AccountState":{"description":"The state of the account in the organization.","type":"string","enum":[{"name":"PendingActivation","value":"PENDING_ACTIVATION"},{"name":"Active","value":"ACTIVE"},{"name":"Suspended","value":"SUSPENDED"},{"name":"PendingClosure","value":"PENDING_CLOSURE"},{"name":"Closed","value":"CLOSED"}]},"aws-native:organizations:AccountStatus":{"description":"The status of the account in the organization.","type":"string","enum":[{"name":"Active","value":"ACTIVE"},{"name":"Suspended","value":"SUSPENDED"},{"name":"PendingClosure","value":"PENDING_CLOSURE"}]},"aws-native:organizations:AccountTag":{"description":"A custom key-value pair associated with a resource within your organization.","properties":{"key":{"type":"string","description":"The key identifier, or name, of the tag."},"value":{"type":"string","description":"The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null."}},"type":"object","required":["key","value"]},"aws-native:organizations:OrganizationFeatureSet":{"description":"Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.","type":"string","enum":[{"name":"All","value":"ALL"},{"name":"ConsolidatedBilling","value":"CONSOLIDATED_BILLING"}]},"aws-native:organizations:OrganizationalUnitTag":{"description":"A custom key-value pair associated with a resource within your organization.","properties":{"key":{"type":"string","description":"The key identifier, or name, of the tag."},"value":{"type":"string","description":"The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null."}},"type":"object","required":["key","value"]},"aws-native:organizations:PolicyTag":{"description":"A custom key-value pair associated with a resource within your organization.","properties":{"key":{"type":"string","description":"The key identifier, or name, of the tag."},"value":{"type":"string","description":"The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null."}},"type":"object","required":["key","value"]},"aws-native:organizations:PolicyType":{"description":"The type of policy to create. You can specify one of the following values: AISERVICES_OPT_OUT_POLICY, BACKUP_POLICY, BEDROCK_POLICY, CHATBOT_POLICY, DECLARATIVE_POLICY_EC2, INSPECTOR_POLICY, NETWORK_SECURITY_DIRECTOR_POLICY, RESOURCE_CONTROL_POLICY, S3_POLICY, SECURITYHUB_POLICY, SERVICE_CONTROL_POLICY, TAG_POLICY, UPGRADE_ROLLOUT_POLICY","type":"string","enum":[{"name":"AiservicesOptOutPolicy","value":"AISERVICES_OPT_OUT_POLICY"},{"name":"BackupPolicy","value":"BACKUP_POLICY"},{"name":"BedrockPolicy","value":"BEDROCK_POLICY"},{"name":"ChatbotPolicy","value":"CHATBOT_POLICY"},{"name":"DeclarativePolicyEc2","value":"DECLARATIVE_POLICY_EC2"},{"name":"InspectorPolicy","value":"INSPECTOR_POLICY"},{"name":"NetworkSecurityDirectorPolicy","value":"NETWORK_SECURITY_DIRECTOR_POLICY"},{"name":"ResourceControlPolicy","value":"RESOURCE_CONTROL_POLICY"},{"name":"S3Policy","value":"S3_POLICY"},{"name":"SecurityhubPolicy","value":"SECURITYHUB_POLICY"},{"name":"ServiceControlPolicy","value":"SERVICE_CONTROL_POLICY"},{"name":"TagPolicy","value":"TAG_POLICY"},{"name":"UpgradeRolloutPolicy","value":"UPGRADE_ROLLOUT_POLICY"}]},"aws-native:organizations:ResourcePolicyTag":{"description":"A custom key-value pair associated with a resource within your organization.","properties":{"key":{"type":"string","description":"The key identifier, or name, of the tag."},"value":{"type":"string","description":"The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null."}},"type":"object","required":["key","value"]},"aws-native:osis:PipelineBufferOptions":{"description":"Key-value pairs to configure buffering.","properties":{"persistentBufferEnabled":{"type":"boolean","description":"Whether persistent buffering should be enabled."}},"type":"object","required":["persistentBufferEnabled"]},"aws-native:osis:PipelineEncryptionAtRestOptions":{"description":"Key-value pairs to configure encryption at rest.","properties":{"kmsKeyArn":{"type":"string","description":"The KMS key to use for encrypting data. By default an AWS owned key is used"}},"type":"object","required":["kmsKeyArn"]},"aws-native:osis:PipelineLogPublishingOptions":{"description":"Key-value pairs to configure log publishing.","properties":{"cloudWatchLogDestination":{"$ref":"#/types/aws-native:osis:PipelineLogPublishingOptionsCloudWatchLogDestinationProperties","description":"The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch."},"isLoggingEnabled":{"type":"boolean","description":"Whether logs should be published."}},"type":"object"},"aws-native:osis:PipelineLogPublishingOptionsCloudWatchLogDestinationProperties":{"description":"The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.","properties":{"logGroup":{"type":"string"}},"type":"object","required":["logGroup"]},"aws-native:osis:PipelineResourcePolicy":{"properties":{"policy":{"$ref":"pulumi.json#/Any"}},"type":"object","required":["policy"]},"aws-native:osis:PipelineTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -."}},"type":"object","required":["key","value"]},"aws-native:osis:PipelineVpcEndpoint":{"description":"An OpenSearch Ingestion Service-managed VPC endpoint that will access one or more pipelines.","properties":{"vpcEndpointId":{"type":"string","description":"The unique identifier of the endpoint."},"vpcId":{"type":"string","description":"The ID for your VPC. AWS Privatelink generates this value when you create a VPC."},"vpcOptions":{"$ref":"#/types/aws-native:osis:PipelineVpcOptions","description":"Information about the VPC, including associated subnets and security groups."}},"type":"object"},"aws-native:osis:PipelineVpcOptions":{"description":"Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion Service creates the pipeline with a public endpoint.","properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"A list of security groups associated with the VPC endpoint."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"A list of subnet IDs associated with the VPC endpoint."},"vpcAttachmentOptions":{"$ref":"#/types/aws-native:osis:PipelineVpcOptionsVpcAttachmentOptionsProperties","description":"Options for attaching a VPC to the pipeline."},"vpcEndpointManagement":{"$ref":"#/types/aws-native:osis:PipelineVpcOptionsVpcEndpointManagement","description":"Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline."}},"type":"object","required":["subnetIds"]},"aws-native:osis:PipelineVpcOptionsVpcAttachmentOptionsProperties":{"description":"Options for attaching a VPC to the pipeline.","properties":{"attachToVpc":{"type":"boolean","description":"Whether the pipeline should be attached to the provided VPC"},"cidrBlock":{"type":"string","description":"The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs)."}},"type":"object","required":["attachToVpc","cidrBlock"]},"aws-native:osis:PipelineVpcOptionsVpcEndpointManagement":{"description":"Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.","type":"string","enum":[{"name":"Customer","value":"CUSTOMER"},{"name":"Service","value":"SERVICE"}]},"aws-native:panorama:ApplicationInstanceHealthStatus":{"type":"string","enum":[{"name":"Running","value":"RUNNING"},{"name":"Error","value":"ERROR"},{"name":"NotAvailable","value":"NOT_AVAILABLE"}]},"aws-native:panorama:ApplicationInstanceManifestOverridesPayload":{"description":"Parameter overrides for an application instance. This is a JSON document that has a single key (``PayloadData``) where the value is an escaped string representation of the overrides document.","properties":{"payloadData":{"type":"string","description":"The overrides document."}},"type":"object"},"aws-native:panorama:ApplicationInstanceManifestPayload":{"description":"A application verion's manifest file. This is a JSON document that has a single key (``PayloadData``) where the value is an escaped string representation of the application manifest (``graph.json``). This file is located in the ``graphs`` folder in your application source.","properties":{"payloadData":{"type":"string","description":"The application manifest."}},"type":"object"},"aws-native:panorama:ApplicationInstanceStatus":{"type":"string","enum":[{"name":"DeploymentPending","value":"DEPLOYMENT_PENDING"},{"name":"DeploymentRequested","value":"DEPLOYMENT_REQUESTED"},{"name":"DeploymentInProgress","value":"DEPLOYMENT_IN_PROGRESS"},{"name":"DeploymentError","value":"DEPLOYMENT_ERROR"},{"name":"DeploymentSucceeded","value":"DEPLOYMENT_SUCCEEDED"},{"name":"RemovalPending","value":"REMOVAL_PENDING"},{"name":"RemovalRequested","value":"REMOVAL_REQUESTED"},{"name":"RemovalInProgress","value":"REMOVAL_IN_PROGRESS"},{"name":"RemovalFailed","value":"REMOVAL_FAILED"},{"name":"RemovalSucceeded","value":"REMOVAL_SUCCEEDED"}]},"aws-native:panorama:ApplicationInstanceTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:panorama:PackageStorageLocation":{"description":"A storage location.","properties":{"binaryPrefixLocation":{"type":"string","description":"The location's binary prefix."},"bucket":{"type":"string","description":"The location's bucket."},"generatedPrefixLocation":{"type":"string","description":"The location's generated prefix."},"manifestPrefixLocation":{"type":"string","description":"The location's manifest prefix."},"repoPrefixLocation":{"type":"string","description":"The location's repo prefix."}},"type":"object"},"aws-native:panorama:PackageTag":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object","required":["key","value"]},"aws-native:panorama:PackageVersionStatus":{"type":"string","enum":[{"name":"RegisterPending","value":"REGISTER_PENDING"},{"name":"RegisterCompleted","value":"REGISTER_COMPLETED"},{"name":"Failed","value":"FAILED"},{"name":"Deleting","value":"DELETING"}]},"aws-native:paymentcryptography:KeyAlgorithm":{"type":"string","enum":[{"name":"Tdes2key","value":"TDES_2KEY"},{"name":"Tdes3key","value":"TDES_3KEY"},{"name":"Aes128","value":"AES_128"},{"name":"Aes192","value":"AES_192"},{"name":"Aes256","value":"AES_256"},{"name":"HmacSha256","value":"HMAC_SHA256"},{"name":"HmacSha384","value":"HMAC_SHA384"},{"name":"HmacSha512","value":"HMAC_SHA512"},{"name":"HmacSha224","value":"HMAC_SHA224"},{"name":"Rsa2048","value":"RSA_2048"},{"name":"Rsa3072","value":"RSA_3072"},{"name":"Rsa4096","value":"RSA_4096"},{"name":"EccNistP256","value":"ECC_NIST_P256"},{"name":"EccNistP384","value":"ECC_NIST_P384"},{"name":"EccNistP521","value":"ECC_NIST_P521"}]},"aws-native:paymentcryptography:KeyAttributes":{"properties":{"keyAlgorithm":{"$ref":"#/types/aws-native:paymentcryptography:KeyAlgorithm","description":"The key algorithm to be use during creation of an AWS Payment Cryptography key.\n\nFor symmetric keys, AWS Payment Cryptography supports `AES` and `TDES` algorithms. For asymmetric keys, AWS Payment Cryptography supports `RSA` and `ECC_NIST` algorithms."},"keyClass":{"$ref":"#/types/aws-native:paymentcryptography:KeyClass","description":"The type of AWS Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether AWS Payment Cryptography key contains a symmetric key or an asymmetric key pair."},"keyModesOfUse":{"$ref":"#/types/aws-native:paymentcryptography:KeyModesOfUse","description":"The list of cryptographic operations that you can perform using the key."},"keyUsage":{"$ref":"#/types/aws-native:paymentcryptography:KeyUsage","description":"The cryptographic usage of an AWS Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec."}},"type":"object","required":["keyAlgorithm","keyClass","keyModesOfUse","keyUsage"]},"aws-native:paymentcryptography:KeyCheckValueAlgorithm":{"type":"string","enum":[{"name":"Cmac","value":"CMAC"},{"name":"AnsiX924","value":"ANSI_X9_24"},{"name":"Hmac","value":"HMAC"},{"name":"Sha1","value":"SHA_1"}]},"aws-native:paymentcryptography:KeyClass":{"type":"string","enum":[{"name":"SymmetricKey","value":"SYMMETRIC_KEY"},{"name":"AsymmetricKeyPair","value":"ASYMMETRIC_KEY_PAIR"},{"name":"PrivateKey","value":"PRIVATE_KEY"},{"name":"PublicKey","value":"PUBLIC_KEY"}]},"aws-native:paymentcryptography:KeyDeriveKeyUsage":{"type":"string","enum":[{"name":"Tr31b0BaseDerivationKey","value":"TR31_B0_BASE_DERIVATION_KEY"},{"name":"Tr31c0CardVerificationKey","value":"TR31_C0_CARD_VERIFICATION_KEY"},{"name":"Tr31d0SymmetricDataEncryptionKey","value":"TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY"},{"name":"Tr31e0EmvMkeyAppCryptograms","value":"TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS"},{"name":"Tr31e1EmvMkeyConfidentiality","value":"TR31_E1_EMV_MKEY_CONFIDENTIALITY"},{"name":"Tr31e2EmvMkeyIntegrity","value":"TR31_E2_EMV_MKEY_INTEGRITY"},{"name":"Tr31e4EmvMkeyDynamicNumbers","value":"TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS"},{"name":"Tr31e5EmvMkeyCardPersonalization","value":"TR31_E5_EMV_MKEY_CARD_PERSONALIZATION"},{"name":"Tr31e6EmvMkeyOther","value":"TR31_E6_EMV_MKEY_OTHER"},{"name":"Tr31k0KeyEncryptionKey","value":"TR31_K0_KEY_ENCRYPTION_KEY"},{"name":"Tr31k1KeyBlockProtectionKey","value":"TR31_K1_KEY_BLOCK_PROTECTION_KEY"},{"name":"Tr31m3Iso97973MacKey","value":"TR31_M3_ISO_9797_3_MAC_KEY"},{"name":"Tr31m1Iso97971MacKey","value":"TR31_M1_ISO_9797_1_MAC_KEY"},{"name":"Tr31m6Iso97975CmacKey","value":"TR31_M6_ISO_9797_5_CMAC_KEY"},{"name":"Tr31m7HmacKey","value":"TR31_M7_HMAC_KEY"},{"name":"Tr31p0PinEncryptionKey","value":"TR31_P0_PIN_ENCRYPTION_KEY"},{"name":"Tr31p1PinGenerationKey","value":"TR31_P1_PIN_GENERATION_KEY"},{"name":"Tr31v1Ibm3624PinVerificationKey","value":"TR31_V1_IBM3624_PIN_VERIFICATION_KEY"},{"name":"Tr31v2VisaPinVerificationKey","value":"TR31_V2_VISA_PIN_VERIFICATION_KEY"}]},"aws-native:paymentcryptography:KeyModesOfUse":{"properties":{"decrypt":{"type":"boolean","description":"Speciﬁes whether an AWS Payment Cryptography key can be used to decrypt data."},"deriveKey":{"type":"boolean","description":"Speciﬁes whether an AWS Payment Cryptography key can be used to derive new keys."},"encrypt":{"type":"boolean","description":"Speciﬁes whether an AWS Payment Cryptography key can be used to encrypt data."},"generate":{"type":"boolean","description":"Speciﬁes whether an AWS Payment Cryptography key can be used to generate and verify other card and PIN verification keys."},"noRestrictions":{"type":"boolean","description":"Speciﬁes whether an AWS Payment Cryptography key has no special restrictions other than the restrictions implied by `KeyUsage` ."},"sign":{"type":"boolean","description":"Speciﬁes whether an AWS Payment Cryptography key can be used for signing."},"unwrap":{"type":"boolean"},"verify":{"type":"boolean","description":"Speciﬁes whether an AWS Payment Cryptography key can be used to verify signatures."},"wrap":{"type":"boolean","description":"Speciﬁes whether an AWS Payment Cryptography key can be used to wrap other keys."}},"type":"object"},"aws-native:paymentcryptography:KeyOrigin":{"description":"Defines the source of a key","type":"string","enum":[{"name":"External","value":"EXTERNAL"},{"name":"AwsPaymentCryptography","value":"AWS_PAYMENT_CRYPTOGRAPHY"}]},"aws-native:paymentcryptography:KeyReplicationState":{"description":"Defines the replication state of a key","type":"string","enum":[{"name":"InProgress","value":"IN_PROGRESS"},{"name":"DeleteInProgress","value":"DELETE_IN_PROGRESS"},{"name":"Failed","value":"FAILED"},{"name":"Synchronized","value":"SYNCHRONIZED"}]},"aws-native:paymentcryptography:KeyReplicationStatusType":{"properties":{"status":{"$ref":"#/types/aws-native:paymentcryptography:KeyReplicationState","description":"The current status of key replication in this AWS Region .\n\nThis field indicates whether the key replication is in progress, completed successfully, or has encountered an error. Possible values include states such as `SYNCRHONIZED` , `IN_PROGRESS` , `DELETE_IN_PROGRESS` , or `FAILED` . This provides visibility into the replication process for monitoring and troubleshooting purposes."},"statusMessage":{"type":"string","description":"A message that provides additional information about the current replication status of the key.\n\nThis field contains details about any issues or progress updates related to key replication operations. It may include information about replication failures, synchronization status, or other operational details."}},"type":"object","required":["status"]},"aws-native:paymentcryptography:KeyState":{"description":"Defines the state of a key","type":"string","enum":[{"name":"CreateInProgress","value":"CREATE_IN_PROGRESS"},{"name":"CreateComplete","value":"CREATE_COMPLETE"},{"name":"DeletePending","value":"DELETE_PENDING"},{"name":"DeleteComplete","value":"DELETE_COMPLETE"}]},"aws-native:paymentcryptography:KeyTag":{"properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"type":"object","required":["key","value"]},"aws-native:paymentcryptography:KeyUsage":{"type":"string","enum":[{"name":"Tr31b0BaseDerivationKey","value":"TR31_B0_BASE_DERIVATION_KEY"},{"name":"Tr31c0CardVerificationKey","value":"TR31_C0_CARD_VERIFICATION_KEY"},{"name":"Tr31d0SymmetricDataEncryptionKey","value":"TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY"},{"name":"Tr31d1AsymmetricKeyForDataEncryption","value":"TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION"},{"name":"Tr31e0EmvMkeyAppCryptograms","value":"TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS"},{"name":"Tr31e1EmvMkeyConfidentiality","value":"TR31_E1_EMV_MKEY_CONFIDENTIALITY"},{"name":"Tr31e2EmvMkeyIntegrity","value":"TR31_E2_EMV_MKEY_INTEGRITY"},{"name":"Tr31e4EmvMkeyDynamicNumbers","value":"TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS"},{"name":"Tr31e5EmvMkeyCardPersonalization","value":"TR31_E5_EMV_MKEY_CARD_PERSONALIZATION"},{"name":"Tr31e6EmvMkeyOther","value":"TR31_E6_EMV_MKEY_OTHER"},{"name":"Tr31k0KeyEncryptionKey","value":"TR31_K0_KEY_ENCRYPTION_KEY"},{"name":"Tr31k1KeyBlockProtectionKey","value":"TR31_K1_KEY_BLOCK_PROTECTION_KEY"},{"name":"Tr31k3AsymmetricKeyForKeyAgreement","value":"TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT"},{"name":"Tr31m0Iso16609MacKey","value":"TR31_M0_ISO_16609_MAC_KEY"},{"name":"Tr31m3Iso97973MacKey","value":"TR31_M3_ISO_9797_3_MAC_KEY"},{"name":"Tr31m1Iso97971MacKey","value":"TR31_M1_ISO_9797_1_MAC_KEY"},{"name":"Tr31m6Iso97975CmacKey","value":"TR31_M6_ISO_9797_5_CMAC_KEY"},{"name":"Tr31m7HmacKey","value":"TR31_M7_HMAC_KEY"},{"name":"Tr31p0PinEncryptionKey","value":"TR31_P0_PIN_ENCRYPTION_KEY"},{"name":"Tr31p1PinGenerationKey","value":"TR31_P1_PIN_GENERATION_KEY"},{"name":"Tr31s0AsymmetricKeyForDigitalSignature","value":"TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE"},{"name":"Tr31v1Ibm3624PinVerificationKey","value":"TR31_V1_IBM3624_PIN_VERIFICATION_KEY"},{"name":"Tr31v2VisaPinVerificationKey","value":"TR31_V2_VISA_PIN_VERIFICATION_KEY"},{"name":"Tr31k2Tr34AsymmetricKey","value":"TR31_K2_TR34_ASYMMETRIC_KEY"}]},"aws-native:pcaconnectorad:ConnectorVpcInformation":{"properties":{"ipAddressType":{"$ref":"#/types/aws-native:pcaconnectorad:ConnectorVpcInformationIpAddressType","description":"The VPC IP address type."},"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The security groups used with the connector. You can use a maximum of 4 security groups with a connector."}},"type":"object","required":["securityGroupIds"]},"aws-native:pcaconnectorad:ConnectorVpcInformationIpAddressType":{"description":"The VPC IP address type.","type":"string","enum":[{"name":"Ipv4","value":"IPV4"},{"name":"Dualstack","value":"DUALSTACK"}]},"aws-native:pcaconnectorad:TemplateApplicationPolicies":{"properties":{"critical":{"type":"boolean"},"policies":{"type":"array","items":{"oneOf":[{"$ref":"#/types/aws-native:pcaconnectorad:TemplateApplicationPolicy0Properties"},{"$ref":"#/types/aws-native:pcaconnectorad:TemplateApplicationPolicy1Properties"}]}}},"type":"object","required":["policies"]},"aws-native:pcaconnectorad:TemplateApplicationPolicy0Properties":{"properties":{"policyType":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateApplicationPolicyType"}},"type":"object","required":["policyType"]},"aws-native:pcaconnectorad:TemplateApplicationPolicy1Properties":{"properties":{"policyObjectIdentifier":{"type":"string"}},"type":"object","required":["policyObjectIdentifier"]},"aws-native:pcaconnectorad:TemplateApplicationPolicyType":{"type":"string","enum":[{"name":"AllApplicationPolicies","value":"ALL_APPLICATION_POLICIES"},{"name":"AnyPurpose","value":"ANY_PURPOSE"},{"name":"AttestationIdentityKeyCertificate","value":"ATTESTATION_IDENTITY_KEY_CERTIFICATE"},{"name":"CertificateRequestAgent","value":"CERTIFICATE_REQUEST_AGENT"},{"name":"ClientAuthentication","value":"CLIENT_AUTHENTICATION"},{"name":"CodeSigning","value":"CODE_SIGNING"},{"name":"CtlUsage","value":"CTL_USAGE"},{"name":"DigitalRights","value":"DIGITAL_RIGHTS"},{"name":"DirectoryServiceEmailReplication","value":"DIRECTORY_SERVICE_EMAIL_REPLICATION"},{"name":"DisallowedList","value":"DISALLOWED_LIST"},{"name":"DnsServerTrust","value":"DNS_SERVER_TRUST"},{"name":"DocumentEncryption","value":"DOCUMENT_ENCRYPTION"},{"name":"DocumentSigning","value":"DOCUMENT_SIGNING"},{"name":"DynamicCodeGenerator","value":"DYNAMIC_CODE_GENERATOR"},{"name":"EarlyLaunchAntimalwareDriver","value":"EARLY_LAUNCH_ANTIMALWARE_DRIVER"},{"name":"EmbeddedWindowsSystemComponentVerification","value":"EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION"},{"name":"Enclave","value":"ENCLAVE"},{"name":"EncryptingFileSystem","value":"ENCRYPTING_FILE_SYSTEM"},{"name":"EndorsementKeyCertificate","value":"ENDORSEMENT_KEY_CERTIFICATE"},{"name":"FileRecovery","value":"FILE_RECOVERY"},{"name":"HalExtension","value":"HAL_EXTENSION"},{"name":"IpSecurityEndSystem","value":"IP_SECURITY_END_SYSTEM"},{"name":"IpSecurityIkeIntermediate","value":"IP_SECURITY_IKE_INTERMEDIATE"},{"name":"IpSecurityTunnelTermination","value":"IP_SECURITY_TUNNEL_TERMINATION"},{"name":"IpSecurityUser","value":"IP_SECURITY_USER"},{"name":"IsolatedUserMode","value":"ISOLATED_USER_MODE"},{"name":"KdcAuthentication","value":"KDC_AUTHENTICATION"},{"name":"KernelModeCodeSigning","value":"KERNEL_MODE_CODE_SIGNING"},{"name":"KeyPackLicenses","value":"KEY_PACK_LICENSES"},{"name":"KeyRecovery","value":"KEY_RECOVERY"},{"name":"KeyRecoveryAgent","value":"KEY_RECOVERY_AGENT"},{"name":"LicenseServerVerification","value":"LICENSE_SERVER_VERIFICATION"},{"name":"LifetimeSigning","value":"LIFETIME_SIGNING"},{"name":"MicrosoftPublisher","value":"MICROSOFT_PUBLISHER"},{"name":"MicrosoftTimeStamping","value":"MICROSOFT_TIME_STAMPING"},{"name":"MicrosoftTrustListSigning","value":"MICROSOFT_TRUST_LIST_SIGNING"},{"name":"OcspSigning","value":"OCSP_SIGNING"},{"name":"OemWindowsSystemComponentVerification","value":"OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION"},{"name":"PlatformCertificate","value":"PLATFORM_CERTIFICATE"},{"name":"PreviewBuildSigning","value":"PREVIEW_BUILD_SIGNING"},{"name":"PrivateKeyArchival","value":"PRIVATE_KEY_ARCHIVAL"},{"name":"ProtectedProcessLightVerification","value":"PROTECTED_PROCESS_LIGHT_VERIFICATION"},{"name":"ProtectedProcessVerification","value":"PROTECTED_PROCESS_VERIFICATION"},{"name":"QualifiedSubordination","value":"QUALIFIED_SUBORDINATION"},{"name":"RevokedListSigner","value":"REVOKED_LIST_SIGNER"},{"name":"RootProgramAutoUpdateCaRevocation","value":"ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION"},{"name":"RootProgramAutoUpdateEndRevocation","value":"ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION"},{"name":"RootProgramNoOscpFailoverToCrl","value":"ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL"},{"name":"RootListSigner","value":"ROOT_LIST_SIGNER"},{"name":"SecureEmail","value":"SECURE_EMAIL"},{"name":"ServerAuthentication","value":"SERVER_AUTHENTICATION"},{"name":"SmartCardLogin","value":"SMART_CARD_LOGIN"},{"name":"SpcEncryptedDigestRetryCount","value":"SPC_ENCRYPTED_DIGEST_RETRY_COUNT"},{"name":"SpcRelaxedPeMarkerCheck","value":"SPC_RELAXED_PE_MARKER_CHECK"},{"name":"TimeStamping","value":"TIME_STAMPING"},{"name":"WindowsHardwareDriverAttestedVerification","value":"WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION"},{"name":"WindowsHardwareDriverExtendedVerification","value":"WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION"},{"name":"WindowsHardwareDriverVerification","value":"WINDOWS_HARDWARE_DRIVER_VERIFICATION"},{"name":"WindowsHelloRecoveryKeyEncryption","value":"WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION"},{"name":"WindowsKitsComponent","value":"WINDOWS_KITS_COMPONENT"},{"name":"WindowsRtVerification","value":"WINDOWS_RT_VERIFICATION"},{"name":"WindowsSoftwareExtensionVerification","value":"WINDOWS_SOFTWARE_EXTENSION_VERIFICATION"},{"name":"WindowsStore","value":"WINDOWS_STORE"},{"name":"WindowsSystemComponentVerification","value":"WINDOWS_SYSTEM_COMPONENT_VERIFICATION"},{"name":"WindowsTcbComponent","value":"WINDOWS_TCB_COMPONENT"},{"name":"WindowsThirdPartyApplicationComponent","value":"WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT"},{"name":"WindowsUpdate","value":"WINDOWS_UPDATE"}]},"aws-native:pcaconnectorad:TemplateCertificateValidity":{"properties":{"renewalPeriod":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateValidityPeriod"},"validityPeriod":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateValidityPeriod"}},"type":"object","required":["renewalPeriod","validityPeriod"]},"aws-native:pcaconnectorad:TemplateClientCompatibilityV2":{"type":"string","enum":[{"name":"WindowsServer2003","value":"WINDOWS_SERVER_2003"},{"name":"WindowsServer2008","value":"WINDOWS_SERVER_2008"},{"name":"WindowsServer2008r2","value":"WINDOWS_SERVER_2008_R2"},{"name":"WindowsServer2012","value":"WINDOWS_SERVER_2012"},{"name":"WindowsServer2012r2","value":"WINDOWS_SERVER_2012_R2"},{"name":"WindowsServer2016","value":"WINDOWS_SERVER_2016"}]},"aws-native:pcaconnectorad:TemplateClientCompatibilityV3":{"type":"string","enum":[{"name":"WindowsServer2008","value":"WINDOWS_SERVER_2008"},{"name":"WindowsServer2008r2","value":"WINDOWS_SERVER_2008_R2"},{"name":"WindowsServer2012","value":"WINDOWS_SERVER_2012"},{"name":"WindowsServer2012r2","value":"WINDOWS_SERVER_2012_R2"},{"name":"WindowsServer2016","value":"WINDOWS_SERVER_2016"}]},"aws-native:pcaconnectorad:TemplateClientCompatibilityV4":{"type":"string","enum":[{"name":"WindowsServer2012","value":"WINDOWS_SERVER_2012"},{"name":"WindowsServer2012r2","value":"WINDOWS_SERVER_2012_R2"},{"name":"WindowsServer2016","value":"WINDOWS_SERVER_2016"}]},"aws-native:pcaconnectorad:TemplateDefinition0Properties":{"properties":{"templateV2":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateV2"}},"type":"object","required":["templateV2"]},"aws-native:pcaconnectorad:TemplateDefinition1Properties":{"properties":{"templateV3":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateV3"}},"type":"object","required":["templateV3"]},"aws-native:pcaconnectorad:TemplateDefinition2Properties":{"properties":{"templateV4":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateV4"}},"type":"object","required":["templateV4"]},"aws-native:pcaconnectorad:TemplateEnrollmentFlagsV2":{"properties":{"enableKeyReuseOnNtTokenKeysetStorageFull":{"type":"boolean"},"includeSymmetricAlgorithms":{"type":"boolean"},"noSecurityExtension":{"type":"boolean"},"removeInvalidCertificateFromPersonalStore":{"type":"boolean"},"userInteractionRequired":{"type":"boolean"}},"type":"object"},"aws-native:pcaconnectorad:TemplateEnrollmentFlagsV3":{"properties":{"enableKeyReuseOnNtTokenKeysetStorageFull":{"type":"boolean"},"includeSymmetricAlgorithms":{"type":"boolean"},"noSecurityExtension":{"type":"boolean"},"removeInvalidCertificateFromPersonalStore":{"type":"boolean"},"userInteractionRequired":{"type":"boolean"}},"type":"object"},"aws-native:pcaconnectorad:TemplateEnrollmentFlagsV4":{"properties":{"enableKeyReuseOnNtTokenKeysetStorageFull":{"type":"boolean"},"includeSymmetricAlgorithms":{"type":"boolean"},"noSecurityExtension":{"type":"boolean"},"removeInvalidCertificateFromPersonalStore":{"type":"boolean"},"userInteractionRequired":{"type":"boolean"}},"type":"object"},"aws-native:pcaconnectorad:TemplateExtensionsV2":{"properties":{"applicationPolicies":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateApplicationPolicies"},"keyUsage":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeyUsage"}},"type":"object","required":["keyUsage"]},"aws-native:pcaconnectorad:TemplateExtensionsV3":{"properties":{"applicationPolicies":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateApplicationPolicies"},"keyUsage":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeyUsage"}},"type":"object","required":["keyUsage"]},"aws-native:pcaconnectorad:TemplateExtensionsV4":{"properties":{"applicationPolicies":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateApplicationPolicies"},"keyUsage":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeyUsage"}},"type":"object","required":["keyUsage"]},"aws-native:pcaconnectorad:TemplateGeneralFlagsV2":{"properties":{"autoEnrollment":{"type":"boolean"},"machineType":{"type":"boolean"}},"type":"object"},"aws-native:pcaconnectorad:TemplateGeneralFlagsV3":{"properties":{"autoEnrollment":{"type":"boolean"},"machineType":{"type":"boolean"}},"type":"object"},"aws-native:pcaconnectorad:TemplateGeneralFlagsV4":{"properties":{"autoEnrollment":{"type":"boolean"},"machineType":{"type":"boolean"}},"type":"object"},"aws-native:pcaconnectorad:TemplateGroupAccessControlEntryAccessRight":{"type":"string","enum":[{"name":"Allow","value":"ALLOW"},{"name":"Deny","value":"DENY"}]},"aws-native:pcaconnectorad:TemplateGroupAccessControlEntryAccessRights":{"properties":{"autoEnroll":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateGroupAccessControlEntryAccessRight","description":"Allow or deny an Active Directory group from autoenrolling certificates issued against a template. The Active Directory group must be allowed to enroll to allow autoenrollment"},"enroll":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateGroupAccessControlEntryAccessRight","description":"Allow or deny an Active Directory group from enrolling certificates issued against a template."}},"type":"object"},"aws-native:pcaconnectorad:TemplateHashAlgorithm":{"type":"string","enum":[{"name":"Sha256","value":"SHA256"},{"name":"Sha384","value":"SHA384"},{"name":"Sha512","value":"SHA512"}]},"aws-native:pcaconnectorad:TemplateKeySpec":{"type":"string","enum":[{"name":"KeyExchange","value":"KEY_EXCHANGE"},{"name":"Signature","value":"SIGNATURE"}]},"aws-native:pcaconnectorad:TemplateKeyUsage":{"properties":{"critical":{"type":"boolean"},"usageFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeyUsageFlags"}},"type":"object","required":["usageFlags"]},"aws-native:pcaconnectorad:TemplateKeyUsageFlags":{"properties":{"dataEncipherment":{"type":"boolean"},"digitalSignature":{"type":"boolean"},"keyAgreement":{"type":"boolean"},"keyEncipherment":{"type":"boolean"},"nonRepudiation":{"type":"boolean"}},"type":"object"},"aws-native:pcaconnectorad:TemplateKeyUsageProperty0Properties":{"properties":{"propertyType":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeyUsagePropertyType"}},"type":"object","required":["propertyType"]},"aws-native:pcaconnectorad:TemplateKeyUsageProperty1Properties":{"properties":{"propertyFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeyUsagePropertyFlags"}},"type":"object","required":["propertyFlags"]},"aws-native:pcaconnectorad:TemplateKeyUsagePropertyFlags":{"properties":{"decrypt":{"type":"boolean"},"keyAgreement":{"type":"boolean"},"sign":{"type":"boolean"}},"type":"object"},"aws-native:pcaconnectorad:TemplateKeyUsagePropertyType":{"type":"string","enum":[{"name":"All","value":"ALL"}]},"aws-native:pcaconnectorad:TemplatePrivateKeyAlgorithm":{"type":"string","enum":[{"name":"Rsa","value":"RSA"},{"name":"EcdhP256","value":"ECDH_P256"},{"name":"EcdhP384","value":"ECDH_P384"},{"name":"EcdhP521","value":"ECDH_P521"}]},"aws-native:pcaconnectorad:TemplatePrivateKeyAttributesV2":{"properties":{"cryptoProviders":{"type":"array","items":{"type":"string"}},"keySpec":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeySpec"},"minimalKeyLength":{"type":"number"}},"type":"object","required":["keySpec","minimalKeyLength"]},"aws-native:pcaconnectorad:TemplatePrivateKeyAttributesV3":{"properties":{"algorithm":{"$ref":"#/types/aws-native:pcaconnectorad:TemplatePrivateKeyAlgorithm"},"cryptoProviders":{"type":"array","items":{"type":"string"}},"keySpec":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeySpec"},"keyUsageProperty":{"oneOf":[{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeyUsageProperty0Properties"},{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeyUsageProperty1Properties"}]},"minimalKeyLength":{"type":"number"}},"type":"object","required":["algorithm","keySpec","keyUsageProperty","minimalKeyLength"]},"aws-native:pcaconnectorad:TemplatePrivateKeyAttributesV4":{"properties":{"algorithm":{"$ref":"#/types/aws-native:pcaconnectorad:TemplatePrivateKeyAlgorithm"},"cryptoProviders":{"type":"array","items":{"type":"string"}},"keySpec":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeySpec"},"keyUsageProperty":{"oneOf":[{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeyUsageProperty0Properties"},{"$ref":"#/types/aws-native:pcaconnectorad:TemplateKeyUsageProperty1Properties"}]},"minimalKeyLength":{"type":"number"}},"type":"object","required":["keySpec","minimalKeyLength"]},"aws-native:pcaconnectorad:TemplatePrivateKeyFlagsV2":{"properties":{"clientVersion":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateClientCompatibilityV2"},"exportableKey":{"type":"boolean"},"strongKeyProtectionRequired":{"type":"boolean"}},"type":"object","required":["clientVersion"]},"aws-native:pcaconnectorad:TemplatePrivateKeyFlagsV3":{"properties":{"clientVersion":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateClientCompatibilityV3"},"exportableKey":{"type":"boolean"},"requireAlternateSignatureAlgorithm":{"type":"boolean"},"strongKeyProtectionRequired":{"type":"boolean"}},"type":"object","required":["clientVersion"]},"aws-native:pcaconnectorad:TemplatePrivateKeyFlagsV4":{"properties":{"clientVersion":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateClientCompatibilityV4"},"exportableKey":{"type":"boolean"},"requireAlternateSignatureAlgorithm":{"type":"boolean"},"requireSameKeyRenewal":{"type":"boolean"},"strongKeyProtectionRequired":{"type":"boolean"},"useLegacyProvider":{"type":"boolean"}},"type":"object","required":["clientVersion"]},"aws-native:pcaconnectorad:TemplateSubjectNameFlagsV2":{"properties":{"requireCommonName":{"type":"boolean"},"requireDirectoryPath":{"type":"boolean"},"requireDnsAsCn":{"type":"boolean"},"requireEmail":{"type":"boolean"},"sanRequireDirectoryGuid":{"type":"boolean"},"sanRequireDns":{"type":"boolean"},"sanRequireDomainDns":{"type":"boolean"},"sanRequireEmail":{"type":"boolean"},"sanRequireSpn":{"type":"boolean"},"sanRequireUpn":{"type":"boolean"}},"type":"object"},"aws-native:pcaconnectorad:TemplateSubjectNameFlagsV3":{"properties":{"requireCommonName":{"type":"boolean"},"requireDirectoryPath":{"type":"boolean"},"requireDnsAsCn":{"type":"boolean"},"requireEmail":{"type":"boolean"},"sanRequireDirectoryGuid":{"type":"boolean"},"sanRequireDns":{"type":"boolean"},"sanRequireDomainDns":{"type":"boolean"},"sanRequireEmail":{"type":"boolean"},"sanRequireSpn":{"type":"boolean"},"sanRequireUpn":{"type":"boolean"}},"type":"object"},"aws-native:pcaconnectorad:TemplateSubjectNameFlagsV4":{"properties":{"requireCommonName":{"type":"boolean"},"requireDirectoryPath":{"type":"boolean"},"requireDnsAsCn":{"type":"boolean"},"requireEmail":{"type":"boolean"},"sanRequireDirectoryGuid":{"type":"boolean"},"sanRequireDns":{"type":"boolean"},"sanRequireDomainDns":{"type":"boolean"},"sanRequireEmail":{"type":"boolean"},"sanRequireSpn":{"type":"boolean"},"sanRequireUpn":{"type":"boolean"}},"type":"object"},"aws-native:pcaconnectorad:TemplateV2":{"properties":{"certificateValidity":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateCertificateValidity"},"enrollmentFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateEnrollmentFlagsV2"},"extensions":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateExtensionsV2"},"generalFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateGeneralFlagsV2"},"privateKeyAttributes":{"$ref":"#/types/aws-native:pcaconnectorad:TemplatePrivateKeyAttributesV2"},"privateKeyFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplatePrivateKeyFlagsV2"},"subjectNameFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateSubjectNameFlagsV2"},"supersededTemplates":{"type":"array","items":{"type":"string"}}},"type":"object","required":["certificateValidity","enrollmentFlags","extensions","generalFlags","privateKeyAttributes","privateKeyFlags","subjectNameFlags"]},"aws-native:pcaconnectorad:TemplateV3":{"properties":{"certificateValidity":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateCertificateValidity"},"enrollmentFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateEnrollmentFlagsV3"},"extensions":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateExtensionsV3"},"generalFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateGeneralFlagsV3"},"hashAlgorithm":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateHashAlgorithm"},"privateKeyAttributes":{"$ref":"#/types/aws-native:pcaconnectorad:TemplatePrivateKeyAttributesV3"},"privateKeyFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplatePrivateKeyFlagsV3"},"subjectNameFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateSubjectNameFlagsV3"},"supersededTemplates":{"type":"array","items":{"type":"string"}}},"type":"object","required":["certificateValidity","enrollmentFlags","extensions","generalFlags","hashAlgorithm","privateKeyAttributes","privateKeyFlags","subjectNameFlags"]},"aws-native:pcaconnectorad:TemplateV4":{"properties":{"certificateValidity":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateCertificateValidity"},"enrollmentFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateEnrollmentFlagsV4"},"extensions":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateExtensionsV4"},"generalFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateGeneralFlagsV4"},"hashAlgorithm":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateHashAlgorithm"},"privateKeyAttributes":{"$ref":"#/types/aws-native:pcaconnectorad:TemplatePrivateKeyAttributesV4"},"privateKeyFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplatePrivateKeyFlagsV4"},"subjectNameFlags":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateSubjectNameFlagsV4"},"supersededTemplates":{"type":"array","items":{"type":"string"}}},"type":"object","required":["certificateValidity","enrollmentFlags","extensions","generalFlags","privateKeyAttributes","privateKeyFlags","subjectNameFlags"]},"aws-native:pcaconnectorad:TemplateValidityPeriod":{"properties":{"period":{"type":"number"},"periodType":{"$ref":"#/types/aws-native:pcaconnectorad:TemplateValidityPeriodType"}},"type":"object","required":["period","periodType"]},"aws-native:pcaconnectorad:TemplateValidityPeriodType":{"type":"string","enum":[{"name":"Hours","value":"HOURS"},{"name":"Days","value":"DAYS"},{"name":"Weeks","value":"WEEKS"},{"name":"Months","value":"MONTHS"},{"name":"Years","value":"YEARS"}]},"aws-native:pcaconnectorscep:ConnectorMobileDeviceManagement":{"type":"object"},"aws-native:pcaconnectorscep:ConnectorOpenIdConfiguration":{"properties":{"audience":{"type":"string","description":"The audience value to copy into your Microsoft Entra app registration's OIDC."},"issuer":{"type":"string","description":"The issuer value to copy into your Microsoft Entra app registration's OIDC."},"subject":{"type":"string","description":"The subject value to copy into your Microsoft Entra app registration's OIDC."}},"type":"object"},"aws-native:pcaconnectorscep:ConnectorType":{"type":"string","enum":[{"name":"GeneralPurpose","value":"GENERAL_PURPOSE"},{"name":"Intune","value":"INTUNE"}]},"aws-native:pcs:ClusterAccounting":{"description":"The accounting configuration includes configurable settings for Slurm accounting.","properties":{"defaultPurgeTimeInDays":{"type":"integer","description":"The default value for all purge settings for `slurmdbd.conf`. For more information, see the [slurmdbd.conf documentation at SchedMD](https://slurm.schedmd.com/slurmdbd.conf.html). The default value is `-1`. A value of `-1` means there is no purge time and records persist as long as the cluster exists."},"mode":{"$ref":"#/types/aws-native:pcs:ClusterAccountingMode","description":"The default value is `NONE`. A value of `STANDARD` means that Slurm accounting is enabled."}},"type":"object","required":["mode"]},"aws-native:pcs:ClusterAccountingMode":{"description":"The default value is `NONE`. A value of `STANDARD` means that Slurm accounting is enabled.","type":"string","enum":[{"name":"Standard","value":"STANDARD"},{"name":"None","value":"NONE"}]},"aws-native:pcs:ClusterAuthKey":{"description":"The shared Slurm key for authentication, also known as the cluster secret.","properties":{"secretArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the the shared Slurm key."},"secretVersion":{"type":"string","description":"The version of the shared Slurm key."}},"type":"object","required":["secretArn","secretVersion"]},"aws-native:pcs:ClusterEndpoint":{"description":"An endpoint available for interaction with the scheduler.","properties":{"ipv6Address":{"type":"string","description":"The endpoint's IPv6 address."},"port":{"type":"string","description":"The endpoint's connection port number."},"privateIpAddress":{"type":"string","description":"The endpoint's private IP address."},"publicIpAddress":{"type":"string","description":"The endpoint's public IP address."},"type":{"$ref":"#/types/aws-native:pcs:ClusterEndpointType","description":"Indicates the type of endpoint running at the specific IP address."}},"type":"object","required":["port","privateIpAddress","type"]},"aws-native:pcs:ClusterEndpointType":{"description":"Indicates the type of endpoint running at the specific IP address.","type":"string","enum":[{"name":"Slurmctld","value":"SLURMCTLD"},{"name":"Slurmdbd","value":"SLURMDBD"},{"name":"Slurmrestd","value":"SLURMRESTD"}]},"aws-native:pcs:ClusterErrorInfo":{"description":"An error that occurred during resource provisioning.","properties":{"code":{"type":"string","description":"The short-form error code."},"message":{"type":"string","description":"The detailed error information."}},"type":"object"},"aws-native:pcs:ClusterJwtAuth":{"description":"JWT authentication configuration for Slurm.","properties":{"jwtKey":{"$ref":"#/types/aws-native:pcs:ClusterJwtKey","description":"The JWT key for Slurm REST API authentication."}},"type":"object"},"aws-native:pcs:ClusterJwtKey":{"description":"JWT key configuration.","properties":{"secretArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the JWT key secret."},"secretVersion":{"type":"string","description":"The version of the JWT key secret."}},"type":"object","required":["secretArn","secretVersion"]},"aws-native:pcs:ClusterNetworkingPropertiesNetworkType":{"description":"The IP of the cluster (IPV4 or IPV6)","type":"string","enum":[{"name":"Ipv4","value":"IPV4"},{"name":"Ipv6","value":"IPV6"}]},"aws-native:pcs:ClusterSchedulerPropertiesType":{"description":"The software AWS PCS uses to manage cluster scaling and job scheduling.","type":"string","enum":[{"name":"Slurm","value":"SLURM"}]},"aws-native:pcs:ClusterSize":{"description":"The size of the cluster.","type":"string","enum":[{"name":"Small","value":"SMALL"},{"name":"Medium","value":"MEDIUM"},{"name":"Large","value":"LARGE"}]},"aws-native:pcs:ClusterSlurmCustomSetting":{"description":"Additional settings that directly map to Slurm settings.","properties":{"parameterName":{"type":"string","description":"AWS PCS supports configuration of the following Slurm parameters for clusters: Prolog, Epilog, and SelectTypeParameters."},"parameterValue":{"type":"string","description":"The value for the configured Slurm setting."}},"type":"object","required":["parameterName","parameterValue"]},"aws-native:pcs:ClusterSlurmRest":{"description":"The SlurmRest configuration includes configurable settings for Slurm Rest.","properties":{"mode":{"$ref":"#/types/aws-native:pcs:ClusterSlurmRestMode","description":"The default value is `NONE`. A value of `STANDARD` means that Slurm Rest is enabled."}},"type":"object","required":["mode"]},"aws-native:pcs:ClusterSlurmRestMode":{"description":"The default value is `NONE`. A value of `STANDARD` means that Slurm Rest is enabled.","type":"string","enum":[{"name":"Standard","value":"STANDARD"},{"name":"None","value":"NONE"}]},"aws-native:pcs:ClusterStatus":{"description":"The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"DeleteFailed","value":"DELETE_FAILED"},{"name":"UpdateFailed","value":"UPDATE_FAILED"}]},"aws-native:pcs:ComputeNodeGroupErrorInfo":{"description":"An error that occurred during resource provisioning.","properties":{"code":{"type":"string","description":"The short-form error code."},"message":{"type":"string","description":"The detailed error information."}},"type":"object"},"aws-native:pcs:ComputeNodeGroupInstanceConfig":{"description":"An EC2 instance configuration AWS PCS uses to launch compute nodes.","properties":{"instanceType":{"type":"string","description":"The EC2 instance type that AWS PCS can provision in the compute node group."}},"type":"object"},"aws-native:pcs:ComputeNodeGroupPurchaseOption":{"description":"Specifies how EC2 instances are purchased on your behalf. AWS PCS supports On-Demand, Spot and Capacity Block instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.","type":"string","enum":[{"name":"Ondemand","value":"ONDEMAND"},{"name":"Spot","value":"SPOT"},{"name":"CapacityBlock","value":"CAPACITY_BLOCK"}]},"aws-native:pcs:ComputeNodeGroupSlurmCustomSetting":{"description":"Additional settings that directly map to Slurm settings.","properties":{"parameterName":{"type":"string","description":"AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory."},"parameterValue":{"type":"string","description":"The value for the configured Slurm setting."}},"type":"object","required":["parameterName","parameterValue"]},"aws-native:pcs:ComputeNodeGroupSpotOptionsPropertiesAllocationStrategy":{"description":"The Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances. AWS PCS supports lowest price, capacity optimized, and price capacity optimized. If you don't provide this option, it defaults to price capacity optimized.","type":"string","enum":[{"name":"LowestPrice","value":"lowest-price"},{"name":"CapacityOptimized","value":"capacity-optimized"},{"name":"PriceCapacityOptimized","value":"price-capacity-optimized"}]},"aws-native:pcs:ComputeNodeGroupStatus":{"description":"The provisioning status of the compute node group. The provisioning status doesn't indicate the overall health of the compute node group.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"DeleteFailed","value":"DELETE_FAILED"},{"name":"UpdateFailed","value":"UPDATE_FAILED"}]},"aws-native:pcs:CustomLaunchTemplateProperties":{"description":"An Amazon EC2 launch template AWS PCS uses to launch compute nodes.","properties":{"templateId":{"type":"string","description":"The ID of the EC2 launch template to use to provision instances."},"version":{"type":"string","description":"The version of the EC2 launch template to use to provision instances."}},"type":"object","required":["version"]},"aws-native:pcs:NetworkingProperties":{"description":"The networking configuration for the cluster's control plane.","properties":{"networkType":{"$ref":"#/types/aws-native:pcs:ClusterNetworkingPropertiesNetworkType","description":"The IP of the cluster (IPV4 or IPV6)"},"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"The list of subnet IDs where AWS PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and AWS PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone. AWS PCS currently supports only 1 subnet in this list."}},"type":"object"},"aws-native:pcs:QueueComputeNodeGroupConfiguration":{"description":"The compute node group configuration for a queue.","properties":{"computeNodeGroupId":{"type":"string","description":"The compute node group ID for the compute node group configuration."}},"type":"object"},"aws-native:pcs:QueueErrorInfo":{"description":"An error that occurred during resource provisioning.","properties":{"code":{"type":"string","description":"The short-form error code."},"message":{"type":"string","description":"The detailed error information."}},"type":"object"},"aws-native:pcs:QueueSlurmCustomSetting":{"description":"Additional settings that directly map to Slurm settings.","properties":{"parameterName":{"type":"string","description":"AWS PCS supports configuration of the Slurm parameters for queues:."},"parameterValue":{"type":"string","description":"The value for the configured Slurm setting."}},"type":"object","required":["parameterName","parameterValue"]},"aws-native:pcs:QueueStatus":{"description":"The provisioning status of the queue. The provisioning status doesn't indicate the overall health of the queue.","type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"DeleteFailed","value":"DELETE_FAILED"},{"name":"UpdateFailed","value":"UPDATE_FAILED"}]},"aws-native:pcs:ScalingConfigurationProperties":{"description":"Specifies the boundaries of the compute node group auto scaling.","properties":{"maxInstanceCount":{"type":"integer","description":"The upper bound of the number of instances allowed in the compute fleet."},"minInstanceCount":{"type":"integer","description":"The lower bound of the number of instances allowed in the compute fleet."}},"type":"object","required":["maxInstanceCount","minInstanceCount"]},"aws-native:pcs:SchedulerProperties":{"description":"The cluster management and job scheduling software associated with the cluster.","properties":{"type":{"$ref":"#/types/aws-native:pcs:ClusterSchedulerPropertiesType","description":"The software AWS PCS uses to manage cluster scaling and job scheduling."},"version":{"type":"string","description":"The version of the specified scheduling software that AWS PCS uses to manage cluster scaling and job scheduling."}},"type":"object","required":["type","version"]},"aws-native:pcs:SlurmConfigurationProperties":{"description":"The Slurm configuration for the queue.","properties":{"slurmCustomSettings":{"type":"array","items":{"$ref":"#/types/aws-native:pcs:QueueSlurmCustomSetting"},"description":"Custom Slurm parameters that directly map to Slurm configuration settings."}},"type":"object"},"aws-native:pcs:SpotOptionsProperties":{"description":"Additional configuration when you specify SPOT as the purchase option.","properties":{"allocationStrategy":{"$ref":"#/types/aws-native:pcs:ComputeNodeGroupSpotOptionsPropertiesAllocationStrategy","description":"The Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances. AWS PCS supports lowest price, capacity optimized, and price capacity optimized. If you don't provide this option, it defaults to price capacity optimized."}},"type":"object"},"aws-native:personalize:DatasetGroupDomain":{"description":"The domain of a Domain dataset group.","type":"string","enum":[{"name":"Ecommerce","value":"ECOMMERCE"},{"name":"VideoOnDemand","value":"VIDEO_ON_DEMAND"}]},"aws-native:personalize:DatasetImportJob":{"description":"Initial DatasetImportJob for the created dataset","properties":{"dataSource":{"$ref":"#/types/aws-native:personalize:DatasetImportJobDataSourceProperties","description":"The Amazon S3 bucket that contains the training data to import."},"datasetArn":{"type":"string","description":"The ARN of the dataset that receives the imported data"},"datasetImportJobArn":{"type":"string","description":"The ARN of the dataset import job"},"jobName":{"type":"string","description":"The name for the dataset import job."},"roleArn":{"type":"string","description":"The ARN of the IAM role that has permissions to read from the Amazon S3 data source."}},"type":"object"},"aws-native:personalize:DatasetImportJobDataSourceProperties":{"description":"The Amazon S3 bucket that contains the training data to import.","properties":{"dataLocation":{"type":"string","description":"The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored."}},"type":"object"},"aws-native:personalize:DatasetType":{"description":"The type of dataset","type":"string","enum":[{"name":"Interactions","value":"Interactions"},{"name":"Items","value":"Items"},{"name":"Users","value":"Users"}]},"aws-native:personalize:SchemaDomain":{"description":"The domain of a Domain dataset group.","type":"string","enum":[{"name":"Ecommerce","value":"ECOMMERCE"},{"name":"VideoOnDemand","value":"VIDEO_ON_DEMAND"}]},"aws-native:personalize:SolutionCategoricalHyperParameterRange":{"description":"Provides the name and values of a Categorical hyperparameter.","properties":{"name":{"type":"string","description":"The name of the hyperparameter."},"values":{"type":"array","items":{"type":"string"},"description":"A list of the categories for the hyperparameter."}},"type":"object"},"aws-native:personalize:SolutionConfig":{"description":"The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.","properties":{"algorithmHyperParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Lists the hyperparameter names and ranges."},"autoMlConfig":{"$ref":"#/types/aws-native:personalize:SolutionConfigAutoMlConfigProperties","description":"The AutoMLConfig object containing a list of recipes to search when AutoML is performed."},"eventValueThreshold":{"type":"string","description":"Only events with a value greater than or equal to this threshold are used for training a model."},"featureTransformationParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Lists the feature transformation parameters."},"hpoConfig":{"$ref":"#/types/aws-native:personalize:SolutionConfigHpoConfigProperties","description":"Describes the properties for hyperparameter optimization (HPO)"}},"type":"object"},"aws-native:personalize:SolutionConfigAutoMlConfigProperties":{"description":"The AutoMLConfig object containing a list of recipes to search when AutoML is performed.","properties":{"metricName":{"type":"string","description":"The metric to optimize."},"recipeList":{"type":"array","items":{"type":"string"},"description":"The list of candidate recipes."}},"type":"object"},"aws-native:personalize:SolutionConfigHpoConfigProperties":{"description":"Describes the properties for hyperparameter optimization (HPO)","properties":{"algorithmHyperParameterRanges":{"$ref":"#/types/aws-native:personalize:SolutionConfigHpoConfigPropertiesAlgorithmHyperParameterRangesProperties","description":"The hyperparameters and their allowable ranges"},"hpoObjective":{"$ref":"#/types/aws-native:personalize:SolutionConfigHpoConfigPropertiesHpoObjectiveProperties","description":"The metric to optimize during HPO."},"hpoResourceConfig":{"$ref":"#/types/aws-native:personalize:SolutionConfigHpoConfigPropertiesHpoResourceConfigProperties","description":"Describes the resource configuration for hyperparameter optimization (HPO)."}},"type":"object"},"aws-native:personalize:SolutionConfigHpoConfigPropertiesAlgorithmHyperParameterRangesProperties":{"description":"The hyperparameters and their allowable ranges","properties":{"categoricalHyperParameterRanges":{"type":"array","items":{"$ref":"#/types/aws-native:personalize:SolutionCategoricalHyperParameterRange"},"description":"The categorical hyperparameters and their ranges."},"continuousHyperParameterRanges":{"type":"array","items":{"$ref":"#/types/aws-native:personalize:SolutionContinuousHyperParameterRange"},"description":"The continuous hyperparameters and their ranges."},"integerHyperParameterRanges":{"type":"array","items":{"$ref":"#/types/aws-native:personalize:SolutionIntegerHyperParameterRange"},"description":"The integer hyperparameters and their ranges."}},"type":"object"},"aws-native:personalize:SolutionConfigHpoConfigPropertiesHpoObjectiveProperties":{"description":"The metric to optimize during HPO.","properties":{"metricName":{"type":"string","description":"The name of the metric"},"metricRegex":{"type":"string","description":"A regular expression for finding the metric in the training job logs."},"type":{"$ref":"#/types/aws-native:personalize:SolutionConfigHpoConfigPropertiesHpoObjectivePropertiesType","description":"The type of the metric. Valid values are Maximize and Minimize."}},"type":"object"},"aws-native:personalize:SolutionConfigHpoConfigPropertiesHpoObjectivePropertiesType":{"description":"The type of the metric. Valid values are Maximize and Minimize.","type":"string","enum":[{"name":"Maximize","value":"Maximize"},{"name":"Minimize","value":"Minimize"}]},"aws-native:personalize:SolutionConfigHpoConfigPropertiesHpoResourceConfigProperties":{"description":"Describes the resource configuration for hyperparameter optimization (HPO).","properties":{"maxNumberOfTrainingJobs":{"type":"string","description":"The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40."},"maxParallelTrainingJobs":{"type":"string","description":"The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10."}},"type":"object"},"aws-native:personalize:SolutionContinuousHyperParameterRange":{"description":"Provides the name and range of a continuous hyperparameter.","properties":{"maxValue":{"type":"number","description":"The maximum allowable value for the hyperparameter."},"minValue":{"type":"number","description":"The minimum allowable value for the hyperparameter."},"name":{"type":"string","description":"The name of the hyperparameter."}},"type":"object"},"aws-native:personalize:SolutionIntegerHyperParameterRange":{"description":"Provides the name and range of an integer-valued hyperparameter.","properties":{"maxValue":{"type":"integer","description":"The maximum allowable value for the hyperparameter."},"minValue":{"type":"integer","description":"The minimum allowable value for the hyperparameter."},"name":{"type":"string","description":"The name of the hyperparameter."}},"type":"object"},"aws-native:pinpoint:InAppTemplateAlignment":{"type":"string","enum":[{"name":"Left","value":"LEFT"},{"name":"Center","value":"CENTER"},{"name":"Right","value":"RIGHT"}]},"aws-native:pinpoint:InAppTemplateBodyConfig":{"properties":{"alignment":{"$ref":"#/types/aws-native:pinpoint:InAppTemplateAlignment","description":"The text alignment of the main body text of the message. Acceptable values: `LEFT` , `CENTER` , `RIGHT` ."},"body":{"type":"string","description":"The main body text of the message."},"textColor":{"type":"string","description":"The color of the body text, expressed as a hex color code (such as #000000 for black)."}},"type":"object"},"aws-native:pinpoint:InAppTemplateButtonAction":{"type":"string","enum":[{"name":"Link","value":"LINK"},{"name":"DeepLink","value":"DEEP_LINK"},{"name":"Close","value":"CLOSE"}]},"aws-native:pinpoint:InAppTemplateButtonConfig":{"properties":{"android":{"$ref":"#/types/aws-native:pinpoint:InAppTemplateOverrideButtonConfiguration","description":"Optional button configuration to use for in-app messages sent to Android devices. This button configuration overrides the default button configuration."},"defaultConfig":{"$ref":"#/types/aws-native:pinpoint:InAppTemplateDefaultButtonConfiguration","description":"Specifies the default behavior of a button that appears in an in-app message. You can optionally add button configurations that specifically apply to iOS, Android, or web browser users."},"ios":{"$ref":"#/types/aws-native:pinpoint:InAppTemplateOverrideButtonConfiguration","description":"Optional button configuration to use for in-app messages sent to iOS devices. This button configuration overrides the default button configuration."},"web":{"$ref":"#/types/aws-native:pinpoint:InAppTemplateOverrideButtonConfiguration","description":"Optional button configuration to use for in-app messages sent to web applications. This button configuration overrides the default button configuration."}},"type":"object"},"aws-native:pinpoint:InAppTemplateDefaultButtonConfiguration":{"properties":{"backgroundColor":{"type":"string","description":"The background color of a button, expressed as a hex color code (such as #000000 for black)."},"borderRadius":{"type":"integer","description":"The border radius of a button."},"buttonAction":{"$ref":"#/types/aws-native:pinpoint:InAppTemplateButtonAction","description":"The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:\n\n- `LINK` – A link to a web destination.\n- `DEEP_LINK` – A link to a specific page in an application.\n- `CLOSE` – Dismisses the message."},"link":{"type":"string","description":"The destination (such as a URL) for a button."},"text":{"type":"string","description":"The text that appears on a button in an in-app message."},"textColor":{"type":"string","description":"The color of the body text in a button, expressed as a hex color code (such as #000000 for black)."}},"type":"object"},"aws-native:pinpoint:InAppTemplateHeaderConfig":{"properties":{"alignment":{"$ref":"#/types/aws-native:pinpoint:InAppTemplateAlignment","description":"The text alignment of the title of the message. Acceptable values: `LEFT` , `CENTER` , `RIGHT` ."},"header":{"type":"string","description":"The title text of the in-app message."},"textColor":{"type":"string","description":"The color of the title text, expressed as a hex color code (such as #000000 for black)."}},"type":"object"},"aws-native:pinpoint:InAppTemplateInAppMessageContent":{"properties":{"backgroundColor":{"type":"string","description":"The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black)."},"bodyConfig":{"$ref":"#/types/aws-native:pinpoint:InAppTemplateBodyConfig","description":"An object that contains configuration information about the header or title text of the in-app message."},"headerConfig":{"$ref":"#/types/aws-native:pinpoint:InAppTemplateHeaderConfig","description":"An object that contains configuration information about the header or title text of the in-app message."},"imageUrl":{"type":"string","description":"The URL of the image that appears on an in-app message banner."},"primaryBtn":{"$ref":"#/types/aws-native:pinpoint:InAppTemplateButtonConfig","description":"An object that contains configuration information about the primary button in an in-app message."},"secondaryBtn":{"$ref":"#/types/aws-native:pinpoint:InAppTemplateButtonConfig","description":"An object that contains configuration information about the secondary button in an in-app message."}},"type":"object"},"aws-native:pinpoint:InAppTemplateLayout":{"description":"A string that determines the appearance of the in-app message. You can specify one of the following:\n\n- `BOTTOM_BANNER` – a message that appears as a banner at the bottom of the page.\n- `TOP_BANNER` – a message that appears as a banner at the top of the page.\n- `OVERLAYS` – a message that covers entire screen.\n- `MOBILE_FEED` – a message that appears in a window in front of the page.\n- `MIDDLE_BANNER` – a message that appears as a banner in the middle of the page.\n- `CAROUSEL` – a scrollable layout of up to five unique messages.","type":"string","enum":[{"name":"BottomBanner","value":"BOTTOM_BANNER"},{"name":"TopBanner","value":"TOP_BANNER"},{"name":"Overlays","value":"OVERLAYS"},{"name":"MobileFeed","value":"MOBILE_FEED"},{"name":"MiddleBanner","value":"MIDDLE_BANNER"},{"name":"Carousel","value":"CAROUSEL"}]},"aws-native:pinpoint:InAppTemplateOverrideButtonConfiguration":{"properties":{"buttonAction":{"$ref":"#/types/aws-native:pinpoint:InAppTemplateButtonAction","description":"The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:\n\n- `LINK` – A link to a web destination.\n- `DEEP_LINK` – A link to a specific page in an application.\n- `CLOSE` – Dismisses the message."},"link":{"type":"string","description":"The destination (such as a URL) for a button."}},"type":"object"},"aws-native:pipes:PipeAssignPublicIp":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:pipes:PipeAwsVpcConfiguration":{"properties":{"assignPublicIp":{"$ref":"#/types/aws-native:pipes:PipeAssignPublicIp","description":"Specifies whether the task's elastic network interface receives a public IP address. You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE` ."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used."},"subnets":{"type":"array","items":{"type":"string"},"description":"Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets."}},"type":"object","required":["subnets"]},"aws-native:pipes:PipeBatchArrayProperties":{"properties":{"size":{"type":"integer","description":"The size of the array, if this is an array batch job."}},"type":"object"},"aws-native:pipes:PipeBatchContainerOverrides":{"properties":{"command":{"type":"array","items":{"type":"string"},"description":"The command to send to the container that overrides the default command from the Docker image or the task definition."},"environment":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeBatchEnvironmentVariable"},"description":"The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.\n\n\u003e Environment variables cannot start with \" `AWS Batch` \". This naming convention is reserved for variables that AWS Batch sets."},"instanceType":{"type":"string","description":"The instance type to use for a multi-node parallel job.\n\n\u003e This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided."},"resourceRequirements":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeBatchResourceRequirement"},"description":"The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include `GPU` , `MEMORY` , and `VCPU` ."}},"type":"object"},"aws-native:pipes:PipeBatchEnvironmentVariable":{"properties":{"name":{"type":"string","description":"The name of the key-value pair. For environment variables, this is the name of the environment variable."},"value":{"type":"string","description":"The value of the key-value pair. For environment variables, this is the value of the environment variable."}},"type":"object"},"aws-native:pipes:PipeBatchJobDependency":{"properties":{"jobId":{"type":"string","description":"The job ID of the AWS Batch job that's associated with this dependency."},"type":{"$ref":"#/types/aws-native:pipes:PipeBatchJobDependencyType","description":"The type of the job dependency."}},"type":"object"},"aws-native:pipes:PipeBatchJobDependencyType":{"type":"string","enum":[{"name":"NToN","value":"N_TO_N"},{"name":"Sequential","value":"SEQUENTIAL"}]},"aws-native:pipes:PipeBatchResourceRequirement":{"properties":{"type":{"$ref":"#/types/aws-native:pipes:PipeBatchResourceRequirementType","description":"The type of resource to assign to a container. The supported resources include `GPU` , `MEMORY` , and `VCPU` ."},"value":{"type":"string","description":"The quantity of the specified resource to reserve for the container. The values vary based on the `type` specified.\n\n- **type=\"GPU\"** - The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.\n\n\u003e GPUs aren't available for jobs that are running on Fargate resources.\n- **type=\"MEMORY\"** - The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to `Memory` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to `Memory` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) .\n\n\u003e If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see [Memory management](https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the *AWS Batch User Guide* . \n\nFor jobs that are running on Fargate resources, then `value` is the hard limit (in MiB), and must match one of the supported values and the `VCPU` values must be one of the values supported for that memory value.\n\n- **value = 512** - `VCPU` = 0.25\n- **value = 1024** - `VCPU` = 0.25 or 0.5\n- **value = 2048** - `VCPU` = 0.25, 0.5, or 1\n- **value = 3072** - `VCPU` = 0.5, or 1\n- **value = 4096** - `VCPU` = 0.5, 1, or 2\n- **value = 5120, 6144, or 7168** - `VCPU` = 1 or 2\n- **value = 8192** - `VCPU` = 1, 2, 4, or 8\n- **value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360** - `VCPU` = 2 or 4\n- **value = 16384** - `VCPU` = 2, 4, or 8\n- **value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720** - `VCPU` = 4\n- **value = 20480, 24576, or 28672** - `VCPU` = 4 or 8\n- **value = 36864, 45056, 53248, or 61440** - `VCPU` = 8\n- **value = 32768, 40960, 49152, or 57344** - `VCPU` = 8 or 16\n- **value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880** - `VCPU` = 16\n- **type=\"VCPU\"** - The number of vCPUs reserved for the container. This parameter maps to `CpuShares` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.23/) and the `--cpu-shares` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/) . Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.\n\nThe default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see [AWS Fargate quotas](https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate) in the *AWS General Reference* .\n\nFor jobs that are running on Fargate resources, then `value` must match one of the supported values and the `MEMORY` values must be one of the values supported for that `VCPU` value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16\n\n- **value = 0.25** - `MEMORY` = 512, 1024, or 2048\n- **value = 0.5** - `MEMORY` = 1024, 2048, 3072, or 4096\n- **value = 1** - `MEMORY` = 2048, 3072, 4096, 5120, 6144, 7168, or 8192\n- **value = 2** - `MEMORY` = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384\n- **value = 4** - `MEMORY` = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720\n- **value = 8** - `MEMORY` = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440\n- **value = 16** - `MEMORY` = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880"}},"type":"object","required":["type","value"]},"aws-native:pipes:PipeBatchResourceRequirementType":{"type":"string","enum":[{"name":"Gpu","value":"GPU"},{"name":"Memory","value":"MEMORY"},{"name":"Vcpu","value":"VCPU"}]},"aws-native:pipes:PipeBatchRetryStrategy":{"properties":{"attempts":{"type":"integer","description":"The number of times to move a job to the `RUNNABLE` status. If the value of `attempts` is greater than one, the job is retried on failure the same number of attempts as the value."}},"type":"object"},"aws-native:pipes:PipeCapacityProviderStrategyItem":{"properties":{"base":{"type":"integer","description":"The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used."},"capacityProvider":{"type":"string","description":"The short name of the capacity provider."},"weight":{"type":"integer","description":"The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied."}},"type":"object","required":["capacityProvider"]},"aws-native:pipes:PipeCloudwatchLogsLogDestination":{"properties":{"logGroupArn":{"type":"string","description":"The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records."}},"type":"object"},"aws-native:pipes:PipeDeadLetterConfig":{"properties":{"arn":{"type":"string","description":"The ARN of the specified target for the dead-letter queue.\n\nFor Amazon Kinesis stream and Amazon DynamoDB stream sources, specify either an Amazon SNS topic or Amazon SQS queue ARN."}},"type":"object"},"aws-native:pipes:PipeDimensionMapping":{"properties":{"dimensionName":{"type":"string","description":"The metadata attributes of the time series. For example, the name and Availability Zone of an Amazon EC2 instance or the name of the manufacturer of a wind turbine are dimensions."},"dimensionValue":{"type":"string","description":"Dynamic path to the dimension value in the source event."},"dimensionValueType":{"$ref":"#/types/aws-native:pipes:PipeDimensionValueType","description":"The data type of the dimension for the time-series data."}},"type":"object","required":["dimensionName","dimensionValue","dimensionValueType"]},"aws-native:pipes:PipeDimensionValueType":{"type":"string","enum":[{"name":"Varchar","value":"VARCHAR"}]},"aws-native:pipes:PipeDynamoDbStreamStartPosition":{"type":"string","enum":[{"name":"TrimHorizon","value":"TRIM_HORIZON"},{"name":"Latest","value":"LATEST"}]},"aws-native:pipes:PipeEcsContainerOverride":{"properties":{"command":{"type":"array","items":{"type":"string"},"description":"The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name."},"cpu":{"type":"integer","description":"The number of `cpu` units reserved for the container, instead of the default value from the task definition. You must also specify a container name."},"environment":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeEcsEnvironmentVariable"},"description":"The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name."},"environmentFiles":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeEcsEnvironmentFile"},"description":"A list of files containing the environment variables to pass to a container, instead of the value from the container definition."},"memory":{"type":"integer","description":"The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name."},"memoryReservation":{"type":"integer","description":"The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name."},"name":{"type":"string","description":"The name of the container that receives the override. This parameter is required if any override is specified."},"resourceRequirements":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeEcsResourceRequirement"},"description":"The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU."}},"type":"object"},"aws-native:pipes:PipeEcsEnvironmentFile":{"properties":{"type":{"$ref":"#/types/aws-native:pipes:PipeEcsEnvironmentFileType","description":"The file type to use. The only supported value is `s3` ."},"value":{"type":"string","description":"The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file."}},"type":"object","required":["type","value"]},"aws-native:pipes:PipeEcsEnvironmentFileType":{"type":"string","enum":[{"name":"S3","value":"s3"}]},"aws-native:pipes:PipeEcsEnvironmentVariable":{"properties":{"name":{"type":"string","description":"The name of the key-value pair. For environment variables, this is the name of the environment variable."},"value":{"type":"string","description":"The value of the key-value pair. For environment variables, this is the value of the environment variable."}},"type":"object"},"aws-native:pipes:PipeEcsEphemeralStorage":{"properties":{"sizeInGiB":{"type":"integer","description":"The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is `21` GiB and the maximum supported value is `200` GiB."}},"type":"object","required":["sizeInGiB"]},"aws-native:pipes:PipeEcsInferenceAcceleratorOverride":{"properties":{"deviceName":{"type":"string","description":"The Elastic Inference accelerator device name to override for the task. This parameter must match a `deviceName` specified in the task definition."},"deviceType":{"type":"string","description":"The Elastic Inference accelerator type to use."}},"type":"object"},"aws-native:pipes:PipeEcsResourceRequirement":{"properties":{"type":{"$ref":"#/types/aws-native:pipes:PipeEcsResourceRequirementType","description":"The type of resource to assign to a container. The supported values are `GPU` or `InferenceAccelerator` ."},"value":{"type":"string","description":"The value for the specified resource type.\n\nIf the `GPU` type is used, the value is the number of physical `GPUs` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.\n\nIf the `InferenceAccelerator` type is used, the `value` matches the `deviceName` for an InferenceAccelerator specified in a task definition."}},"type":"object","required":["type","value"]},"aws-native:pipes:PipeEcsResourceRequirementType":{"type":"string","enum":[{"name":"Gpu","value":"GPU"},{"name":"InferenceAccelerator","value":"InferenceAccelerator"}]},"aws-native:pipes:PipeEcsTaskOverride":{"properties":{"containerOverrides":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeEcsContainerOverride"},"description":"One or more container overrides that are sent to a task."},"cpu":{"type":"string","description":"The cpu override for the task."},"ephemeralStorage":{"$ref":"#/types/aws-native:pipes:PipeEcsEphemeralStorage","description":"The ephemeral storage setting override for the task.\n\n\u003e This parameter is only supported for tasks hosted on Fargate that use the following platform versions:\n\u003e \n\u003e - Linux platform version `1.4.0` or later.\n\u003e - Windows platform version `1.0.0` or later."},"executionRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide* ."},"inferenceAcceleratorOverrides":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeEcsInferenceAcceleratorOverride"},"description":"The Elastic Inference accelerator override for the task."},"memory":{"type":"string","description":"The memory override for the task."},"taskRoleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see [IAM Role for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide* ."}},"type":"object"},"aws-native:pipes:PipeEnrichmentHttpParameters":{"properties":{"headerParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination."},"pathParameterValues":{"type":"array","items":{"type":"string"},"description":"The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\")."},"queryStringParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination."}},"type":"object"},"aws-native:pipes:PipeEnrichmentParameters":{"properties":{"httpParameters":{"$ref":"#/types/aws-native:pipes:PipeEnrichmentHttpParameters","description":"Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.\n\nIf you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence."},"inputTemplate":{"type":"string","description":"Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format](https://docs.aws.amazon.com/http://www.rfc-editor.org/rfc/rfc7159.txt) .\n\nTo remove an input template, specify an empty string."}},"type":"object"},"aws-native:pipes:PipeEpochTimeUnit":{"type":"string","enum":[{"name":"Milliseconds","value":"MILLISECONDS"},{"name":"Seconds","value":"SECONDS"},{"name":"Microseconds","value":"MICROSECONDS"},{"name":"Nanoseconds","value":"NANOSECONDS"}]},"aws-native:pipes:PipeFilter":{"properties":{"pattern":{"type":"string","description":"The event pattern."}},"type":"object"},"aws-native:pipes:PipeFilterCriteria":{"properties":{"filters":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeFilter"},"description":"The event patterns."}},"type":"object"},"aws-native:pipes:PipeFirehoseLogDestination":{"properties":{"deliveryStreamArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records."}},"type":"object"},"aws-native:pipes:PipeIncludeExecutionDataOption":{"type":"string","enum":[{"name":"All","value":"ALL"}]},"aws-native:pipes:PipeKinesisStreamStartPosition":{"type":"string","enum":[{"name":"TrimHorizon","value":"TRIM_HORIZON"},{"name":"Latest","value":"LATEST"},{"name":"AtTimestamp","value":"AT_TIMESTAMP"}]},"aws-native:pipes:PipeLaunchType":{"type":"string","enum":[{"name":"Ec2","value":"EC2"},{"name":"Fargate","value":"FARGATE"},{"name":"External","value":"EXTERNAL"}]},"aws-native:pipes:PipeLogConfiguration":{"properties":{"cloudwatchLogsLogDestination":{"$ref":"#/types/aws-native:pipes:PipeCloudwatchLogsLogDestination","description":"The logging configuration settings for the pipe."},"firehoseLogDestination":{"$ref":"#/types/aws-native:pipes:PipeFirehoseLogDestination","description":"The Amazon Data Firehose logging configuration settings for the pipe."},"includeExecutionData":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeIncludeExecutionDataOption"},"description":"Whether the execution data (specifically, the `payload` , `awsRequest` , and `awsResponse` fields) is included in the log messages for this pipe.\n\nThis applies to all log destinations for the pipe.\n\nFor more information, see [Including execution data in logs](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data) in the *Amazon EventBridge User Guide* .\n\n*Allowed values:* `ALL`"},"level":{"$ref":"#/types/aws-native:pipes:PipeLogLevel","description":"The level of logging detail to include. This applies to all log destinations for the pipe."},"s3LogDestination":{"$ref":"#/types/aws-native:pipes:PipeS3LogDestination","description":"The Amazon S3 logging configuration settings for the pipe."}},"type":"object"},"aws-native:pipes:PipeLogLevel":{"type":"string","enum":[{"name":"Off","value":"OFF"},{"name":"Error","value":"ERROR"},{"name":"Info","value":"INFO"},{"name":"Trace","value":"TRACE"}]},"aws-native:pipes:PipeMeasureValueType":{"type":"string","enum":[{"name":"Double","value":"DOUBLE"},{"name":"Bigint","value":"BIGINT"},{"name":"Varchar","value":"VARCHAR"},{"name":"Boolean","value":"BOOLEAN"},{"name":"Timestamp","value":"TIMESTAMP"}]},"aws-native:pipes:PipeMqBrokerAccessCredentials0Properties":{"properties":{"basicAuth":{"type":"string","description":"Optional SecretManager ARN which stores the database credentials"}},"type":"object","required":["basicAuth"]},"aws-native:pipes:PipeMqBrokerAccessCredentialsProperties":{"properties":{"basicAuth":{"type":"string","description":"Optional SecretManager ARN which stores the database credentials"}},"type":"object","required":["basicAuth"]},"aws-native:pipes:PipeMskAccessCredentials0Properties":{"properties":{"saslScram512Auth":{"type":"string","description":"Optional SecretManager ARN which stores the database credentials"}},"type":"object","required":["saslScram512Auth"]},"aws-native:pipes:PipeMskAccessCredentials1Properties":{"properties":{"clientCertificateTlsAuth":{"type":"string","description":"Optional SecretManager ARN which stores the database credentials"}},"type":"object","required":["clientCertificateTlsAuth"]},"aws-native:pipes:PipeMskStartPosition":{"type":"string","enum":[{"name":"TrimHorizon","value":"TRIM_HORIZON"},{"name":"Latest","value":"LATEST"}]},"aws-native:pipes:PipeMultiMeasureAttributeMapping":{"properties":{"measureValue":{"type":"string","description":"Dynamic path to the measurement attribute in the source event."},"measureValueType":{"$ref":"#/types/aws-native:pipes:PipeMeasureValueType","description":"Data type of the measurement attribute in the source event."},"multiMeasureAttributeName":{"type":"string","description":"Target measure name to be used."}},"type":"object","required":["measureValue","measureValueType","multiMeasureAttributeName"]},"aws-native:pipes:PipeMultiMeasureMapping":{"properties":{"multiMeasureAttributeMappings":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeMultiMeasureAttributeMapping"},"description":"Mappings that represent multiple source event fields mapped to measures in the same Timestream for LiveAnalytics record."},"multiMeasureName":{"type":"string","description":"The name of the multiple measurements per record (multi-measure)."}},"type":"object","required":["multiMeasureAttributeMappings","multiMeasureName"]},"aws-native:pipes:PipeNetworkConfiguration":{"properties":{"awsvpcConfiguration":{"$ref":"#/types/aws-native:pipes:PipeAwsVpcConfiguration","description":"Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the `awsvpc` network mode."}},"type":"object"},"aws-native:pipes:PipeOnPartialBatchItemFailureStreams":{"type":"string","enum":[{"name":"AutomaticBisect","value":"AUTOMATIC_BISECT"}]},"aws-native:pipes:PipePlacementConstraint":{"properties":{"expression":{"type":"string","description":"A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is `distinctInstance` . To learn more, see [Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide."},"type":{"$ref":"#/types/aws-native:pipes:PipePlacementConstraintType","description":"The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates."}},"type":"object"},"aws-native:pipes:PipePlacementConstraintType":{"type":"string","enum":[{"name":"DistinctInstance","value":"distinctInstance"},{"name":"MemberOf","value":"memberOf"}]},"aws-native:pipes:PipePlacementStrategy":{"properties":{"field":{"type":"string","description":"The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used."},"type":{"$ref":"#/types/aws-native:pipes:PipePlacementStrategyType","description":"The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task)."}},"type":"object"},"aws-native:pipes:PipePlacementStrategyType":{"type":"string","enum":[{"name":"Random","value":"random"},{"name":"Spread","value":"spread"},{"name":"Binpack","value":"binpack"}]},"aws-native:pipes:PipePropagateTags":{"type":"string","enum":[{"name":"TaskDefinition","value":"TASK_DEFINITION"}]},"aws-native:pipes:PipeRequestedPipeState":{"type":"string","enum":[{"name":"Running","value":"RUNNING"},{"name":"Stopped","value":"STOPPED"}]},"aws-native:pipes:PipeS3LogDestination":{"properties":{"bucketName":{"type":"string","description":"The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe."},"bucketOwner":{"type":"string","description":"The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe."},"outputFormat":{"$ref":"#/types/aws-native:pipes:PipeS3OutputFormat","description":"The format EventBridge uses for the log records.\n\nEventBridge currently only supports `json` formatting."},"prefix":{"type":"string","description":"The prefix text with which to begin Amazon S3 log object names.\n\nFor more information, see [Organizing objects using prefixes](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html) in the *Amazon Simple Storage Service User Guide* ."}},"type":"object"},"aws-native:pipes:PipeS3OutputFormat":{"type":"string","enum":[{"name":"Json","value":"json"},{"name":"Plain","value":"plain"},{"name":"W3c","value":"w3c"}]},"aws-native:pipes:PipeSageMakerPipelineParameter":{"properties":{"name":{"type":"string","description":"Name of parameter to start execution of a SageMaker AI Model Building Pipeline."},"value":{"type":"string","description":"Value of parameter to start execution of a SageMaker AI Model Building Pipeline."}},"type":"object","required":["name","value"]},"aws-native:pipes:PipeSelfManagedKafkaAccessConfigurationCredentials0Properties":{"properties":{"basicAuth":{"type":"string","description":"Optional SecretManager ARN which stores the database credentials"}},"type":"object","required":["basicAuth"]},"aws-native:pipes:PipeSelfManagedKafkaAccessConfigurationCredentials1Properties":{"properties":{"saslScram512Auth":{"type":"string","description":"Optional SecretManager ARN which stores the database credentials"}},"type":"object","required":["saslScram512Auth"]},"aws-native:pipes:PipeSelfManagedKafkaAccessConfigurationCredentials2Properties":{"properties":{"saslScram256Auth":{"type":"string","description":"Optional SecretManager ARN which stores the database credentials"}},"type":"object","required":["saslScram256Auth"]},"aws-native:pipes:PipeSelfManagedKafkaAccessConfigurationCredentials3Properties":{"properties":{"clientCertificateTlsAuth":{"type":"string","description":"Optional SecretManager ARN which stores the database credentials"}},"type":"object","required":["clientCertificateTlsAuth"]},"aws-native:pipes:PipeSelfManagedKafkaAccessConfigurationVpc":{"properties":{"securityGroup":{"type":"array","items":{"type":"string"},"description":"List of SecurityGroupId."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of SubnetId."}},"type":"object"},"aws-native:pipes:PipeSelfManagedKafkaStartPosition":{"type":"string","enum":[{"name":"TrimHorizon","value":"TRIM_HORIZON"},{"name":"Latest","value":"LATEST"}]},"aws-native:pipes:PipeSingleMeasureMapping":{"properties":{"measureName":{"type":"string","description":"Target measure name for the measurement attribute in the Timestream table."},"measureValue":{"type":"string","description":"Dynamic path of the source field to map to the measure in the record."},"measureValueType":{"$ref":"#/types/aws-native:pipes:PipeMeasureValueType","description":"Data type of the source field."}},"type":"object","required":["measureName","measureValue","measureValueType"]},"aws-native:pipes:PipeSourceActiveMqBrokerParameters":{"properties":{"batchSize":{"type":"integer","description":"The maximum number of records to include in each batch."},"credentials":{"$ref":"#/types/aws-native:pipes:PipeMqBrokerAccessCredentialsProperties","description":"The credentials needed to access the resource."},"maximumBatchingWindowInSeconds":{"type":"integer","description":"The maximum length of a time to wait for events."},"queueName":{"type":"string","description":"The name of the destination queue to consume.","replaceOnChanges":true}},"type":"object","required":["credentials","queueName"]},"aws-native:pipes:PipeSourceDynamoDbStreamParameters":{"properties":{"batchSize":{"type":"integer","description":"The maximum number of records to include in each batch."},"deadLetterConfig":{"$ref":"#/types/aws-native:pipes:PipeDeadLetterConfig","description":"Define the target queue to send dead-letter queue events to."},"maximumBatchingWindowInSeconds":{"type":"integer","description":"The maximum length of a time to wait for events."},"maximumRecordAgeInSeconds":{"type":"integer","description":"Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records."},"maximumRetryAttempts":{"type":"integer","description":"Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source."},"onPartialBatchItemFailure":{"$ref":"#/types/aws-native:pipes:PipeOnPartialBatchItemFailureStreams","description":"Define how to handle item process failures. `AUTOMATIC_BISECT` halves each batch and retry each half until all the records are processed or there is one failed message left in the batch."},"parallelizationFactor":{"type":"integer","description":"The number of batches to process concurrently from each shard. The default value is 1."},"startingPosition":{"$ref":"#/types/aws-native:pipes:PipeDynamoDbStreamStartPosition","description":"(Streams only) The position in a stream from which to start reading.\n\n*Valid values* : `TRIM_HORIZON | LATEST`","replaceOnChanges":true}},"type":"object","required":["startingPosition"]},"aws-native:pipes:PipeSourceKinesisStreamParameters":{"properties":{"batchSize":{"type":"integer","description":"The maximum number of records to include in each batch."},"deadLetterConfig":{"$ref":"#/types/aws-native:pipes:PipeDeadLetterConfig","description":"Define the target queue to send dead-letter queue events to."},"maximumBatchingWindowInSeconds":{"type":"integer","description":"The maximum length of a time to wait for events."},"maximumRecordAgeInSeconds":{"type":"integer","description":"Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records."},"maximumRetryAttempts":{"type":"integer","description":"Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source."},"onPartialBatchItemFailure":{"$ref":"#/types/aws-native:pipes:PipeOnPartialBatchItemFailureStreams","description":"Define how to handle item process failures. `AUTOMATIC_BISECT` halves each batch and retry each half until all the records are processed or there is one failed message left in the batch."},"parallelizationFactor":{"type":"integer","description":"The number of batches to process concurrently from each shard. The default value is 1."},"startingPosition":{"$ref":"#/types/aws-native:pipes:PipeKinesisStreamStartPosition","description":"The position in a stream from which to start reading.","replaceOnChanges":true},"startingPositionTimestamp":{"type":"string","description":"With `StartingPosition` set to `AT_TIMESTAMP` , the time from which to start reading, in Unix time seconds.","replaceOnChanges":true}},"type":"object","required":["startingPosition"]},"aws-native:pipes:PipeSourceManagedStreamingKafkaParameters":{"properties":{"batchSize":{"type":"integer","description":"The maximum number of records to include in each batch."},"consumerGroupId":{"type":"string","description":"The name of the destination queue to consume.","replaceOnChanges":true},"credentials":{"oneOf":[{"$ref":"#/types/aws-native:pipes:PipeMskAccessCredentials0Properties"},{"$ref":"#/types/aws-native:pipes:PipeMskAccessCredentials1Properties"}],"description":"The credentials needed to access the resource."},"maximumBatchingWindowInSeconds":{"type":"integer","description":"The maximum length of a time to wait for events."},"startingPosition":{"$ref":"#/types/aws-native:pipes:PipeMskStartPosition","description":"The position in a stream from which to start reading.","replaceOnChanges":true},"topicName":{"type":"string","description":"The name of the topic that the pipe will read from.","replaceOnChanges":true}},"type":"object","required":["topicName"]},"aws-native:pipes:PipeSourceParameters":{"properties":{"activeMqBrokerParameters":{"$ref":"#/types/aws-native:pipes:PipeSourceActiveMqBrokerParameters","description":"The parameters for using an Active MQ broker as a source."},"dynamoDbStreamParameters":{"$ref":"#/types/aws-native:pipes:PipeSourceDynamoDbStreamParameters","description":"The parameters for using a DynamoDB stream as a source."},"filterCriteria":{"$ref":"#/types/aws-native:pipes:PipeFilterCriteria","description":"The collection of event patterns used to filter events.\n\nTo remove a filter, specify a `FilterCriteria` object with an empty array of `Filter` objects.\n\nFor more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide* ."},"kinesisStreamParameters":{"$ref":"#/types/aws-native:pipes:PipeSourceKinesisStreamParameters","description":"The parameters for using a Kinesis stream as a source."},"managedStreamingKafkaParameters":{"$ref":"#/types/aws-native:pipes:PipeSourceManagedStreamingKafkaParameters","description":"The parameters for using an MSK stream as a source."},"rabbitMqBrokerParameters":{"$ref":"#/types/aws-native:pipes:PipeSourceRabbitMqBrokerParameters","description":"The parameters for using a Rabbit MQ broker as a source."},"selfManagedKafkaParameters":{"$ref":"#/types/aws-native:pipes:PipeSourceSelfManagedKafkaParameters","description":"The parameters for using a self-managed Apache Kafka stream as a source.\n\nA *self managed* cluster refers to any Apache Kafka cluster not hosted by AWS . This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as [Confluent Cloud](https://docs.aws.amazon.com/https://www.confluent.io/) , [CloudKarafka](https://docs.aws.amazon.com/https://www.cloudkarafka.com/) , or [Redpanda](https://docs.aws.amazon.com/https://redpanda.com/) . For more information, see [Apache Kafka streams as a source](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-kafka.html) in the *Amazon EventBridge User Guide* ."},"sqsQueueParameters":{"$ref":"#/types/aws-native:pipes:PipeSourceSqsQueueParameters","description":"The parameters for using a Amazon SQS stream as a source."}},"type":"object"},"aws-native:pipes:PipeSourceRabbitMqBrokerParameters":{"properties":{"batchSize":{"type":"integer","description":"The maximum number of records to include in each batch."},"credentials":{"$ref":"#/types/aws-native:pipes:PipeMqBrokerAccessCredentialsProperties","description":"The credentials needed to access the resource."},"maximumBatchingWindowInSeconds":{"type":"integer","description":"The maximum length of a time to wait for events."},"queueName":{"type":"string","description":"The name of the destination queue to consume.","replaceOnChanges":true},"virtualHost":{"type":"string","description":"The name of the virtual host associated with the source broker.","replaceOnChanges":true}},"type":"object","required":["credentials","queueName"]},"aws-native:pipes:PipeSourceSelfManagedKafkaParameters":{"properties":{"additionalBootstrapServers":{"type":"array","items":{"type":"string"},"description":"An array of server URLs.","replaceOnChanges":true},"batchSize":{"type":"integer","description":"The maximum number of records to include in each batch."},"consumerGroupId":{"type":"string","description":"The name of the destination queue to consume.","replaceOnChanges":true},"credentials":{"oneOf":[{"$ref":"#/types/aws-native:pipes:PipeSelfManagedKafkaAccessConfigurationCredentials0Properties"},{"$ref":"#/types/aws-native:pipes:PipeSelfManagedKafkaAccessConfigurationCredentials1Properties"},{"$ref":"#/types/aws-native:pipes:PipeSelfManagedKafkaAccessConfigurationCredentials2Properties"},{"$ref":"#/types/aws-native:pipes:PipeSelfManagedKafkaAccessConfigurationCredentials3Properties"}],"description":"The credentials needed to access the resource."},"maximumBatchingWindowInSeconds":{"type":"integer","description":"The maximum length of a time to wait for events."},"serverRootCaCertificate":{"type":"string","description":"Optional SecretManager ARN which stores the database credentials"},"startingPosition":{"$ref":"#/types/aws-native:pipes:PipeSelfManagedKafkaStartPosition","description":"The position in a stream from which to start reading.","replaceOnChanges":true},"topicName":{"type":"string","description":"The name of the topic that the pipe will read from.","replaceOnChanges":true},"vpc":{"$ref":"#/types/aws-native:pipes:PipeSelfManagedKafkaAccessConfigurationVpc","description":"This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used."}},"type":"object","required":["topicName"]},"aws-native:pipes:PipeSourceSqsQueueParameters":{"properties":{"batchSize":{"type":"integer","description":"The maximum number of records to include in each batch."},"maximumBatchingWindowInSeconds":{"type":"integer","description":"The maximum length of a time to wait for events."}},"type":"object"},"aws-native:pipes:PipeState":{"type":"string","enum":[{"name":"Running","value":"RUNNING"},{"name":"Stopped","value":"STOPPED"},{"name":"Creating","value":"CREATING"},{"name":"Updating","value":"UPDATING"},{"name":"Deleting","value":"DELETING"},{"name":"Starting","value":"STARTING"},{"name":"Stopping","value":"STOPPING"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"StartFailed","value":"START_FAILED"},{"name":"StopFailed","value":"STOP_FAILED"},{"name":"DeleteFailed","value":"DELETE_FAILED"},{"name":"CreateRollbackFailed","value":"CREATE_ROLLBACK_FAILED"},{"name":"DeleteRollbackFailed","value":"DELETE_ROLLBACK_FAILED"},{"name":"UpdateRollbackFailed","value":"UPDATE_ROLLBACK_FAILED"}]},"aws-native:pipes:PipeTag":{"properties":{"key":{"type":"string","description":"The key of the key-value pair."},"value":{"type":"string","description":"The value of the key-value pair."}},"type":"object","required":["key","value"]},"aws-native:pipes:PipeTargetBatchJobParameters":{"properties":{"arrayProperties":{"$ref":"#/types/aws-native:pipes:PipeBatchArrayProperties","description":"The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job."},"containerOverrides":{"$ref":"#/types/aws-native:pipes:PipeBatchContainerOverrides","description":"The overrides that are sent to a container."},"dependsOn":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeBatchJobDependency"},"description":"A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a `SEQUENTIAL` type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an `N_TO_N` type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin."},"jobDefinition":{"type":"string","description":"The job definition used by this job. This value can be one of `name` , `name:revision` , or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used."},"jobName":{"type":"string","description":"The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_)."},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition."},"retryStrategy":{"$ref":"#/types/aws-native:pipes:PipeBatchRetryStrategy","description":"The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition."}},"type":"object","required":["jobDefinition","jobName"]},"aws-native:pipes:PipeTargetCloudWatchLogsParameters":{"properties":{"logStreamName":{"type":"string","description":"The name of the log stream."},"timestamp":{"type":"string","description":"A [dynamic path parameter](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) to a field in the payload containing the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.\n\nThe value cannot be a static timestamp as the provided timestamp would be applied to all events delivered by the Pipe, regardless of when they are actually delivered.\n\nIf no dynamic path parameter is provided, the default value is the time the invocation is processed by the Pipe."}},"type":"object"},"aws-native:pipes:PipeTargetEcsTaskParameters":{"properties":{"capacityProviderStrategy":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeCapacityProviderStrategyItem"},"description":"The capacity provider strategy to use for the task.\n\nIf a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted. If no `capacityProviderStrategy` or launchType is specified, the `defaultCapacityProviderStrategy` for the cluster is used."},"enableEcsManagedTags":{"type":"boolean","description":"Specifies whether to enable Amazon ECS managed tags for the task. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon Elastic Container Service Developer Guide."},"enableExecuteCommand":{"type":"boolean","description":"Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task."},"group":{"type":"string","description":"Specifies an Amazon ECS task group for the task. The maximum length is 255 characters."},"launchType":{"$ref":"#/types/aws-native:pipes:PipeLaunchType","description":"Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The `FARGATE` value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see [AWS Fargate on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) in the *Amazon Elastic Container Service Developer Guide* ."},"networkConfiguration":{"$ref":"#/types/aws-native:pipes:PipeNetworkConfiguration","description":"Use this structure if the Amazon ECS task uses the `awsvpc` network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if `LaunchType` is `FARGATE` because the `awsvpc` mode is required for Fargate tasks.\n\nIf you specify `NetworkConfiguration` when the target ECS task does not use the `awsvpc` network mode, the task fails."},"overrides":{"$ref":"#/types/aws-native:pipes:PipeEcsTaskOverride","description":"The overrides that are associated with a task."},"placementConstraints":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipePlacementConstraint"},"description":"An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime)."},"placementStrategy":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipePlacementStrategy"},"description":"The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task."},"platformVersion":{"type":"string","description":"Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as `1.1.0` .\n\nThis structure is used only if `LaunchType` is `FARGATE` . For more information about valid platform versions, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide* ."},"propagateTags":{"$ref":"#/types/aws-native:pipes:PipePropagateTags","description":"Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the `TagResource` API action."},"referenceId":{"type":"string","description":"The reference ID to use for the task."},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeTag"},"description":"The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) in the Amazon ECS API Reference."},"taskCount":{"type":"integer","description":"The number of tasks to create based on `TaskDefinition` . The default is 1."},"taskDefinitionArn":{"type":"string","description":"The ARN of the task definition to use if the event target is an Amazon ECS task."}},"type":"object","required":["taskDefinitionArn"]},"aws-native:pipes:PipeTargetEventBridgeEventBusParameters":{"properties":{"detailType":{"type":"string","description":"A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail."},"endpointId":{"type":"string","description":"The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is `abcde.veo` ."},"resources":{"type":"array","items":{"type":"string"},"description":"AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present."},"source":{"type":"string","description":"The source of the event."},"time":{"type":"string","description":"The time stamp of the event, per [RFC3339](https://docs.aws.amazon.com/https://www.rfc-editor.org/rfc/rfc3339.txt) . If no time stamp is provided, the time stamp of the [PutEvents](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) call is used."}},"type":"object"},"aws-native:pipes:PipeTargetHttpParameters":{"properties":{"headerParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination."},"pathParameterValues":{"type":"array","items":{"type":"string"},"description":"The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\")."},"queryStringParameters":{"type":"object","additionalProperties":{"type":"string"},"description":"The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination."}},"type":"object"},"aws-native:pipes:PipeTargetInvocationType":{"type":"string","enum":[{"name":"RequestResponse","value":"REQUEST_RESPONSE"},{"name":"FireAndForget","value":"FIRE_AND_FORGET"}]},"aws-native:pipes:PipeTargetKinesisStreamParameters":{"properties":{"partitionKey":{"type":"string","description":"Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream."}},"type":"object","required":["partitionKey"]},"aws-native:pipes:PipeTargetLambdaFunctionParameters":{"properties":{"invocationType":{"$ref":"#/types/aws-native:pipes:PipeTargetInvocationType","description":"Specify whether to invoke the function synchronously or asynchronously.\n\n- `REQUEST_RESPONSE` (default) - Invoke synchronously. This corresponds to the `RequestResponse` option in the `InvocationType` parameter for the Lambda [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) API.\n- `FIRE_AND_FORGET` - Invoke asynchronously. This corresponds to the `Event` option in the `InvocationType` parameter for the Lambda [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) API.\n\nFor more information, see [Invocation types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) in the *Amazon EventBridge User Guide* ."}},"type":"object"},"aws-native:pipes:PipeTargetParameters":{"properties":{"batchJobParameters":{"$ref":"#/types/aws-native:pipes:PipeTargetBatchJobParameters","description":"The parameters for using an AWS Batch job as a target."},"cloudWatchLogsParameters":{"$ref":"#/types/aws-native:pipes:PipeTargetCloudWatchLogsParameters","description":"The parameters for using an CloudWatch Logs log stream as a target."},"ecsTaskParameters":{"$ref":"#/types/aws-native:pipes:PipeTargetEcsTaskParameters","description":"The parameters for using an Amazon ECS task as a target."},"eventBridgeEventBusParameters":{"$ref":"#/types/aws-native:pipes:PipeTargetEventBridgeEventBusParameters","description":"The parameters for using an EventBridge event bus as a target."},"httpParameters":{"$ref":"#/types/aws-native:pipes:PipeTargetHttpParameters","description":"These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations."},"inputTemplate":{"type":"string","description":"Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format](https://docs.aws.amazon.com/http://www.rfc-editor.org/rfc/rfc7159.txt) .\n\nTo remove an input template, specify an empty string."},"kinesisStreamParameters":{"$ref":"#/types/aws-native:pipes:PipeTargetKinesisStreamParameters","description":"The parameters for using a Kinesis stream as a target."},"lambdaFunctionParameters":{"$ref":"#/types/aws-native:pipes:PipeTargetLambdaFunctionParameters","description":"The parameters for using a Lambda function as a target."},"redshiftDataParameters":{"$ref":"#/types/aws-native:pipes:PipeTargetRedshiftDataParameters","description":"These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement."},"sageMakerPipelineParameters":{"$ref":"#/types/aws-native:pipes:PipeTargetSageMakerPipelineParameters","description":"The parameters for using a SageMaker AI pipeline as a target."},"sqsQueueParameters":{"$ref":"#/types/aws-native:pipes:PipeTargetSqsQueueParameters","description":"The parameters for using a Amazon SQS stream as a target."},"stepFunctionStateMachineParameters":{"$ref":"#/types/aws-native:pipes:PipeTargetStateMachineParameters","description":"The parameters for using a Step Functions state machine as a target."},"timestreamParameters":{"$ref":"#/types/aws-native:pipes:PipeTargetTimestreamParameters","description":"The parameters for using a Timestream for LiveAnalytics table as a target."}},"type":"object"},"aws-native:pipes:PipeTargetRedshiftDataParameters":{"properties":{"database":{"type":"string","description":"Redshift Database"},"dbUser":{"type":"string","description":"Database user name"},"secretManagerArn":{"type":"string","description":"Optional SecretManager ARN which stores the database credentials"},"sqls":{"type":"array","items":{"type":"string"},"description":"A list of SQLs."},"statementName":{"type":"string","description":"A name for Redshift DataAPI statement which can be used as filter of ListStatement."},"withEvent":{"type":"boolean","description":"Indicates whether to send an event back to EventBridge after the SQL statement runs."}},"type":"object","required":["database","sqls"]},"aws-native:pipes:PipeTargetSageMakerPipelineParameters":{"properties":{"pipelineParameterList":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeSageMakerPipelineParameter"},"description":"List of Parameter names and values for SageMaker AI Model Building Pipeline execution."}},"type":"object"},"aws-native:pipes:PipeTargetSqsQueueParameters":{"properties":{"messageDeduplicationId":{"type":"string","description":"This parameter applies only to FIFO (first-in-first-out) queues.\n\nThe token used for deduplication of sent messages."},"messageGroupId":{"type":"string","description":"The FIFO message group ID to use as the target."}},"type":"object"},"aws-native:pipes:PipeTargetStateMachineParameters":{"properties":{"invocationType":{"$ref":"#/types/aws-native:pipes:PipeTargetInvocationType","description":"Specify whether to invoke the Step Functions state machine synchronously or asynchronously.\n\n- `REQUEST_RESPONSE` (default) - Invoke synchronously. For more information, see [StartSyncExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html) in the *AWS Step Functions API Reference* .\n\n\u003e `REQUEST_RESPONSE` is not supported for `STANDARD` state machine workflows.\n- `FIRE_AND_FORGET` - Invoke asynchronously. For more information, see [StartExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html) in the *AWS Step Functions API Reference* .\n\nFor more information, see [Invocation types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) in the *Amazon EventBridge User Guide* ."}},"type":"object"},"aws-native:pipes:PipeTargetTimestreamParameters":{"properties":{"dimensionMappings":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeDimensionMapping"},"description":"Map source data to dimensions in the target Timestream for LiveAnalytics table.\n\nFor more information, see [Amazon Timestream for LiveAnalytics concepts](https://docs.aws.amazon.com/timestream/latest/developerguide/concepts.html)"},"epochTimeUnit":{"$ref":"#/types/aws-native:pipes:PipeEpochTimeUnit","description":"The granularity of the time units used. Default is `MILLISECONDS` .\n\nRequired if `TimeFieldType` is specified as `EPOCH` ."},"multiMeasureMappings":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeMultiMeasureMapping"},"description":"Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table."},"singleMeasureMappings":{"type":"array","items":{"$ref":"#/types/aws-native:pipes:PipeSingleMeasureMapping"},"description":"Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table."},"timeFieldType":{"$ref":"#/types/aws-native:pipes:PipeTimeFieldType","description":"The type of time value used.\n\nThe default is `EPOCH` ."},"timeValue":{"type":"string","description":"Dynamic path to the source data field that represents the time value for your data."},"timestampFormat":{"type":"string","description":"How to format the timestamps. For example, `yyyy-MM-dd'T'HH:mm:ss'Z'` .\n\nRequired if `TimeFieldType` is specified as `TIMESTAMP_FORMAT` ."},"versionValue":{"type":"string","description":"64 bit version value or source data field that represents the version value for your data.\n\nWrite requests with a higher version number will update the existing measure values of the record and version. In cases where the measure value is the same, the version will still be updated.\n\nDefault value is 1.\n\nTimestream for LiveAnalytics does not support updating partial measure values in a record.\n\nWrite requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, `Version` will still be updated. Default value is `1` .\n\n\u003e `Version` must be `1` or greater, or you will receive a `ValidationException` error."}},"type":"object","required":["dimensionMappings","timeValue","versionValue"]},"aws-native:pipes:PipeTimeFieldType":{"type":"string","enum":[{"name":"Epoch","value":"EPOCH"},{"name":"TimestampFormat","value":"TIMESTAMP_FORMAT"}]},"aws-native:proton:EnvironmentAccountConnectionStatus":{"type":"string","enum":[{"name":"Pending","value":"PENDING"},{"name":"Connected","value":"CONNECTED"},{"name":"Rejected","value":"REJECTED"}]},"aws-native:proton:EnvironmentAccountConnectionTag":{"description":"\u003cp\u003eA description of a resource tag.\u003c/p\u003e","properties":{"key":{"type":"string","description":"\u003cp\u003eThe key of the resource tag.\u003c/p\u003e"},"value":{"type":"string","description":"\u003cp\u003eThe value of the resource tag.\u003c/p\u003e"}},"type":"object","required":["key","value"]},"aws-native:proton:EnvironmentTemplateProvisioning":{"type":"string","enum":[{"name":"CustomerManaged","value":"CUSTOMER_MANAGED"}]},"aws-native:proton:EnvironmentTemplateTag":{"description":"\u003cp\u003eA description of a resource tag.\u003c/p\u003e","properties":{"key":{"type":"string","description":"\u003cp\u003eThe key of the resource tag.\u003c/p\u003e"},"value":{"type":"string","description":"\u003cp\u003eThe value of the resource tag.\u003c/p\u003e"}},"type":"object","required":["key","value"]},"aws-native:proton:ServiceTemplateProvisioning":{"type":"string","enum":[{"name":"CustomerManaged","value":"CUSTOMER_MANAGED"}]},"aws-native:proton:ServiceTemplateTag":{"description":"\u003cp\u003eA description of a resource tag.\u003c/p\u003e","properties":{"key":{"type":"string","description":"\u003cp\u003eThe key of the resource tag.\u003c/p\u003e"},"value":{"type":"string","description":"\u003cp\u003eThe value of the resource tag.\u003c/p\u003e"}},"type":"object","required":["key","value"]},"aws-native:qbusiness:ApplicationAttachmentsConfiguration":{"properties":{"attachmentsControlMode":{"$ref":"#/types/aws-native:qbusiness:ApplicationAttachmentsControlMode","description":"Status information about whether file upload functionality is activated or deactivated for your end user."}},"type":"object","required":["attachmentsControlMode"]},"aws-native:qbusiness:ApplicationAttachmentsControlMode":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:qbusiness:ApplicationAutoSubscriptionConfiguration":{"properties":{"autoSubscribe":{"$ref":"#/types/aws-native:qbusiness:ApplicationAutoSubscriptionStatus","description":"Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management."},"defaultSubscriptionType":{"$ref":"#/types/aws-native:qbusiness:ApplicationSubscriptionType","description":"Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for `autoSubscribe` is set to `ENABLED` you must select a value for this field."}},"type":"object","required":["autoSubscribe"]},"aws-native:qbusiness:ApplicationAutoSubscriptionStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:qbusiness:ApplicationEncryptionConfiguration":{"properties":{"kmsKeyId":{"type":"string","description":"The identifier of the AWS  key. Amazon Q Business doesn't support asymmetric keys."}},"type":"object"},"aws-native:qbusiness:ApplicationIdentityType":{"type":"string","enum":[{"name":"AwsIamIdpSaml","value":"AWS_IAM_IDP_SAML"},{"name":"AwsIamIdpOidc","value":"AWS_IAM_IDP_OIDC"},{"name":"AwsIamIdc","value":"AWS_IAM_IDC"},{"name":"AwsQuicksightIdp","value":"AWS_QUICKSIGHT_IDP"},{"name":"Anonymous","value":"ANONYMOUS"}]},"aws-native:qbusiness:ApplicationPersonalizationConfiguration":{"properties":{"personalizationControlMode":{"$ref":"#/types/aws-native:qbusiness:ApplicationPersonalizationControlMode","description":"An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance."}},"type":"object","required":["personalizationControlMode"]},"aws-native:qbusiness:ApplicationPersonalizationControlMode":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:qbusiness:ApplicationQAppsConfiguration":{"properties":{"qAppsControlMode":{"$ref":"#/types/aws-native:qbusiness:ApplicationQAppsControlMode","description":"Status information about whether end users can create and use Amazon Q Apps in the web experience."}},"type":"object","required":["qAppsControlMode"]},"aws-native:qbusiness:ApplicationQAppsControlMode":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:qbusiness:ApplicationQuickSightConfiguration":{"properties":{"clientNamespace":{"type":"string","description":"The Amazon Quick Suite namespace that is used as the identity provider. For more information about Quick Suite namespaces, see [Namespace operations](https://docs.aws.amazon.com/quicksight/latest/developerguide/namespace-operations.html) ."}},"type":"object","required":["clientNamespace"]},"aws-native:qbusiness:ApplicationStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Failed","value":"FAILED"},{"name":"Updating","value":"UPDATING"}]},"aws-native:qbusiness:ApplicationSubscriptionType":{"type":"string","enum":[{"name":"QLite","value":"Q_LITE"},{"name":"QBusiness","value":"Q_BUSINESS"}]},"aws-native:qbusiness:ApplicationTag":{"properties":{"key":{"type":"string","description":"The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source."},"value":{"type":"string","description":"The value associated with the tag. The value may be an empty string but it can't be null."}},"type":"object","required":["key","value"]},"aws-native:qbusiness:DataAccessorActionConfiguration":{"properties":{"action":{"type":"string","description":"The Amazon Q Business action that is allowed."},"filterConfiguration":{"$ref":"#/types/aws-native:qbusiness:DataAccessorActionFilterConfiguration","description":"The filter configuration for the action, if any."}},"type":"object","required":["action"]},"aws-native:qbusiness:DataAccessorActionFilterConfiguration":{"properties":{"documentAttributeFilter":{"$ref":"#/types/aws-native:qbusiness:DataAccessorAttributeFilter","description":"Enables filtering of responses based on document attributes or metadata fields."}},"type":"object","required":["documentAttributeFilter"]},"aws-native:qbusiness:DataAccessorAttributeFilter":{"properties":{"andAllFilters":{"type":"array","items":{"$ref":"#/types/aws-native:qbusiness:DataAccessorAttributeFilter"},"description":"Performs a logical `AND` operation on all supplied filters."},"containsAll":{"$ref":"#/types/aws-native:qbusiness:DataAccessorDocumentAttribute","description":"Returns `true` when a document contains all the specified document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `stringListValue` ."},"containsAny":{"$ref":"#/types/aws-native:qbusiness:DataAccessorDocumentAttribute","description":"Returns `true` when a document contains any of the specified document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `stringListValue` ."},"equalsTo":{"$ref":"#/types/aws-native:qbusiness:DataAccessorDocumentAttribute","description":"Performs an equals operation on two document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` , `longValue` , `stringListValue` and `stringValue` ."},"greaterThan":{"$ref":"#/types/aws-native:qbusiness:DataAccessorDocumentAttribute","description":"Performs a greater than operation on two document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` and `longValue` ."},"greaterThanOrEquals":{"$ref":"#/types/aws-native:qbusiness:DataAccessorDocumentAttribute","description":"Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` and `longValue` ."},"lessThan":{"$ref":"#/types/aws-native:qbusiness:DataAccessorDocumentAttribute","description":"Performs a less than operation on two document attributes or metadata fields. Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` and `longValue` ."},"lessThanOrEquals":{"$ref":"#/types/aws-native:qbusiness:DataAccessorDocumentAttribute","description":"Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following [document attribute value type](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` and `longValue` ."},"notFilter":{"$ref":"#/types/aws-native:qbusiness:DataAccessorAttributeFilter","description":"Performs a logical `NOT` operation on all supplied filters."},"orAllFilters":{"type":"array","items":{"$ref":"#/types/aws-native:qbusiness:DataAccessorAttributeFilter"},"description":"Performs a logical `OR` operation on all supplied filters."}},"type":"object"},"aws-native:qbusiness:DataAccessorAuthenticationConfiguration0Properties":{"properties":{"idcTrustedTokenIssuerConfiguration":{"$ref":"#/types/aws-native:qbusiness:DataAccessorIdcTrustedTokenIssuerConfiguration"}},"type":"object","required":["idcTrustedTokenIssuerConfiguration"]},"aws-native:qbusiness:DataAccessorAuthenticationConfigurationProperties":{"properties":{"idcTrustedTokenIssuerConfiguration":{"$ref":"#/types/aws-native:qbusiness:DataAccessorIdcTrustedTokenIssuerConfiguration"}},"type":"object","required":["idcTrustedTokenIssuerConfiguration"]},"aws-native:qbusiness:DataAccessorAuthenticationDetail":{"properties":{"authenticationConfiguration":{"$ref":"#/types/aws-native:qbusiness:DataAccessorAuthenticationConfigurationProperties","description":"The specific authentication configuration based on the authentication type."},"authenticationType":{"$ref":"#/types/aws-native:qbusiness:DataAccessorAuthenticationType","description":"The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:\n\n- `AWS_IAM_IDC_TTI` - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.\n- `AWS_IAM_IDC_AUTH_CODE` - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication."},"externalIds":{"type":"array","items":{"type":"string"},"description":"A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems."}},"type":"object","required":["authenticationType"]},"aws-native:qbusiness:DataAccessorAuthenticationType":{"type":"string","enum":[{"name":"AwsIamIdcTti","value":"AWS_IAM_IDC_TTI"},{"name":"AwsIamIdcAuthCode","value":"AWS_IAM_IDC_AUTH_CODE"}]},"aws-native:qbusiness:DataAccessorDocumentAttribute":{"properties":{"name":{"type":"string","description":"The identifier for the attribute."},"value":{"oneOf":[{"$ref":"#/types/aws-native:qbusiness:DataAccessorDocumentAttributeValue0Properties"},{"$ref":"#/types/aws-native:qbusiness:DataAccessorDocumentAttributeValue1Properties"},{"$ref":"#/types/aws-native:qbusiness:DataAccessorDocumentAttributeValue2Properties"},{"$ref":"#/types/aws-native:qbusiness:DataAccessorDocumentAttributeValue3Properties"}],"description":"The value of the attribute."}},"type":"object","required":["name","value"]},"aws-native:qbusiness:DataAccessorDocumentAttributeValue0Properties":{"properties":{"stringValue":{"type":"string"}},"type":"object","required":["stringValue"]},"aws-native:qbusiness:DataAccessorDocumentAttributeValue1Properties":{"properties":{"stringListValue":{"type":"array","items":{"type":"string"}}},"type":"object","required":["stringListValue"]},"aws-native:qbusiness:DataAccessorDocumentAttributeValue2Properties":{"properties":{"longValue":{"type":"number"}},"type":"object","required":["longValue"]},"aws-native:qbusiness:DataAccessorDocumentAttributeValue3Properties":{"properties":{"dateValue":{"type":"string"}},"type":"object","required":["dateValue"]},"aws-native:qbusiness:DataAccessorIdcTrustedTokenIssuerConfiguration":{"properties":{"idcTrustedTokenIssuerArn":{"type":"string"}},"type":"object","required":["idcTrustedTokenIssuerArn"]},"aws-native:qbusiness:DataAccessorTag":{"properties":{"key":{"type":"string","description":"The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source."},"value":{"type":"string","description":"The value associated with the tag. The value may be an empty string but it can't be null."}},"type":"object","required":["key","value"]},"aws-native:qbusiness:DataSourceAttributeValueOperator":{"type":"string","enum":[{"name":"Delete","value":"DELETE"}]},"aws-native:qbusiness:DataSourceAudioExtractionConfiguration":{"properties":{"audioExtractionStatus":{"$ref":"#/types/aws-native:qbusiness:DataSourceAudioExtractionStatus","description":"The status of audio extraction (ENABLED or DISABLED) for processing audio content from files."}},"type":"object","required":["audioExtractionStatus"]},"aws-native:qbusiness:DataSourceAudioExtractionStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:qbusiness:DataSourceDocumentAttributeCondition":{"properties":{"key":{"type":"string","description":"The identifier of the document attribute used for the condition.\n\nFor example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.\n\nAmazon Q Business currently doesn't support `_document_body` as an attribute key used for the condition."},"operator":{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentEnrichmentConditionOperator","description":"The identifier of the document attribute used for the condition.\n\nFor example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.\n\nAmazon Q Business currently does not support `_document_body` as an attribute key used for the condition."},"value":{"oneOf":[{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentAttributeValue0Properties"},{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentAttributeValue1Properties"},{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentAttributeValue2Properties"},{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentAttributeValue3Properties"}],"description":"The value of a document attribute. You can only provide one value for a document attribute."}},"type":"object","required":["key","operator"]},"aws-native:qbusiness:DataSourceDocumentAttributeTarget":{"properties":{"attributeValueOperator":{"$ref":"#/types/aws-native:qbusiness:DataSourceAttributeValueOperator","description":"`TRUE` to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to `TRUE` ."},"key":{"type":"string","description":"The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents."},"value":{"oneOf":[{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentAttributeValue0Properties"},{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentAttributeValue1Properties"},{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentAttributeValue2Properties"},{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentAttributeValue3Properties"}],"description":"The value of a document attribute. You can only provide one value for a document attribute."}},"type":"object","required":["key"]},"aws-native:qbusiness:DataSourceDocumentAttributeValue0Properties":{"properties":{"stringValue":{"type":"string"}},"type":"object","required":["stringValue"]},"aws-native:qbusiness:DataSourceDocumentAttributeValue1Properties":{"properties":{"stringListValue":{"type":"array","items":{"type":"string"}}},"type":"object","required":["stringListValue"]},"aws-native:qbusiness:DataSourceDocumentAttributeValue2Properties":{"properties":{"longValue":{"type":"number"}},"type":"object","required":["longValue"]},"aws-native:qbusiness:DataSourceDocumentAttributeValue3Properties":{"properties":{"dateValue":{"type":"string"}},"type":"object","required":["dateValue"]},"aws-native:qbusiness:DataSourceDocumentContentOperator":{"type":"string","enum":[{"name":"Delete","value":"DELETE"}]},"aws-native:qbusiness:DataSourceDocumentEnrichmentConditionOperator":{"type":"string","enum":[{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"GreaterThanOrEquals","value":"GREATER_THAN_OR_EQUALS"},{"name":"LessThan","value":"LESS_THAN"},{"name":"LessThanOrEquals","value":"LESS_THAN_OR_EQUALS"},{"name":"Equals","value":"EQUALS"},{"name":"NotEquals","value":"NOT_EQUALS"},{"name":"Contains","value":"CONTAINS"},{"name":"NotContains","value":"NOT_CONTAINS"},{"name":"Exists","value":"EXISTS"},{"name":"NotExists","value":"NOT_EXISTS"},{"name":"BeginsWith","value":"BEGINS_WITH"}]},"aws-native:qbusiness:DataSourceDocumentEnrichmentConfiguration":{"properties":{"inlineConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:qbusiness:DataSourceInlineDocumentEnrichmentConfiguration"},"description":"Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business."},"postExtractionHookConfiguration":{"$ref":"#/types/aws-native:qbusiness:DataSourceHookConfiguration","description":"Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see [Using Lambda functions](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html) ."},"preExtractionHookConfiguration":{"$ref":"#/types/aws-native:qbusiness:DataSourceHookConfiguration","description":"Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see [Using Lambda functions](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html) ."}},"type":"object"},"aws-native:qbusiness:DataSourceHookConfiguration":{"properties":{"invocationCondition":{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentAttributeCondition","description":"The condition used for when a Lambda function should be invoked.\n\nFor example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time."},"lambdaArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see [Using Lambda functions for Amazon Q Business document enrichment](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cde-lambda-operations.html) ."},"roleArn":{"type":"string","description":"The Amazon Resource Name (ARN) of a role with permission to run `PreExtractionHookConfiguration` and `PostExtractionHookConfiguration` for altering document metadata and content during the document ingestion process."},"s3BucketName":{"type":"string","description":"Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see [Data contracts for Lambda functions](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts) ."}},"type":"object"},"aws-native:qbusiness:DataSourceImageExtractionConfiguration":{"properties":{"imageExtractionStatus":{"$ref":"#/types/aws-native:qbusiness:DataSourceImageExtractionStatus","description":"Specify whether to extract semantic meaning from images and visuals from documents."}},"type":"object","required":["imageExtractionStatus"]},"aws-native:qbusiness:DataSourceImageExtractionStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:qbusiness:DataSourceInlineDocumentEnrichmentConfiguration":{"properties":{"condition":{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentAttributeCondition","description":"Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business ."},"documentContentOperator":{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentContentOperator","description":"`TRUE` to delete content if the condition used for the target attribute is met."},"target":{"$ref":"#/types/aws-native:qbusiness:DataSourceDocumentAttributeTarget","description":"Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value."}},"type":"object"},"aws-native:qbusiness:DataSourceMediaExtractionConfiguration":{"properties":{"audioExtractionConfiguration":{"$ref":"#/types/aws-native:qbusiness:DataSourceAudioExtractionConfiguration","description":"Configuration settings for extracting and processing audio content from media files."},"imageExtractionConfiguration":{"$ref":"#/types/aws-native:qbusiness:DataSourceImageExtractionConfiguration","description":"The configuration for extracting semantic meaning from images in documents. For more information, see [Extracting semantic meaning from images and visuals](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html) ."},"videoExtractionConfiguration":{"$ref":"#/types/aws-native:qbusiness:DataSourceVideoExtractionConfiguration","description":"Configuration settings for extracting and processing video content from media files."}},"type":"object"},"aws-native:qbusiness:DataSourceStatus":{"type":"string","enum":[{"name":"PendingCreation","value":"PENDING_CREATION"},{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Failed","value":"FAILED"},{"name":"Updating","value":"UPDATING"}]},"aws-native:qbusiness:DataSourceTag":{"properties":{"key":{"type":"string","description":"The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source."},"value":{"type":"string","description":"The value associated with the tag. The value may be an empty string but it can't be null."}},"type":"object","required":["key","value"]},"aws-native:qbusiness:DataSourceVideoExtractionConfiguration":{"properties":{"videoExtractionStatus":{"$ref":"#/types/aws-native:qbusiness:DataSourceVideoExtractionStatus","description":"The status of video extraction (ENABLED or DISABLED) for processing video content from files."}},"type":"object","required":["videoExtractionStatus"]},"aws-native:qbusiness:DataSourceVideoExtractionStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:qbusiness:DataSourceVpcConfiguration":{"properties":{"securityGroupIds":{"type":"array","items":{"type":"string"},"description":"A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source."},"subnetIds":{"type":"array","items":{"type":"string"},"description":"A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device."}},"type":"object","required":["securityGroupIds","subnetIds"]},"aws-native:qbusiness:IndexAttributeType":{"type":"string","enum":[{"name":"String","value":"STRING"},{"name":"StringList","value":"STRING_LIST"},{"name":"Number","value":"NUMBER"},{"name":"Date","value":"DATE"}]},"aws-native:qbusiness:IndexCapacityConfiguration":{"properties":{"units":{"type":"number","description":"The number of storage units configured for an Amazon Q Business index."}},"type":"object"},"aws-native:qbusiness:IndexDocumentAttributeConfiguration":{"properties":{"name":{"type":"string","description":"The name of the document attribute."},"search":{"$ref":"#/types/aws-native:qbusiness:QBusinessIndexStatus","description":"Information about whether the document attribute can be used by an end user to search for information on their web experience."},"type":{"$ref":"#/types/aws-native:qbusiness:IndexAttributeType","description":"The type of document attribute."}},"type":"object"},"aws-native:qbusiness:IndexStatistics":{"properties":{"textDocumentStatistics":{"$ref":"#/types/aws-native:qbusiness:IndexTextDocumentStatistics","description":"The number of documents indexed."}},"type":"object"},"aws-native:qbusiness:IndexStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Failed","value":"FAILED"},{"name":"Updating","value":"UPDATING"}]},"aws-native:qbusiness:IndexTag":{"properties":{"key":{"type":"string","description":"The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source."},"value":{"type":"string","description":"The value associated with the tag. The value may be an empty string but it can't be null."}},"type":"object","required":["key","value"]},"aws-native:qbusiness:IndexTextDocumentStatistics":{"properties":{"indexedTextBytes":{"type":"number","description":"The total size, in bytes, of the indexed documents."},"indexedTextDocumentCount":{"type":"number","description":"The number of text documents indexed."}},"type":"object"},"aws-native:qbusiness:IndexType":{"type":"string","enum":[{"name":"Enterprise","value":"ENTERPRISE"},{"name":"Starter","value":"STARTER"}]},"aws-native:qbusiness:PermissionCondition":{"properties":{"conditionKey":{"type":"string"},"conditionOperator":{"$ref":"#/types/aws-native:qbusiness:PermissionConditionConditionOperator"},"conditionValues":{"type":"array","items":{"type":"string"}}},"type":"object","required":["conditionKey","conditionOperator","conditionValues"]},"aws-native:qbusiness:PermissionConditionConditionOperator":{"type":"string","enum":[{"name":"StringEquals","value":"StringEquals"}]},"aws-native:qbusiness:PluginApiSchema0Properties":{"properties":{"payload":{"type":"string"}},"type":"object","required":["payload"]},"aws-native:qbusiness:PluginApiSchema1Properties":{"properties":{"s3":{"$ref":"#/types/aws-native:qbusiness:PluginS3"}},"type":"object","required":["s3"]},"aws-native:qbusiness:PluginApiSchemaType":{"type":"string","enum":[{"name":"OpenApiV3","value":"OPEN_API_V3"}]},"aws-native:qbusiness:PluginAuthConfiguration0Properties":{"properties":{"basicAuthConfiguration":{"$ref":"#/types/aws-native:qbusiness:PluginBasicAuthConfiguration"}},"type":"object","required":["basicAuthConfiguration"]},"aws-native:qbusiness:PluginAuthConfiguration1Properties":{"properties":{"oAuth2ClientCredentialConfiguration":{"$ref":"#/types/aws-native:qbusiness:PluginOAuth2ClientCredentialConfiguration"}},"type":"object","required":["oAuth2ClientCredentialConfiguration"]},"aws-native:qbusiness:PluginAuthConfiguration2Properties":{"properties":{"noAuthConfiguration":{"$ref":"#/types/aws-native:qbusiness:PluginNoAuthConfiguration"}},"type":"object","required":["noAuthConfiguration"]},"aws-native:qbusiness:PluginBasicAuthConfiguration":{"properties":{"roleArn":{"type":"string"},"secretArn":{"type":"string"}},"type":"object","required":["roleArn","secretArn"]},"aws-native:qbusiness:PluginBuildStatus":{"type":"string","enum":[{"name":"Ready","value":"READY"},{"name":"CreateInProgress","value":"CREATE_IN_PROGRESS"},{"name":"CreateFailed","value":"CREATE_FAILED"},{"name":"UpdateInProgress","value":"UPDATE_IN_PROGRESS"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"DeleteInProgress","value":"DELETE_IN_PROGRESS"},{"name":"DeleteFailed","value":"DELETE_FAILED"}]},"aws-native:qbusiness:PluginCustomPluginConfiguration":{"properties":{"apiSchema":{"oneOf":[{"$ref":"#/types/aws-native:qbusiness:PluginApiSchema0Properties"},{"$ref":"#/types/aws-native:qbusiness:PluginApiSchema1Properties"}],"description":"Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema."},"apiSchemaType":{"$ref":"#/types/aws-native:qbusiness:PluginApiSchemaType","description":"The type of OpenAPI schema to use."},"description":{"type":"string","description":"A description for your custom plugin configuration."}},"type":"object","required":["apiSchema","apiSchemaType","description"]},"aws-native:qbusiness:PluginNoAuthConfiguration":{"type":"object"},"aws-native:qbusiness:PluginOAuth2ClientCredentialConfiguration":{"properties":{"authorizationUrl":{"type":"string"},"roleArn":{"type":"string"},"secretArn":{"type":"string"},"tokenUrl":{"type":"string"}},"type":"object","required":["roleArn","secretArn"]},"aws-native:qbusiness:PluginS3":{"properties":{"bucket":{"type":"string"},"key":{"type":"string"}},"type":"object","required":["bucket","key"]},"aws-native:qbusiness:PluginState":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:qbusiness:PluginTag":{"properties":{"key":{"type":"string","description":"The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source."},"value":{"type":"string","description":"The value associated with the tag. The value may be an empty string but it can't be null."}},"type":"object","required":["key","value"]},"aws-native:qbusiness:PluginType":{"type":"string","enum":[{"name":"ServiceNow","value":"SERVICE_NOW"},{"name":"Salesforce","value":"SALESFORCE"},{"name":"Jira","value":"JIRA"},{"name":"Zendesk","value":"ZENDESK"},{"name":"Custom","value":"CUSTOM"},{"name":"Quicksight","value":"QUICKSIGHT"},{"name":"ServicenowNowPlatform","value":"SERVICENOW_NOW_PLATFORM"},{"name":"JiraCloud","value":"JIRA_CLOUD"},{"name":"SalesforceCrm","value":"SALESFORCE_CRM"},{"name":"ZendeskSuite","value":"ZENDESK_SUITE"},{"name":"AtlassianConfluence","value":"ATLASSIAN_CONFLUENCE"},{"name":"GoogleCalendar","value":"GOOGLE_CALENDAR"},{"name":"MicrosoftTeams","value":"MICROSOFT_TEAMS"},{"name":"MicrosoftExchange","value":"MICROSOFT_EXCHANGE"},{"name":"PagerdutyAdvance","value":"PAGERDUTY_ADVANCE"},{"name":"Smartsheet","value":"SMARTSHEET"},{"name":"Asana","value":"ASANA"}]},"aws-native:qbusiness:QBusinessIndexStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:qbusiness:RetrieverConfiguration0Properties":{"properties":{"nativeIndexConfiguration":{"$ref":"#/types/aws-native:qbusiness:RetrieverNativeIndexConfiguration"}},"type":"object","required":["nativeIndexConfiguration"]},"aws-native:qbusiness:RetrieverConfiguration1Properties":{"properties":{"kendraIndexConfiguration":{"$ref":"#/types/aws-native:qbusiness:RetrieverKendraIndexConfiguration"}},"type":"object","required":["kendraIndexConfiguration"]},"aws-native:qbusiness:RetrieverKendraIndexConfiguration":{"properties":{"indexId":{"type":"string"}},"type":"object","required":["indexId"]},"aws-native:qbusiness:RetrieverNativeIndexConfiguration":{"properties":{"indexId":{"type":"string"}},"type":"object","required":["indexId"]},"aws-native:qbusiness:RetrieverStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Failed","value":"FAILED"}]},"aws-native:qbusiness:RetrieverTag":{"properties":{"key":{"type":"string","description":"The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source."},"value":{"type":"string","description":"The value associated with the tag. The value may be an empty string but it can't be null."}},"type":"object","required":["key","value"]},"aws-native:qbusiness:RetrieverType":{"type":"string","enum":[{"name":"NativeIndex","value":"NATIVE_INDEX"},{"name":"KendraIndex","value":"KENDRA_INDEX"}]},"aws-native:qbusiness:WebExperienceBrowserExtension":{"type":"string","enum":[{"name":"Firefox","value":"FIREFOX"},{"name":"Chrome","value":"CHROME"}]},"aws-native:qbusiness:WebExperienceBrowserExtensionConfiguration":{"properties":{"enabledBrowserExtensions":{"type":"array","items":{"$ref":"#/types/aws-native:qbusiness:WebExperienceBrowserExtension"},"description":"Specify the browser extensions allowed for your Amazon Q web experience.\n\n- `CHROME` — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.).\n- `FIREFOX` — Enables the extension for Mozilla Firefox.\n- `CHROME` and `FIREFOX` — Enable the extension for Chromium-based browsers and Mozilla Firefox."}},"type":"object","required":["enabledBrowserExtensions"]},"aws-native:qbusiness:WebExperienceCustomizationConfiguration":{"properties":{"customCssUrl":{"type":"string","description":"Provides the URL where the custom CSS file is hosted for an Amazon Q web experience."},"faviconUrl":{"type":"string","description":"Provides the URL where the custom favicon file is hosted for an Amazon Q web experience."},"fontUrl":{"type":"string","description":"Provides the URL where the custom font file is hosted for an Amazon Q web experience."},"logoUrl":{"type":"string","description":"Provides the URL where the custom logo file is hosted for an Amazon Q web experience."}},"type":"object"},"aws-native:qbusiness:WebExperienceIdentityProviderConfiguration0Properties":{"properties":{"samlConfiguration":{"$ref":"#/types/aws-native:qbusiness:WebExperienceSamlProviderConfiguration"}},"type":"object","required":["samlConfiguration"]},"aws-native:qbusiness:WebExperienceIdentityProviderConfiguration1Properties":{"properties":{"openIdConnectConfiguration":{"$ref":"#/types/aws-native:qbusiness:WebExperienceOpenIdConnectProviderConfiguration"}},"type":"object","required":["openIdConnectConfiguration"]},"aws-native:qbusiness:WebExperienceOpenIdConnectProviderConfiguration":{"properties":{"secretsArn":{"type":"string"},"secretsRole":{"type":"string"}},"type":"object","required":["secretsArn","secretsRole"]},"aws-native:qbusiness:WebExperienceSamlProviderConfiguration":{"properties":{"authenticationUrl":{"type":"string"}},"type":"object","required":["authenticationUrl"]},"aws-native:qbusiness:WebExperienceSamplePromptsControlMode":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:qbusiness:WebExperienceStatus":{"type":"string","enum":[{"name":"Creating","value":"CREATING"},{"name":"Active","value":"ACTIVE"},{"name":"Deleting","value":"DELETING"},{"name":"Failed","value":"FAILED"},{"name":"PendingAuthConfig","value":"PENDING_AUTH_CONFIG"}]},"aws-native:qbusiness:WebExperienceTag":{"properties":{"key":{"type":"string","description":"The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source."},"value":{"type":"string","description":"The value associated with the tag. The value may be an empty string but it can't be null."}},"type":"object","required":["key","value"]},"aws-native:qldb:StreamKinesisConfiguration":{"properties":{"aggregationEnabled":{"type":"boolean","description":"Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.\n\nDefault: `True`\n\n\u003e Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see [KPL Key Concepts](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) and [Consumer De-aggregation](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html) in the *Amazon Kinesis Data Streams Developer Guide* ."},"streamArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the Kinesis Data Streams resource."}},"type":"object"},"aws-native:qldb:StreamTag":{"description":"A key-value pair to associate with a resource.","properties":{"key":{"type":"string","description":"The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "},"value":{"type":"string","description":"The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. "}},"type":"object","required":["key","value"]},"aws-native:quicksight:ActionConnectorApiKeyConnectionMetadata":{"properties":{"apiKey":{"type":"string"},"baseEndpoint":{"type":"string"},"email":{"type":"string"}},"type":"object","required":["apiKey","baseEndpoint"]},"aws-native:quicksight:ActionConnectorAuthConfig":{"properties":{"authenticationMetadata":{"oneOf":[{"$ref":"#/types/aws-native:quicksight:ActionConnectorAuthenticationMetadata0Properties"},{"$ref":"#/types/aws-native:quicksight:ActionConnectorAuthenticationMetadata1Properties"},{"$ref":"#/types/aws-native:quicksight:ActionConnectorAuthenticationMetadata2Properties"},{"$ref":"#/types/aws-native:quicksight:ActionConnectorAuthenticationMetadata3Properties"},{"$ref":"#/types/aws-native:quicksight:ActionConnectorAuthenticationMetadata4Properties"},{"$ref":"#/types/aws-native:quicksight:ActionConnectorAuthenticationMetadata5Properties"}]},"authenticationType":{"$ref":"#/types/aws-native:quicksight:ActionConnectorConnectionAuthType"}},"type":"object","required":["authenticationMetadata","authenticationType"]},"aws-native:quicksight:ActionConnectorAuthenticationMetadata0Properties":{"properties":{"authorizationCodeGrantMetadata":{"$ref":"#/types/aws-native:quicksight:ActionConnectorAuthorizationCodeGrantMetadata"}},"type":"object","required":["authorizationCodeGrantMetadata"]},"aws-native:quicksight:ActionConnectorAuthenticationMetadata1Properties":{"properties":{"clientCredentialsGrantMetadata":{"$ref":"#/types/aws-native:quicksight:ActionConnectorClientCredentialsGrantMetadata"}},"type":"object","required":["clientCredentialsGrantMetadata"]},"aws-native:quicksight:ActionConnectorAuthenticationMetadata2Properties":{"properties":{"basicAuthConnectionMetadata":{"$ref":"#/types/aws-native:quicksight:ActionConnectorBasicAuthConnectionMetadata"}},"type":"object","required":["basicAuthConnectionMetadata"]},"aws-native:quicksight:ActionConnectorAuthenticationMetadata3Properties":{"properties":{"apiKeyConnectionMetadata":{"$ref":"#/types/aws-native:quicksight:ActionConnectorApiKeyConnectionMetadata"}},"type":"object","required":["apiKeyConnectionMetadata"]},"aws-native:quicksight:ActionConnectorAuthenticationMetadata4Properties":{"properties":{"noneConnectionMetadata":{"$ref":"#/types/aws-native:quicksight:ActionConnectorNoneConnectionMetadata"}},"type":"object","required":["noneConnectionMetadata"]},"aws-native:quicksight:ActionConnectorAuthenticationMetadata5Properties":{"properties":{"iamConnectionMetadata":{"$ref":"#/types/aws-native:quicksight:ActionConnectorIamConnectionMetadata"}},"type":"object","required":["iamConnectionMetadata"]},"aws-native:quicksight:ActionConnectorAuthorizationCodeGrantCredentialsDetails0Properties":{"properties":{"authorizationCodeGrantDetails":{"$ref":"#/types/aws-native:quicksight:ActionConnectorAuthorizationCodeGrantDetails"}},"type":"object","required":["authorizationCodeGrantDetails"]},"aws-native:quicksight:ActionConnectorAuthorizationCodeGrantCredentialsDetailsProperties":{"properties":{"authorizationCodeGrantDetails":{"$ref":"#/types/aws-native:quicksight:ActionConnectorAuthorizationCodeGrantDetails"}},"type":"object","required":["authorizationCodeGrantDetails"]},"aws-native:quicksight:ActionConnectorAuthorizationCodeGrantCredentialsSource":{"type":"string","enum":[{"name":"PlainCredentials","value":"PLAIN_CREDENTIALS"}]},"aws-native:quicksight:ActionConnectorAuthorizationCodeGrantDetails":{"properties":{"authorizationEndpoint":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"tokenEndpoint":{"type":"string"}},"type":"object","required":["authorizationEndpoint","clientId","clientSecret","tokenEndpoint"]},"aws-native:quicksight:ActionConnectorAuthorizationCodeGrantMetadata":{"properties":{"authorizationCodeGrantCredentialsDetails":{"$ref":"#/types/aws-native:quicksight:ActionConnectorAuthorizationCodeGrantCredentialsDetailsProperties"},"authorizationCodeGrantCredentialsSource":{"$ref":"#/types/aws-native:quicksight:ActionConnectorAuthorizationCodeGrantCredentialsSource"},"baseEndpoint":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object","required":["baseEndpoint","redirectUrl"]},"aws-native:quicksight:ActionConnectorBasicAuthConnectionMetadata":{"properties":{"baseEndpoint":{"type":"string"},"password":{"type":"string"},"username":{"type":"string"}},"type":"object","required":["baseEndpoint","password","username"]},"aws-native:quicksight:ActionConnectorClientCredentialsDetails0Properties":{"properties":{"clientCredentialsGrantDetails":{"$ref":"#/types/aws-native:quicksight:ActionConnectorClientCredentialsGrantDetails"}},"type":"object","required":["clientCredentialsGrantDetails"]},"aws-native:quicksight:ActionConnectorClientCredentialsDetailsProperties":{"properties":{"clientCredentialsGrantDetails":{"$ref":"#/types/aws-native:quicksight:ActionConnectorClientCredentialsGrantDetails"}},"type":"object","required":["clientCredentialsGrantDetails"]},"aws-native:quicksight:ActionConnectorClientCredentialsGrantDetails":{"properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"tokenEndpoint":{"type":"string"}},"type":"object","required":["clientId","clientSecret","tokenEndpoint"]},"aws-native:quicksight:ActionConnectorClientCredentialsGrantMetadata":{"properties":{"baseEndpoint":{"type":"string"},"clientCredentialsDetails":{"$ref":"#/types/aws-native:quicksight:ActionConnectorClientCredentialsDetailsProperties"},"clientCredentialsSource":{"$ref":"#/types/aws-native:quicksight:ActionConnectorClientCredentialsSource"}},"type":"object","required":["baseEndpoint"]},"aws-native:quicksight:ActionConnectorClientCredentialsSource":{"type":"string","enum":[{"name":"PlainCredentials","value":"PLAIN_CREDENTIALS"}]},"aws-native:quicksight:ActionConnectorConnectionAuthType":{"type":"string","enum":[{"name":"Basic","value":"BASIC"},{"name":"ApiKey","value":"API_KEY"},{"name":"Oauth2ClientCredentials","value":"OAUTH2_CLIENT_CREDENTIALS"},{"name":"None","value":"NONE"},{"name":"Iam","value":"IAM"},{"name":"Oauth2AuthorizationCode","value":"OAUTH2_AUTHORIZATION_CODE"}]},"aws-native:quicksight:ActionConnectorIamConnectionMetadata":{"properties":{"roleArn":{"type":"string"}},"type":"object","required":["roleArn"]},"aws-native:quicksight:ActionConnectorNoneConnectionMetadata":{"properties":{"baseEndpoint":{"type":"string"}},"type":"object","required":["baseEndpoint"]},"aws-native:quicksight:ActionConnectorResourcePermission":{"description":"\u003cp\u003ePermission for the resource.\u003c/p\u003e","properties":{"actions":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eThe IAM action to grant or revoke permissions on.\u003c/p\u003e"},"principal":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) of the principal. This can be one of the\n            following:\u003c/p\u003e\n         \u003cul\u003e\n            \u003cli\u003e\n               \u003cp\u003eThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)\u003c/p\u003e\n            \u003c/li\u003e\n            \u003cli\u003e\n               \u003cp\u003eThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)\u003c/p\u003e\n            \u003c/li\u003e\n            \u003cli\u003e\n               \u003cp\u003eThe ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n                    ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n                    (This is less common.) \u003c/p\u003e\n            \u003c/li\u003e\n         \u003c/ul\u003e"}},"type":"object","required":["actions","principal"]},"aws-native:quicksight:ActionConnectorResourceStatus":{"type":"string","enum":[{"name":"CreationInProgress","value":"CREATION_IN_PROGRESS"},{"name":"CreationSuccessful","value":"CREATION_SUCCESSFUL"},{"name":"CreationFailed","value":"CREATION_FAILED"},{"name":"UpdateInProgress","value":"UPDATE_IN_PROGRESS"},{"name":"UpdateSuccessful","value":"UPDATE_SUCCESSFUL"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"PendingUpdate","value":"PENDING_UPDATE"},{"name":"Deleted","value":"DELETED"}]},"aws-native:quicksight:ActionConnectorTag":{"description":"\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n            resource.\u003c/p\u003e","properties":{"key":{"type":"string","description":"\u003cp\u003eTag key.\u003c/p\u003e"},"value":{"type":"string","description":"\u003cp\u003eTag value.\u003c/p\u003e"}},"type":"object","required":["key","value"]},"aws-native:quicksight:ActionConnectorType":{"type":"string","enum":[{"name":"GenericHttp","value":"GENERIC_HTTP"},{"name":"ServicenowNowPlatform","value":"SERVICENOW_NOW_PLATFORM"},{"name":"SalesforceCrm","value":"SALESFORCE_CRM"},{"name":"MicrosoftOutlook","value":"MICROSOFT_OUTLOOK"},{"name":"PagerdutyAdvance","value":"PAGERDUTY_ADVANCE"},{"name":"JiraCloud","value":"JIRA_CLOUD"},{"name":"AtlassianConfluence","value":"ATLASSIAN_CONFLUENCE"},{"name":"AmazonS3","value":"AMAZON_S3"},{"name":"AmazonBedrockAgentRuntime","value":"AMAZON_BEDROCK_AGENT_RUNTIME"},{"name":"AmazonBedrockRuntime","value":"AMAZON_BEDROCK_RUNTIME"},{"name":"AmazonBedrockDataAutomationRuntime","value":"AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME"},{"name":"AmazonTextract","value":"AMAZON_TEXTRACT"},{"name":"AmazonComprehend","value":"AMAZON_COMPREHEND"},{"name":"AmazonComprehendMedical","value":"AMAZON_COMPREHEND_MEDICAL"},{"name":"MicrosoftOnedrive","value":"MICROSOFT_ONEDRIVE"},{"name":"MicrosoftSharepoint","value":"MICROSOFT_SHAREPOINT"},{"name":"MicrosoftTeams","value":"MICROSOFT_TEAMS"},{"name":"SapBusinesspartner","value":"SAP_BUSINESSPARTNER"},{"name":"SapProductmasterdata","value":"SAP_PRODUCTMASTERDATA"},{"name":"SapPhysicalinventory","value":"SAP_PHYSICALINVENTORY"},{"name":"SapBillofmaterials","value":"SAP_BILLOFMATERIALS"},{"name":"SapMaterialstock","value":"SAP_MATERIALSTOCK"},{"name":"ZendeskSuite","value":"ZENDESK_SUITE"},{"name":"Smartsheet","value":"SMARTSHEET"},{"name":"Slack","value":"SLACK"},{"name":"Asana","value":"ASANA"},{"name":"BambooHr","value":"BAMBOO_HR"}]},"aws-native:quicksight:AnalysisAggregationFunction":{"properties":{"attributeAggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisAttributeAggregationFunction","description":"Aggregation for attributes."},"categoricalAggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoricalAggregationFunction","description":"Aggregation for categorical values.\n\n- `COUNT` : Aggregate by the total number of values, including duplicates.\n- `DISTINCT_COUNT` : Aggregate by the total number of distinct values."},"dateAggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisDateAggregationFunction","description":"Aggregation for date values.\n\n- `COUNT` : Aggregate by the total number of values, including duplicates.\n- `DISTINCT_COUNT` : Aggregate by the total number of distinct values.\n- `MIN` : Select the smallest date value.\n- `MAX` : Select the largest date value."},"numericalAggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericalAggregationFunction","description":"Aggregation for numerical values."}},"type":"object"},"aws-native:quicksight:AnalysisAggregationSortConfiguration":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisAggregationFunction","description":"The function that aggregates the values in `Column` ."},"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that determines the sort order of aggregated values."},"sortDirection":{"$ref":"#/types/aws-native:quicksight:AnalysisSortDirection","description":"The sort direction of values.\n\n- `ASC` : Sort in ascending order.\n- `DESC` : Sort in descending order."}},"type":"object","required":["column","sortDirection"]},"aws-native:quicksight:AnalysisAllSheetsFilterScopeConfiguration":{"type":"object"},"aws-native:quicksight:AnalysisAnchorDateConfiguration":{"properties":{"anchorOption":{"$ref":"#/types/aws-native:quicksight:AnalysisAnchorOption","description":"The options for the date configuration. Choose one of the options below:\n\n- `NOW`"},"parameterName":{"type":"string","description":"The name of the parameter that is used for the anchor date configuration."}},"type":"object"},"aws-native:quicksight:AnalysisAnchorOption":{"type":"string","enum":[{"name":"Now","value":"NOW"}]},"aws-native:quicksight:AnalysisArcAxisConfiguration":{"properties":{"range":{"$ref":"#/types/aws-native:quicksight:AnalysisArcAxisDisplayRange","description":"The arc axis range of a `GaugeChartVisual` ."},"reserveRange":{"type":"number","description":"The reserved range of the arc axis."}},"type":"object"},"aws-native:quicksight:AnalysisArcAxisDisplayRange":{"properties":{"max":{"type":"number","description":"The maximum value of the arc axis range."},"min":{"type":"number","description":"The minimum value of the arc axis range."}},"type":"object"},"aws-native:quicksight:AnalysisArcConfiguration":{"properties":{"arcAngle":{"type":"number","description":"The option that determines the arc angle of a `GaugeChartVisual` ."},"arcThickness":{"$ref":"#/types/aws-native:quicksight:AnalysisArcThicknessOptions","description":"The options that determine the arc thickness of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:AnalysisArcOptions":{"properties":{"arcThickness":{"$ref":"#/types/aws-native:quicksight:AnalysisArcThickness","description":"The arc thickness of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:AnalysisArcThickness":{"type":"string","enum":[{"name":"Small","value":"SMALL"},{"name":"Medium","value":"MEDIUM"},{"name":"Large","value":"LARGE"},{"name":"Whole","value":"WHOLE"}]},"aws-native:quicksight:AnalysisArcThicknessOptions":{"type":"string","enum":[{"name":"Small","value":"SMALL"},{"name":"Medium","value":"MEDIUM"},{"name":"Large","value":"LARGE"}]},"aws-native:quicksight:AnalysisAssetOptions":{"properties":{"timezone":{"type":"string","description":"Determines the timezone for the analysis."},"weekStart":{"$ref":"#/types/aws-native:quicksight:AnalysisDayOfTheWeek","description":"Determines the week start day for an analysis."}},"type":"object"},"aws-native:quicksight:AnalysisAttributeAggregationFunction":{"properties":{"simpleAttributeAggregation":{"$ref":"#/types/aws-native:quicksight:AnalysisSimpleAttributeAggregationFunction","description":"The built-in aggregation functions for attributes.\n\n- `UNIQUE_VALUE` : Returns the unique value for a field, aggregated by the dimension fields."},"valueForMultipleValues":{"type":"string","description":"Used by the `UNIQUE_VALUE` aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to '*'."}},"type":"object"},"aws-native:quicksight:AnalysisAxisBinding":{"type":"string","enum":[{"name":"PrimaryYaxis","value":"PRIMARY_YAXIS"},{"name":"SecondaryYaxis","value":"SECONDARY_YAXIS"}]},"aws-native:quicksight:AnalysisAxisDataOptions":{"properties":{"dateAxisOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDateAxisOptions","description":"The options for an axis with a date field."},"numericAxisOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericAxisOptions","description":"The options for an axis with a numeric field."}},"type":"object"},"aws-native:quicksight:AnalysisAxisDisplayDataDrivenRange":{"type":"object"},"aws-native:quicksight:AnalysisAxisDisplayMinMaxRange":{"properties":{"maximum":{"type":"number","description":"The maximum setup for an axis display range."},"minimum":{"type":"number","description":"The minimum setup for an axis display range."}},"type":"object"},"aws-native:quicksight:AnalysisAxisDisplayOptions":{"properties":{"axisLineVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines whether or not the axis line is visible."},"axisOffset":{"type":"string","description":"String based length that is composed of value and unit in px"},"dataOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDataOptions","description":"The data options for an axis."},"gridLineVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines whether or not the grid line is visible."},"scrollbarOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisScrollBarOptions","description":"The scroll bar options for an axis."},"tickLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisTickLabelOptions","description":"The tick label options of an axis."}},"type":"object"},"aws-native:quicksight:AnalysisAxisDisplayRange":{"properties":{"dataDriven":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayDataDrivenRange","description":"The data-driven setup of an axis display range."},"minMax":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayMinMaxRange","description":"The minimum and maximum setup of an axis display range."}},"type":"object"},"aws-native:quicksight:AnalysisAxisLabelOptions":{"properties":{"applyTo":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisLabelReferenceOptions","description":"The options that indicate which field the label belongs to."},"customLabel":{"type":"string","description":"The text for the axis label."},"fontConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontConfiguration","description":"The font configuration of the axis label."}},"type":"object"},"aws-native:quicksight:AnalysisAxisLabelReferenceOptions":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the axis label is targeted to."},"fieldId":{"type":"string","description":"The field that the axis label is targeted to."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:AnalysisAxisLinearScale":{"properties":{"stepCount":{"type":"number","description":"The step count setup of a linear axis."},"stepSize":{"type":"number","description":"The step size setup of a linear axis."}},"type":"object"},"aws-native:quicksight:AnalysisAxisLogarithmicScale":{"properties":{"base":{"type":"number","description":"The base setup of a logarithmic axis scale."}},"type":"object"},"aws-native:quicksight:AnalysisAxisScale":{"properties":{"linear":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisLinearScale","description":"The linear axis scale setup."},"logarithmic":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisLogarithmicScale","description":"The logarithmic axis scale setup."}},"type":"object"},"aws-native:quicksight:AnalysisAxisTickLabelOptions":{"properties":{"labelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisLabelOptions","description":"Determines whether or not the axis ticks are visible."},"rotationAngle":{"type":"number","description":"The rotation angle of the axis tick labels."}},"type":"object"},"aws-native:quicksight:AnalysisBarChartAggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The category (y-axis) field well of a bar chart."},"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The color (group/color) field well of a bar chart."},"smallMultiples":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The small multiples field well of a bar chart."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The value field wells of a bar chart. Values are aggregated by category."}},"type":"object"},"aws-native:quicksight:AnalysisBarChartConfiguration":{"properties":{"barsArrangement":{"$ref":"#/types/aws-native:quicksight:AnalysisBarsArrangement","description":"Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual."},"categoryAxis":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The label display options (grid line, range, scale, axis step) for bar chart category."},"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility and sort icon visibility) for a bar chart."},"colorLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart."},"contributionAnalysisDefaults":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisContributionAnalysisDefault"},"description":"The contribution analysis (anomaly configuration) setup of the visual."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOptions","description":"The options that determine if visual data labels are displayed."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisBarChartFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions","description":"The legend display setup of the visual."},"orientation":{"$ref":"#/types/aws-native:quicksight:AnalysisBarChartOrientation","description":"The orientation of the bars in a bar chart visual. There are two valid values in this structure:\n\n- `HORIZONTAL` : Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.\n- `VERTICAL` : Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts."},"referenceLines":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLine"},"description":"The reference line setup of the visual."},"smallMultiplesOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSmallMultiplesOptions","description":"The small multiples setup for the visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisBarChartSortConfiguration","description":"The sort configuration of a `BarChartVisual` ."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The tooltip display setup of the visual."},"valueAxis":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The label display options (grid line, range, scale, axis step) for a bar chart value."},"valueLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility and sort icon visibility) for a bar chart value."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualPalette","description":"The palette (chart color) display setup of the visual."}},"type":"object"},"aws-native:quicksight:AnalysisBarChartFieldWells":{"properties":{"barChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisBarChartAggregatedFieldWells","description":"The aggregated field wells of a bar chart."}},"type":"object"},"aws-native:quicksight:AnalysisBarChartOrientation":{"type":"string","enum":[{"name":"Horizontal","value":"HORIZONTAL"},{"name":"Vertical","value":"VERTICAL"}]},"aws-native:quicksight:AnalysisBarChartSortConfiguration":{"properties":{"categoryItemsLimit":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of categories displayed in a bar chart."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of category fields."},"colorItemsLimit":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of values displayed in a bar chart."},"colorSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of color fields in a bar chart."},"smallMultiplesLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of small multiples panels that are displayed."},"smallMultiplesSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of the small multiples field."}},"type":"object"},"aws-native:quicksight:AnalysisBarChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisBarChartConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisBarsArrangement":{"type":"string","enum":[{"name":"Clustered","value":"CLUSTERED"},{"name":"Stacked","value":"STACKED"},{"name":"StackedPercent","value":"STACKED_PERCENT"}]},"aws-native:quicksight:AnalysisBaseMapStyleType":{"type":"string","enum":[{"name":"LightGray","value":"LIGHT_GRAY"},{"name":"DarkGray","value":"DARK_GRAY"},{"name":"Street","value":"STREET"},{"name":"Imagery","value":"IMAGERY"}]},"aws-native:quicksight:AnalysisBinCountOptions":{"properties":{"value":{"type":"number","description":"The options that determine the bin count value."}},"type":"object"},"aws-native:quicksight:AnalysisBinWidthOptions":{"properties":{"binCountLimit":{"type":"number","description":"The options that determine the bin count limit."},"value":{"type":"number","description":"The options that determine the bin width value."}},"type":"object"},"aws-native:quicksight:AnalysisBodySectionConfiguration":{"properties":{"content":{"$ref":"#/types/aws-native:quicksight:AnalysisBodySectionContent","description":"The configuration of content in a body section."},"pageBreakConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisSectionPageBreakConfiguration","description":"The configuration of a page break for a section."},"repeatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisBodySectionRepeatConfiguration","description":"Describes the configurations that are required to declare a section as repeating."},"sectionId":{"type":"string","description":"The unique identifier of a body section."},"style":{"$ref":"#/types/aws-native:quicksight:AnalysisSectionStyle","description":"The style options of a body section."}},"type":"object","required":["content","sectionId"]},"aws-native:quicksight:AnalysisBodySectionContent":{"properties":{"layout":{"$ref":"#/types/aws-native:quicksight:AnalysisSectionLayoutConfiguration","description":"The layout configuration of a body section."}},"type":"object"},"aws-native:quicksight:AnalysisBodySectionDynamicCategoryDimensionConfiguration":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier"},"limit":{"type":"number","description":"Number of values to use from the column for repetition."},"sortByMetrics":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnSort"},"description":"Sort criteria on the column values that you use for repetition."}},"type":"object","required":["column"]},"aws-native:quicksight:AnalysisBodySectionDynamicNumericDimensionConfiguration":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier"},"limit":{"type":"number","description":"Number of values to use from the column for repetition."},"sortByMetrics":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnSort"},"description":"Sort criteria on the column values that you use for repetition."}},"type":"object","required":["column"]},"aws-native:quicksight:AnalysisBodySectionRepeatConfiguration":{"properties":{"dimensionConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisBodySectionRepeatDimensionConfiguration"},"description":"List of `BodySectionRepeatDimensionConfiguration` values that describe the dataset column and constraints for the column used to repeat the contents of a section."},"nonRepeatingVisuals":{"type":"array","items":{"type":"string"},"description":"List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances."},"pageBreakConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisBodySectionRepeatPageBreakConfiguration","description":"Page break configuration to apply for each repeating instance."}},"type":"object"},"aws-native:quicksight:AnalysisBodySectionRepeatDimensionConfiguration":{"properties":{"dynamicCategoryDimensionConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisBodySectionDynamicCategoryDimensionConfiguration","description":"Describes the *Category* dataset column and constraints around the dynamic values that will be used in repeating the section contents."},"dynamicNumericDimensionConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisBodySectionDynamicNumericDimensionConfiguration","description":"Describes the *Numeric* dataset column and constraints around the dynamic values used to repeat the contents of a section."}},"type":"object"},"aws-native:quicksight:AnalysisBodySectionRepeatPageBreakConfiguration":{"properties":{"after":{"$ref":"#/types/aws-native:quicksight:AnalysisSectionAfterPageBreak"}},"type":"object"},"aws-native:quicksight:AnalysisBoxPlotAggregatedFieldWells":{"properties":{"groupBy":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The group by field well of a box plot chart. Values are grouped based on group by fields."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The value field well of a box plot chart. Values are aggregated based on group by fields."}},"type":"object"},"aws-native:quicksight:AnalysisBoxPlotChartConfiguration":{"properties":{"boxPlotOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisBoxPlotOptions","description":"The box plot chart options for a box plot visual"},"categoryAxis":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The label display options (grid line, range, scale, axis step) of a box plot category."},"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility and sort Icon visibility) of a box plot category."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisBoxPlotFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions"},"primaryYAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The label display options (grid line, range, scale, axis step) of a box plot category."},"primaryYAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility and sort icon visibility) of a box plot value."},"referenceLines":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLine"},"description":"The reference line setup of the visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisBoxPlotSortConfiguration","description":"The sort configuration of a `BoxPlotVisual` ."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The tooltip display setup of the visual."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualPalette","description":"The palette (chart color) display setup of the visual."}},"type":"object"},"aws-native:quicksight:AnalysisBoxPlotFieldWells":{"properties":{"boxPlotAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisBoxPlotAggregatedFieldWells","description":"The aggregated field wells of a box plot."}},"type":"object"},"aws-native:quicksight:AnalysisBoxPlotFillStyle":{"type":"string","enum":[{"name":"Solid","value":"SOLID"},{"name":"Transparent","value":"TRANSPARENT"}]},"aws-native:quicksight:AnalysisBoxPlotOptions":{"properties":{"allDataPointsVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines the visibility of all data points of the box plot."},"outlierVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines the visibility of the outlier in a box plot."},"styleOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisBoxPlotStyleOptions","description":"The style options of the box plot."}},"type":"object"},"aws-native:quicksight:AnalysisBoxPlotSortConfiguration":{"properties":{"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of a group by fields."},"paginationConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisPaginationConfiguration","description":"The pagination configuration of a table visual or box plot."}},"type":"object"},"aws-native:quicksight:AnalysisBoxPlotStyleOptions":{"properties":{"fillStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisBoxPlotFillStyle","description":"The fill styles (solid, transparent) of the box plot."}},"type":"object"},"aws-native:quicksight:AnalysisBoxPlotVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisBoxPlotChartConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisCalculatedField":{"properties":{"dataSetIdentifier":{"type":"string","description":"The data set that is used in this calculated field."},"expression":{"type":"string","description":"The expression of the calculated field."},"name":{"type":"string","description":"The name of the calculated field."}},"type":"object","required":["dataSetIdentifier","expression","name"]},"aws-native:quicksight:AnalysisCalculatedMeasureField":{"properties":{"expression":{"type":"string","description":"The expression in the table calculation."},"fieldId":{"type":"string","description":"The custom field ID."}},"type":"object","required":["expression","fieldId"]},"aws-native:quicksight:AnalysisCascadingControlConfiguration":{"properties":{"sourceControls":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisCascadingControlSource"},"description":"A list of source controls that determine the values that are used in the current control."}},"type":"object"},"aws-native:quicksight:AnalysisCascadingControlSource":{"properties":{"columnToMatch":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column identifier that determines which column to look up for the source sheet control."},"sourceSheetControlId":{"type":"string","description":"The source sheet control ID of a `CascadingControlSource` ."}},"type":"object"},"aws-native:quicksight:AnalysisCategoricalAggregationFunction":{"type":"string","enum":[{"name":"Count","value":"COUNT"},{"name":"DistinctCount","value":"DISTINCT_COUNT"}]},"aws-native:quicksight:AnalysisCategoricalDimensionField":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that is used in the `CategoricalDimensionField` ."},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisStringFormatConfiguration","description":"The format configuration of the field."},"hierarchyId":{"type":"string","description":"The custom hierarchy ID."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:AnalysisCategoricalMeasureField":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoricalAggregationFunction","description":"The aggregation function of the measure field."},"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that is used in the `CategoricalMeasureField` ."},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisStringFormatConfiguration","description":"The format configuration of the field."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:AnalysisCategoryDrillDownFilter":{"properties":{"categoryValues":{"type":"array","items":{"type":"string"},"description":"A list of the string inputs that are the values of the category drill down filter."},"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the filter is applied to."}},"type":"object","required":["categoryValues","column"]},"aws-native:quicksight:AnalysisCategoryFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the filter is applied to."},"configuration":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoryFilterConfiguration","description":"The configuration for a `CategoryFilter` ."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."}},"type":"object","required":["column","configuration","filterId"]},"aws-native:quicksight:AnalysisCategoryFilterConfiguration":{"properties":{"customFilterConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomFilterConfiguration","description":"A custom filter that filters based on a single value. This filter can be partially matched."},"customFilterListConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomFilterListConfiguration","description":"A list of custom filter values. In the Quick Sight console, this filter type is called a custom filter list."},"filterListConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterListConfiguration","description":"A list of filter configurations. In the Quick Sight console, this filter type is called a filter list."}},"type":"object"},"aws-native:quicksight:AnalysisCategoryFilterMatchOperator":{"type":"string","enum":[{"name":"Equals","value":"EQUALS"},{"name":"DoesNotEqual","value":"DOES_NOT_EQUAL"},{"name":"Contains","value":"CONTAINS"},{"name":"DoesNotContain","value":"DOES_NOT_CONTAIN"},{"name":"StartsWith","value":"STARTS_WITH"},{"name":"EndsWith","value":"ENDS_WITH"}]},"aws-native:quicksight:AnalysisCategoryFilterSelectAllOptions":{"type":"string","enum":[{"name":"FilterAllValues","value":"FILTER_ALL_VALUES"}]},"aws-native:quicksight:AnalysisCategoryInnerFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier"},"configuration":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoryFilterConfiguration"},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultFilterControlConfiguration"}},"type":"object","required":["column","configuration"]},"aws-native:quicksight:AnalysisChartAxisLabelOptions":{"properties":{"axisLabelOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisLabelOptions"},"description":"The label options for a chart axis."},"sortIconVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility configuration of the sort icon on a chart's axis label."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of an axis label on a chart. Choose one of the following options:\n\n- `VISIBLE` : Shows the axis.\n- `HIDDEN` : Hides the axis."}},"type":"object"},"aws-native:quicksight:AnalysisClusterMarker":{"properties":{"simpleClusterMarker":{"$ref":"#/types/aws-native:quicksight:AnalysisSimpleClusterMarker","description":"The simple cluster marker of the cluster marker."}},"type":"object"},"aws-native:quicksight:AnalysisClusterMarkerConfiguration":{"properties":{"clusterMarker":{"$ref":"#/types/aws-native:quicksight:AnalysisClusterMarker","description":"The cluster marker that is a part of the cluster marker configuration."}},"type":"object"},"aws-native:quicksight:AnalysisColorFillType":{"type":"string","enum":[{"name":"Discrete","value":"DISCRETE"},{"name":"Gradient","value":"GRADIENT"}]},"aws-native:quicksight:AnalysisColorScale":{"properties":{"colorFillType":{"$ref":"#/types/aws-native:quicksight:AnalysisColorFillType","description":"Determines the color fill type."},"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDataColor"},"description":"Determines the list of colors that are applied to the visual."},"nullValueColor":{"$ref":"#/types/aws-native:quicksight:AnalysisDataColor","description":"Determines the color that is applied to null values."}},"type":"object","required":["colorFillType","colors"]},"aws-native:quicksight:AnalysisColorsConfiguration":{"properties":{"customColors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomColor"},"description":"A list of up to 50 custom colors."}},"type":"object"},"aws-native:quicksight:AnalysisColumnConfiguration":{"properties":{"colorsConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisColorsConfiguration","description":"The color configurations of the column."},"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFormatConfiguration","description":"The format configuration of a column."},"role":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnRole","description":"The role of the column."}},"type":"object","required":["column"]},"aws-native:quicksight:AnalysisColumnHierarchy":{"properties":{"dateTimeHierarchy":{"$ref":"#/types/aws-native:quicksight:AnalysisDateTimeHierarchy","description":"The option that determines the hierarchy of any `DateTime` fields."},"explicitHierarchy":{"$ref":"#/types/aws-native:quicksight:AnalysisExplicitHierarchy","description":"The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals."},"predefinedHierarchy":{"$ref":"#/types/aws-native:quicksight:AnalysisPredefinedHierarchy","description":"The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source."}},"type":"object"},"aws-native:quicksight:AnalysisColumnIdentifier":{"properties":{"columnName":{"type":"string","description":"The name of the column."},"dataSetIdentifier":{"type":"string","description":"The data set that the column belongs to."}},"type":"object","required":["columnName","dataSetIdentifier"]},"aws-native:quicksight:AnalysisColumnRole":{"type":"string","enum":[{"name":"Dimension","value":"DIMENSION"},{"name":"Measure","value":"MEASURE"}]},"aws-native:quicksight:AnalysisColumnSort":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisAggregationFunction","description":"The aggregation function that is defined in the column sort."},"direction":{"$ref":"#/types/aws-native:quicksight:AnalysisSortDirection","description":"The sort direction."},"sortBy":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier"}},"type":"object","required":["direction","sortBy"]},"aws-native:quicksight:AnalysisColumnTooltipItem":{"properties":{"aggregation":{"$ref":"#/types/aws-native:quicksight:AnalysisAggregationFunction","description":"The aggregation function of the column tooltip item."},"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The target column of the tooltip item."},"label":{"type":"string","description":"The label of the tooltip item."},"tooltipTarget":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipTarget","description":"Determines the target of the column tooltip item in a combo chart visual."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the tooltip item."}},"type":"object","required":["column"]},"aws-native:quicksight:AnalysisComboChartAggregatedFieldWells":{"properties":{"barValues":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The aggregated `BarValues` field well of a combo chart."},"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The aggregated category field wells of a combo chart."},"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The aggregated colors field well of a combo chart."},"lineValues":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The aggregated `LineValues` field well of a combo chart."}},"type":"object"},"aws-native:quicksight:AnalysisComboChartConfiguration":{"properties":{"barDataLabels":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOptions","description":"The options that determine if visual data labels are displayed.\n\nThe data label options for a bar in a combo chart."},"barsArrangement":{"$ref":"#/types/aws-native:quicksight:AnalysisBarsArrangement","description":"Determines the bar arrangement in a combo chart. The following are valid values in this structure:\n\n- `CLUSTERED` : For clustered bar combo charts.\n- `STACKED` : For stacked bar combo charts.\n- `STACKED_PERCENT` : Do not use. If you use this value, the operation returns a validation error."},"categoryAxis":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The category axis of a combo chart."},"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well."},"colorLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisComboChartFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions","description":"The legend display setup of the visual."},"lineDataLabels":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOptions","description":"The options that determine if visual data labels are displayed.\n\nThe data label options for a line in a combo chart."},"primaryYAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well."},"primaryYAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well."},"referenceLines":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLine"},"description":"The reference line setup of the visual."},"secondaryYAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well."},"secondaryYAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well."},"singleAxisOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSingleAxisOptions"},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisComboChartSortConfiguration","description":"The sort configuration of a `ComboChartVisual` ."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The legend display setup of the visual."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualPalette","description":"The palette (chart color) display setup of the visual."}},"type":"object"},"aws-native:quicksight:AnalysisComboChartFieldWells":{"properties":{"comboChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisComboChartAggregatedFieldWells","description":"The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category."}},"type":"object"},"aws-native:quicksight:AnalysisComboChartSortConfiguration":{"properties":{"categoryItemsLimit":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The item limit configuration for the category field well of a combo chart."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of the category field well in a combo chart."},"colorItemsLimit":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The item limit configuration of the color field well in a combo chart."},"colorSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of the color field well in a combo chart."}},"type":"object"},"aws-native:quicksight:AnalysisComboChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisComboChartConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisCommitMode":{"type":"string","enum":[{"name":"Auto","value":"AUTO"},{"name":"Manual","value":"MANUAL"}]},"aws-native:quicksight:AnalysisComparisonConfiguration":{"properties":{"comparisonFormat":{"$ref":"#/types/aws-native:quicksight:AnalysisComparisonFormatConfiguration","description":"The format of the comparison."},"comparisonMethod":{"$ref":"#/types/aws-native:quicksight:AnalysisComparisonMethod","description":"The method of the comparison. Choose from the following options:\n\n- `DIFFERENCE`\n- `PERCENT_DIFFERENCE`\n- `PERCENT`"}},"type":"object"},"aws-native:quicksight:AnalysisComparisonFormatConfiguration":{"properties":{"numberDisplayFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNumberDisplayFormatConfiguration","description":"The number display format."},"percentageDisplayFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisPercentageDisplayFormatConfiguration","description":"The percentage display format."}},"type":"object"},"aws-native:quicksight:AnalysisComparisonMethod":{"type":"string","enum":[{"name":"Difference","value":"DIFFERENCE"},{"name":"PercentDifference","value":"PERCENT_DIFFERENCE"},{"name":"Percent","value":"PERCENT"}]},"aws-native:quicksight:AnalysisComputation":{"properties":{"forecast":{"$ref":"#/types/aws-native:quicksight:AnalysisForecastComputation","description":"The forecast computation configuration."},"growthRate":{"$ref":"#/types/aws-native:quicksight:AnalysisGrowthRateComputation","description":"The growth rate computation configuration."},"maximumMinimum":{"$ref":"#/types/aws-native:quicksight:AnalysisMaximumMinimumComputation","description":"The maximum and minimum computation configuration."},"metricComparison":{"$ref":"#/types/aws-native:quicksight:AnalysisMetricComparisonComputation","description":"The metric comparison computation configuration."},"periodOverPeriod":{"$ref":"#/types/aws-native:quicksight:AnalysisPeriodOverPeriodComputation","description":"The period over period computation configuration."},"periodToDate":{"$ref":"#/types/aws-native:quicksight:AnalysisPeriodToDateComputation","description":"The period to `DataSetIdentifier` computation configuration."},"topBottomMovers":{"$ref":"#/types/aws-native:quicksight:AnalysisTopBottomMoversComputation","description":"The top movers and bottom movers computation configuration."},"topBottomRanked":{"$ref":"#/types/aws-native:quicksight:AnalysisTopBottomRankedComputation","description":"The top ranked and bottom ranked computation configuration."},"totalAggregation":{"$ref":"#/types/aws-native:quicksight:AnalysisTotalAggregationComputation","description":"The total aggregation computation configuration."},"uniqueValues":{"$ref":"#/types/aws-native:quicksight:AnalysisUniqueValuesComputation","description":"The unique values computation configuration."}},"type":"object"},"aws-native:quicksight:AnalysisConditionalFormattingColor":{"properties":{"gradient":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingGradientColor","description":"Formatting configuration for gradient color."},"solid":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingSolidColor","description":"Formatting configuration for solid color."}},"type":"object"},"aws-native:quicksight:AnalysisConditionalFormattingCustomIconCondition":{"properties":{"color":{"type":"string","description":"Determines the color of the icon."},"displayConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingIconDisplayConfiguration","description":"Determines the icon display configuration."},"expression":{"type":"string","description":"The expression that determines the condition of the icon set."},"iconOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingCustomIconOptions","description":"Custom icon options for an icon set."}},"type":"object","required":["expression","iconOptions"]},"aws-native:quicksight:AnalysisConditionalFormattingCustomIconOptions":{"properties":{"icon":{"$ref":"#/types/aws-native:quicksight:AnalysisIcon","description":"Determines the type of icon."},"unicodeIcon":{"type":"string","description":"Determines the Unicode icon type."}},"type":"object"},"aws-native:quicksight:AnalysisConditionalFormattingGradientColor":{"properties":{"color":{"$ref":"#/types/aws-native:quicksight:AnalysisGradientColor","description":"Determines the color."},"expression":{"type":"string","description":"The expression that determines the formatting configuration for gradient color."}},"type":"object","required":["color","expression"]},"aws-native:quicksight:AnalysisConditionalFormattingIcon":{"properties":{"customCondition":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingCustomIconCondition","description":"Determines the custom condition for an icon set."},"iconSet":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingIconSet","description":"Formatting configuration for icon set."}},"type":"object"},"aws-native:quicksight:AnalysisConditionalFormattingIconDisplayConfiguration":{"properties":{"iconDisplayOption":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingIconDisplayOption","description":"Determines the icon display configuration."}},"type":"object"},"aws-native:quicksight:AnalysisConditionalFormattingIconDisplayOption":{"type":"string","enum":[{"name":"IconOnly","value":"ICON_ONLY"}]},"aws-native:quicksight:AnalysisConditionalFormattingIconSet":{"properties":{"expression":{"type":"string","description":"The expression that determines the formatting configuration for the icon set."},"iconSetType":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingIconSetType","description":"Determines the icon set type."}},"type":"object","required":["expression"]},"aws-native:quicksight:AnalysisConditionalFormattingIconSetType":{"type":"string","enum":[{"name":"PlusMinus","value":"PLUS_MINUS"},{"name":"CheckX","value":"CHECK_X"},{"name":"ThreeColorArrow","value":"THREE_COLOR_ARROW"},{"name":"ThreeGrayArrow","value":"THREE_GRAY_ARROW"},{"name":"CaretUpMinusDown","value":"CARET_UP_MINUS_DOWN"},{"name":"ThreeShape","value":"THREE_SHAPE"},{"name":"ThreeCircle","value":"THREE_CIRCLE"},{"name":"Flags","value":"FLAGS"},{"name":"Bars","value":"BARS"},{"name":"FourColorArrow","value":"FOUR_COLOR_ARROW"},{"name":"FourGrayArrow","value":"FOUR_GRAY_ARROW"}]},"aws-native:quicksight:AnalysisConditionalFormattingSolidColor":{"properties":{"color":{"type":"string","description":"Determines the color."},"expression":{"type":"string","description":"The expression that determines the formatting configuration for solid color."}},"type":"object","required":["expression"]},"aws-native:quicksight:AnalysisContextMenuOption":{"properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:AnalysisDashboardBehavior","description":"The availability status of the context menu options. If the value of this property is set to `ENABLED` , dashboard readers can interact with the context menu."}},"type":"object"},"aws-native:quicksight:AnalysisContributionAnalysisDefault":{"properties":{"contributorDimensions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier"},"description":"The dimensions columns that are used in the contribution analysis, usually a list of `ColumnIdentifiers` ."},"measureFieldId":{"type":"string","description":"The measure field that is used in the contribution analysis."}},"type":"object","required":["contributorDimensions","measureFieldId"]},"aws-native:quicksight:AnalysisCrossDatasetTypes":{"type":"string","enum":[{"name":"AllDatasets","value":"ALL_DATASETS"},{"name":"SingleDataset","value":"SINGLE_DATASET"}]},"aws-native:quicksight:AnalysisCurrencyDisplayFormatConfiguration":{"properties":{"decimalPlacesConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDecimalPlacesConfiguration","description":"The option that determines the decimal places configuration."},"negativeValueConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNegativeValueConfiguration","description":"The options that determine the negative value configuration."},"nullValueFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNullValueFormatConfiguration","description":"The options that determine the null value format configuration."},"numberScale":{"$ref":"#/types/aws-native:quicksight:AnalysisNumberScale","description":"Determines the number scale value for the currency format."},"prefix":{"type":"string","description":"Determines the prefix value of the currency format."},"separatorConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericSeparatorConfiguration","description":"The options that determine the numeric separator configuration."},"suffix":{"type":"string","description":"Determines the suffix value of the currency format."},"symbol":{"type":"string","description":"Determines the symbol for the currency format."}},"type":"object"},"aws-native:quicksight:AnalysisCustomActionFilterOperation":{"properties":{"selectedFieldsConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterOperationSelectedFieldsConfiguration","description":"The configuration that chooses the fields to be filtered."},"targetVisualsConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterOperationTargetVisualsConfiguration","description":"The configuration that chooses the target visuals to be filtered."}},"type":"object","required":["selectedFieldsConfiguration","targetVisualsConfiguration"]},"aws-native:quicksight:AnalysisCustomActionNavigationOperation":{"properties":{"localNavigationConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisLocalNavigationConfiguration","description":"The configuration that chooses the navigation target."}},"type":"object"},"aws-native:quicksight:AnalysisCustomActionSetParametersOperation":{"properties":{"parameterValueConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisSetParameterValueConfiguration"},"description":"The parameter that determines the value configuration."}},"type":"object","required":["parameterValueConfigurations"]},"aws-native:quicksight:AnalysisCustomActionUrlOperation":{"properties":{"urlTarget":{"$ref":"#/types/aws-native:quicksight:AnalysisUrlTargetConfiguration","description":"The target of the `CustomActionURLOperation` .\n\nValid values are defined as follows:\n\n- `NEW_TAB` : Opens the target URL in a new browser tab.\n- `NEW_WINDOW` : Opens the target URL in a new browser window.\n- `SAME_TAB` : Opens the target URL in the same browser tab."},"urlTemplate":{"type":"string","description":"THe URL link of the `CustomActionURLOperation` ."}},"type":"object","required":["urlTarget","urlTemplate"]},"aws-native:quicksight:AnalysisCustomColor":{"properties":{"color":{"type":"string","description":"The color that is applied to the data value."},"fieldValue":{"type":"string","description":"The data value that the color is applied to."},"specialValue":{"$ref":"#/types/aws-native:quicksight:AnalysisSpecialValue","description":"The value of a special data value."}},"type":"object","required":["color"]},"aws-native:quicksight:AnalysisCustomContentConfiguration":{"properties":{"contentType":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomContentType","description":"The content type of the custom content visual. You can use this to have the visual render as an image."},"contentUrl":{"type":"string","description":"The input URL that links to the custom content that you want in the custom visual."},"imageScaling":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomContentImageScalingConfiguration","description":"The sizing options for the size of the custom content visual. This structure is required when the `ContentType` of the visual is `'IMAGE'` ."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."}},"type":"object"},"aws-native:quicksight:AnalysisCustomContentImageScalingConfiguration":{"type":"string","enum":[{"name":"FitToHeight","value":"FIT_TO_HEIGHT"},{"name":"FitToWidth","value":"FIT_TO_WIDTH"},{"name":"DoNotScale","value":"DO_NOT_SCALE"},{"name":"ScaleToVisual","value":"SCALE_TO_VISUAL"}]},"aws-native:quicksight:AnalysisCustomContentType":{"type":"string","enum":[{"name":"Image","value":"IMAGE"},{"name":"OtherEmbeddedContent","value":"OTHER_EMBEDDED_CONTENT"}]},"aws-native:quicksight:AnalysisCustomContentVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomContentConfiguration","description":"The configuration of a `CustomContentVisual` ."},"dataSetIdentifier":{"type":"string","description":"The dataset that is used to create the custom content visual. You can't create a visual without a dataset."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["dataSetIdentifier","visualId"]},"aws-native:quicksight:AnalysisCustomFilterConfiguration":{"properties":{"categoryValue":{"type":"string","description":"The category value for the filter.\n\nThis field is mutually exclusive to `ParameterName` ."},"matchOperator":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoryFilterMatchOperator","description":"The match operator that is used to determine if a filter should be applied."},"nullOption":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"parameterName":{"type":"string","description":"The parameter whose value should be used for the filter value.\n\nThis field is mutually exclusive to `CategoryValue` ."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoryFilterSelectAllOptions","description":"Select all of the values. Null is not the assigned value of select all.\n\n- `FILTER_ALL_VALUES`"}},"type":"object","required":["matchOperator","nullOption"]},"aws-native:quicksight:AnalysisCustomFilterListConfiguration":{"properties":{"categoryValues":{"type":"array","items":{"type":"string"},"description":"The list of category values for the filter."},"matchOperator":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoryFilterMatchOperator","description":"The match operator that is used to determine if a filter should be applied."},"nullOption":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoryFilterSelectAllOptions","description":"Select all of the values. Null is not the assigned value of select all.\n\n- `FILTER_ALL_VALUES`"}},"type":"object","required":["matchOperator","nullOption"]},"aws-native:quicksight:AnalysisCustomNarrativeOptions":{"properties":{"narrative":{"type":"string","description":"The string input of custom narrative."}},"type":"object","required":["narrative"]},"aws-native:quicksight:AnalysisCustomParameterValues":{"properties":{"dateTimeValues":{"type":"array","items":{"type":"string"},"description":"A list of datetime-type parameter values."},"decimalValues":{"type":"array","items":{"type":"number"},"description":"A list of decimal-type parameter values."},"integerValues":{"type":"array","items":{"type":"number"},"description":"A list of integer-type parameter values."},"stringValues":{"type":"array","items":{"type":"string"},"description":"A list of string-type parameter values."}},"type":"object"},"aws-native:quicksight:AnalysisCustomValuesConfiguration":{"properties":{"customValues":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomParameterValues"},"includeNullValue":{"type":"boolean","description":"Includes the null value in custom action parameter values."}},"type":"object","required":["customValues"]},"aws-native:quicksight:AnalysisDashboardBehavior":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:AnalysisDataBarsOptions":{"properties":{"fieldId":{"type":"string","description":"The field ID for the data bars options."},"negativeColor":{"type":"string","description":"The color of the negative data bar."},"positiveColor":{"type":"string","description":"The color of the positive data bar."}},"type":"object","required":["fieldId"]},"aws-native:quicksight:AnalysisDataColor":{"properties":{"color":{"type":"string","description":"The color that is applied to the data value."},"dataValue":{"type":"number","description":"The data value that the color is applied to."}},"type":"object"},"aws-native:quicksight:AnalysisDataFieldSeriesItem":{"properties":{"axisBinding":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisBinding","description":"The axis that you are binding the field to."},"fieldId":{"type":"string","description":"The field ID of the field that you are setting the axis binding to."},"fieldValue":{"type":"string","description":"The field value of the field that you are setting the axis binding to."},"settings":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartSeriesSettings","description":"The options that determine the presentation of line series associated to the field."}},"type":"object","required":["axisBinding","fieldId"]},"aws-native:quicksight:AnalysisDataLabelContent":{"type":"string","enum":[{"name":"Value","value":"VALUE"},{"name":"Percent","value":"PERCENT"},{"name":"ValueAndPercent","value":"VALUE_AND_PERCENT"}]},"aws-native:quicksight:AnalysisDataLabelOptions":{"properties":{"categoryLabelVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines the visibility of the category field labels."},"dataLabelTypes":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelType"},"description":"The option that determines the data label type."},"labelColor":{"type":"string","description":"Determines the color of the data labels."},"labelContent":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelContent","description":"Determines the content of the data labels."},"labelFontConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontConfiguration","description":"Determines the font configuration of the data labels."},"measureLabelVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines the visibility of the measure field labels."},"overlap":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOverlap","description":"Determines whether overlap is enabled or disabled for the data labels."},"position":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelPosition","description":"Determines the position of the data labels."},"totalsVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines the visibility of the total."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines the visibility of the data labels."}},"type":"object"},"aws-native:quicksight:AnalysisDataLabelOverlap":{"type":"string","enum":[{"name":"DisableOverlap","value":"DISABLE_OVERLAP"},{"name":"EnableOverlap","value":"ENABLE_OVERLAP"}]},"aws-native:quicksight:AnalysisDataLabelPosition":{"type":"string","enum":[{"name":"Inside","value":"INSIDE"},{"name":"Outside","value":"OUTSIDE"},{"name":"Left","value":"LEFT"},{"name":"Top","value":"TOP"},{"name":"Bottom","value":"BOTTOM"},{"name":"Right","value":"RIGHT"}]},"aws-native:quicksight:AnalysisDataLabelType":{"properties":{"dataPathLabelType":{"$ref":"#/types/aws-native:quicksight:AnalysisDataPathLabelType","description":"The option that specifies individual data values for labels."},"fieldLabelType":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldLabelType","description":"Determines the label configuration for the entire field."},"maximumLabelType":{"$ref":"#/types/aws-native:quicksight:AnalysisMaximumLabelType","description":"Determines the label configuration for the maximum value in a visual."},"minimumLabelType":{"$ref":"#/types/aws-native:quicksight:AnalysisMinimumLabelType","description":"Determines the label configuration for the minimum value in a visual."},"rangeEndsLabelType":{"$ref":"#/types/aws-native:quicksight:AnalysisRangeEndsLabelType","description":"Determines the label configuration for range end value in a visual."}},"type":"object"},"aws-native:quicksight:AnalysisDataPathColor":{"properties":{"color":{"type":"string","description":"The color that needs to be applied to the element."},"element":{"$ref":"#/types/aws-native:quicksight:AnalysisDataPathValue","description":"The element that the color needs to be applied to."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeGranularity","description":"The time granularity of the field that the color needs to be applied to."}},"type":"object","required":["color","element"]},"aws-native:quicksight:AnalysisDataPathLabelType":{"properties":{"fieldId":{"type":"string","description":"The field ID of the field that the data label needs to be applied to."},"fieldValue":{"type":"string","description":"The actual value of the field that is labeled."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the data label."}},"type":"object"},"aws-native:quicksight:AnalysisDataPathSort":{"properties":{"direction":{"$ref":"#/types/aws-native:quicksight:AnalysisSortDirection","description":"Determines the sort direction."},"sortPaths":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDataPathValue"},"description":"The list of data paths that need to be sorted."}},"type":"object","required":["direction","sortPaths"]},"aws-native:quicksight:AnalysisDataPathType":{"properties":{"pivotTableDataPathType":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableDataPathType","description":"The type of data path value utilized in a pivot table. Choose one of the following options:\n\n- `HIERARCHY_ROWS_LAYOUT_COLUMN` - The type of data path for the rows layout column, when `RowsLayout` is set to `HIERARCHY` .\n- `MULTIPLE_ROW_METRICS_COLUMN` - The type of data path for the metric column when the row is set to Metric Placement.\n- `EMPTY_COLUMN_HEADER` - The type of data path for the column with empty column header, when there is no field in `ColumnsFieldWell` and the row is set to Metric Placement.\n- `COUNT_METRIC_COLUMN` - The type of data path for the column with `COUNT` as the metric, when there is no field in the `ValuesFieldWell` ."}},"type":"object"},"aws-native:quicksight:AnalysisDataPathValue":{"properties":{"dataPathType":{"$ref":"#/types/aws-native:quicksight:AnalysisDataPathType","description":"The type configuration of the field."},"fieldId":{"type":"string","description":"The field ID of the field that needs to be sorted."},"fieldValue":{"type":"string","description":"The actual value of the field that needs to be sorted."}},"type":"object"},"aws-native:quicksight:AnalysisDataSetIdentifierDeclaration":{"properties":{"dataSetArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the data set."},"identifier":{"type":"string","description":"The identifier of the data set, typically the data set's name."}},"type":"object","required":["dataSetArn","identifier"]},"aws-native:quicksight:AnalysisDataSetReference":{"description":"\u003cp\u003eDataset reference.\u003c/p\u003e","properties":{"dataSetArn":{"type":"string","description":"\u003cp\u003eDataset Amazon Resource Name (ARN).\u003c/p\u003e"},"dataSetPlaceholder":{"type":"string","description":"\u003cp\u003eDataset placeholder.\u003c/p\u003e"}},"type":"object","required":["dataSetArn","dataSetPlaceholder"]},"aws-native:quicksight:AnalysisDateAggregationFunction":{"type":"string","enum":[{"name":"Count","value":"COUNT"},{"name":"DistinctCount","value":"DISTINCT_COUNT"},{"name":"Min","value":"MIN"},{"name":"Max","value":"MAX"}]},"aws-native:quicksight:AnalysisDateAxisOptions":{"properties":{"missingDateVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines whether or not missing dates are displayed."}},"type":"object"},"aws-native:quicksight:AnalysisDateDimensionField":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that is used in the `DateDimensionField` ."},"dateGranularity":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeGranularity","description":"The date granularity of the `DateDimensionField` . Choose one of the following options:\n\n- `YEAR`\n- `QUARTER`\n- `MONTH`\n- `WEEK`\n- `DAY`\n- `HOUR`\n- `MINUTE`\n- `SECOND`\n- `MILLISECOND`"},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDateTimeFormatConfiguration","description":"The format configuration of the field."},"hierarchyId":{"type":"string","description":"The custom hierarchy ID."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:AnalysisDateMeasureField":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisDateAggregationFunction","description":"The aggregation function of the measure field."},"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that is used in the `DateMeasureField` ."},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDateTimeFormatConfiguration","description":"The format configuration of the field."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:AnalysisDateTimeDefaultValues":{"properties":{"dynamicValue":{"$ref":"#/types/aws-native:quicksight:AnalysisDynamicDefaultValue","description":"The dynamic value of the `DataTimeDefaultValues` . Different defaults are displayed according to users, groups, and values mapping."},"rollingDate":{"$ref":"#/types/aws-native:quicksight:AnalysisRollingDateConfiguration","description":"The rolling date of the `DataTimeDefaultValues` . The date is determined from the dataset based on input expression."},"staticValues":{"type":"array","items":{"type":"string"},"description":"The static values of the `DataTimeDefaultValues` ."}},"type":"object"},"aws-native:quicksight:AnalysisDateTimeFormatConfiguration":{"properties":{"dateTimeFormat":{"type":"string","description":"Determines the `DateTime` format."},"nullValueFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNullValueFormatConfiguration","description":"The options that determine the null value format configuration."},"numericFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericFormatConfiguration","description":"The formatting configuration for numeric `DateTime` fields."}},"type":"object"},"aws-native:quicksight:AnalysisDateTimeHierarchy":{"properties":{"drillDownFilters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDrillDownFilter"},"description":"The option that determines the drill down filters for the `DateTime` hierarchy."},"hierarchyId":{"type":"string","description":"The hierarchy ID of the `DateTime` hierarchy."}},"type":"object","required":["hierarchyId"]},"aws-native:quicksight:AnalysisDateTimeParameter":{"description":"\u003cp\u003eA date-time parameter.\u003c/p\u003e","properties":{"name":{"type":"string","description":"\u003cp\u003eA display name for the date-time parameter.\u003c/p\u003e"},"values":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eThe values for the date-time parameter.\u003c/p\u003e"}},"type":"object","required":["name","values"]},"aws-native:quicksight:AnalysisDateTimeParameterDeclaration":{"properties":{"defaultValues":{"$ref":"#/types/aws-native:quicksight:AnalysisDateTimeDefaultValues","description":"The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided."},"mappedDataSetParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMappedDataSetParameter"}},"name":{"type":"string","description":"The name of the parameter that is being declared."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeGranularity","description":"The level of time precision that is used to aggregate `DateTime` values."},"valueWhenUnset":{"$ref":"#/types/aws-native:quicksight:AnalysisDateTimeValueWhenUnsetConfiguration","description":"The configuration that defines the default value of a `DateTime` parameter when a value has not been set."}},"type":"object","required":["name"]},"aws-native:quicksight:AnalysisDateTimePickerControlDisplayOptions":{"properties":{"dateIconVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The date icon visibility of the `DateTimePickerControlDisplayOptions` ."},"dateTimeFormat":{"type":"string","description":"Customize how dates are formatted in controls."},"helperTextVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The helper text visibility of the `DateTimePickerControlDisplayOptions` ."},"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:AnalysisDateTimeValueWhenUnsetConfiguration":{"properties":{"customValue":{"type":"string","description":"A custom value that's used when the value of a parameter isn't set."},"valueWhenUnsetOption":{"$ref":"#/types/aws-native:quicksight:AnalysisValueWhenUnsetOption","description":"The built-in options for default values. The value can be one of the following:\n\n- `RECOMMENDED` : The recommended value.\n- `NULL` : The `NULL` value."}},"type":"object"},"aws-native:quicksight:AnalysisDayOfTheWeek":{"type":"string","enum":[{"name":"Sunday","value":"SUNDAY"},{"name":"Monday","value":"MONDAY"},{"name":"Tuesday","value":"TUESDAY"},{"name":"Wednesday","value":"WEDNESDAY"},{"name":"Thursday","value":"THURSDAY"},{"name":"Friday","value":"FRIDAY"},{"name":"Saturday","value":"SATURDAY"}]},"aws-native:quicksight:AnalysisDecimalDefaultValues":{"properties":{"dynamicValue":{"$ref":"#/types/aws-native:quicksight:AnalysisDynamicDefaultValue","description":"The dynamic value of the `DecimalDefaultValues` . Different defaults are displayed according to users, groups, and values mapping."},"staticValues":{"type":"array","items":{"type":"number"},"description":"The static values of the `DecimalDefaultValues` ."}},"type":"object"},"aws-native:quicksight:AnalysisDecimalParameter":{"description":"\u003cp\u003eA decimal parameter.\u003c/p\u003e","properties":{"name":{"type":"string","description":"\u003cp\u003eA display name for the decimal parameter.\u003c/p\u003e"},"values":{"type":"array","items":{"type":"number"},"description":"\u003cp\u003eThe values for the decimal parameter.\u003c/p\u003e"}},"type":"object","required":["name","values"]},"aws-native:quicksight:AnalysisDecimalParameterDeclaration":{"properties":{"defaultValues":{"$ref":"#/types/aws-native:quicksight:AnalysisDecimalDefaultValues","description":"The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided."},"mappedDataSetParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMappedDataSetParameter"}},"name":{"type":"string","description":"The name of the parameter that is being declared."},"parameterValueType":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterValueType","description":"The value type determines whether the parameter is a single-value or multi-value parameter."},"valueWhenUnset":{"$ref":"#/types/aws-native:quicksight:AnalysisDecimalValueWhenUnsetConfiguration","description":"The configuration that defines the default value of a `Decimal` parameter when a value has not been set."}},"type":"object","required":["name","parameterValueType"]},"aws-native:quicksight:AnalysisDecimalPlacesConfiguration":{"properties":{"decimalPlaces":{"type":"number","description":"The values of the decimal places."}},"type":"object","required":["decimalPlaces"]},"aws-native:quicksight:AnalysisDecimalValueWhenUnsetConfiguration":{"properties":{"customValue":{"type":"number","description":"A custom value that's used when the value of a parameter isn't set."},"valueWhenUnsetOption":{"$ref":"#/types/aws-native:quicksight:AnalysisValueWhenUnsetOption","description":"The built-in options for default values. The value can be one of the following:\n\n- `RECOMMENDED` : The recommended value.\n- `NULL` : The `NULL` value."}},"type":"object"},"aws-native:quicksight:AnalysisDefaultDateTimePickerControlOptions":{"properties":{"commitMode":{"$ref":"#/types/aws-native:quicksight:AnalysisCommitMode","description":"The visibility configuration of the Apply button on a `DateTimePickerControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDateTimePickerControlDisplayOptions","description":"The display options of a control."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlDateTimePickerType","description":"The date time picker type of the `DefaultDateTimePickerControlOptions` . Choose one of the following options:\n\n- `SINGLE_VALUED` : The filter condition is a fixed date.\n- `DATE_RANGE` : The filter condition is a date time range."}},"type":"object"},"aws-native:quicksight:AnalysisDefaultFilterControlConfiguration":{"properties":{"controlOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultFilterControlOptions","description":"The control option for the `DefaultFilterControlConfiguration` ."},"title":{"type":"string","description":"The title of the `DefaultFilterControlConfiguration` . This title is shared by all controls that are tied to this filter."}},"type":"object","required":["controlOptions","title"]},"aws-native:quicksight:AnalysisDefaultFilterControlOptions":{"properties":{"defaultDateTimePickerOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultDateTimePickerControlOptions","description":"The default options that correspond to the filter control type of a `DateTimePicker` ."},"defaultDropdownOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultFilterDropDownControlOptions","description":"The default options that correspond to the `Dropdown` filter control type."},"defaultListOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultFilterListControlOptions","description":"The default options that correspond to the `List` filter control type."},"defaultRelativeDateTimeOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultRelativeDateTimeControlOptions","description":"The default options that correspond to the `RelativeDateTime` filter control type."},"defaultSliderOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultSliderControlOptions","description":"The default options that correspond to the `Slider` filter control type."},"defaultTextAreaOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultTextAreaControlOptions","description":"The default options that correspond to the `TextArea` filter control type."},"defaultTextFieldOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultTextFieldControlOptions","description":"The default options that correspond to the `TextField` filter control type."}},"type":"object"},"aws-native:quicksight:AnalysisDefaultFilterDropDownControlOptions":{"properties":{"commitMode":{"$ref":"#/types/aws-native:quicksight:AnalysisCommitMode","description":"The visibility configuration of the Apply button on a `FilterDropDownControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDropDownControlDisplayOptions","description":"The display options of a control."},"selectableValues":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterSelectableValues","description":"A list of selectable values that are used in a control."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlListType","description":"The type of the `FilterDropDownControl` . Choose one of the following options:\n\n- `MULTI_SELECT` : The user can select multiple entries from a dropdown menu.\n- `SINGLE_SELECT` : The user can select a single entry from a dropdown menu."}},"type":"object"},"aws-native:quicksight:AnalysisDefaultFilterListControlOptions":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisListControlDisplayOptions","description":"The display options of a control."},"selectableValues":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterSelectableValues","description":"A list of selectable values that are used in a control."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlListType","description":"The type of the `DefaultFilterListControlOptions` . Choose one of the following options:\n\n- `MULTI_SELECT` : The user can select multiple entries from the list.\n- `SINGLE_SELECT` : The user can select a single entry from the list."}},"type":"object"},"aws-native:quicksight:AnalysisDefaultFreeFormLayoutConfiguration":{"properties":{"canvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisFreeFormLayoutCanvasSizeOptions","description":"Determines the screen canvas size options for a free-form layout."}},"type":"object","required":["canvasSizeOptions"]},"aws-native:quicksight:AnalysisDefaultGridLayoutConfiguration":{"properties":{"canvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisGridLayoutCanvasSizeOptions","description":"Determines the screen canvas size options for a grid layout."}},"type":"object","required":["canvasSizeOptions"]},"aws-native:quicksight:AnalysisDefaultInteractiveLayoutConfiguration":{"properties":{"freeForm":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultFreeFormLayoutConfiguration","description":"The options that determine the default settings of a free-form layout configuration."},"grid":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultGridLayoutConfiguration","description":"The options that determine the default settings for a grid layout configuration."}},"type":"object"},"aws-native:quicksight:AnalysisDefaultNewSheetConfiguration":{"properties":{"interactiveLayoutConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultInteractiveLayoutConfiguration","description":"The options that determine the default settings for interactive layout configuration."},"paginatedLayoutConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultPaginatedLayoutConfiguration","description":"The options that determine the default settings for a paginated layout configuration."},"sheetContentType":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetContentType","description":"The option that determines the sheet content type."}},"type":"object"},"aws-native:quicksight:AnalysisDefaultPaginatedLayoutConfiguration":{"properties":{"sectionBased":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultSectionBasedLayoutConfiguration","description":"The options that determine the default settings for a section-based layout configuration."}},"type":"object"},"aws-native:quicksight:AnalysisDefaultRelativeDateTimeControlOptions":{"properties":{"commitMode":{"$ref":"#/types/aws-native:quicksight:AnalysisCommitMode","description":"The visibility configuration of the Apply button on a `RelativeDateTimeControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisRelativeDateTimeControlDisplayOptions","description":"The display options of a control."}},"type":"object"},"aws-native:quicksight:AnalysisDefaultSectionBasedLayoutConfiguration":{"properties":{"canvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSectionBasedLayoutCanvasSizeOptions","description":"Determines the screen canvas size options for a section-based layout."}},"type":"object","required":["canvasSizeOptions"]},"aws-native:quicksight:AnalysisDefaultSliderControlOptions":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSliderControlDisplayOptions","description":"The display options of a control."},"maximumValue":{"type":"number","description":"The larger value that is displayed at the right of the slider."},"minimumValue":{"type":"number","description":"The smaller value that is displayed at the left of the slider."},"stepSize":{"type":"number","description":"The number of increments that the slider bar is divided into."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlSliderType","description":"The type of the `DefaultSliderControlOptions` . Choose one of the following options:\n\n- `SINGLE_POINT` : Filter against(equals) a single data point.\n- `RANGE` : Filter data that is in a specified range."}},"type":"object","required":["maximumValue","minimumValue","stepSize"]},"aws-native:quicksight:AnalysisDefaultTextAreaControlOptions":{"properties":{"delimiter":{"type":"string","description":"The delimiter that is used to separate the lines in text."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTextAreaControlDisplayOptions","description":"The display options of a control."}},"type":"object"},"aws-native:quicksight:AnalysisDefaultTextFieldControlOptions":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTextFieldControlDisplayOptions","description":"The display options of a control."}},"type":"object"},"aws-native:quicksight:AnalysisDefaults":{"properties":{"defaultNewSheetConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultNewSheetConfiguration","description":"The configuration for default new sheet settings."}},"type":"object","required":["defaultNewSheetConfiguration"]},"aws-native:quicksight:AnalysisDefinition":{"properties":{"analysisDefaults":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaults"},"calculatedFields":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisCalculatedField"},"description":"An array of calculated field definitions for the analysis."},"columnConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnConfiguration"},"description":"An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis."},"dataSetIdentifierDeclarations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDataSetIdentifierDeclaration"},"description":"An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures."},"filterGroups":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterGroup"},"description":"Filter definitions for an analysis.\n\nFor more information, see [Filtering Data in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html) in the *Amazon Quick Suite User Guide* ."},"options":{"$ref":"#/types/aws-native:quicksight:AnalysisAssetOptions","description":"An array of option definitions for an analysis."},"parameterDeclarations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterDeclaration"},"description":"An array of parameter declarations for an analysis.\n\nParameters are named variables that can transfer a value for use by an action or an object.\n\nFor more information, see [Parameters in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) in the *Amazon Quick Suite User Guide* ."},"queryExecutionOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisQueryExecutionOptions"},"sheets":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetDefinition"},"description":"An array of sheet definitions for an analysis. Each `SheetDefinition` provides detailed information about a sheet within this analysis."},"staticFiles":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisStaticFile"},"description":"The static files for the definition."}},"type":"object","required":["dataSetIdentifierDeclarations"]},"aws-native:quicksight:AnalysisDestinationParameterValueConfiguration":{"properties":{"customValuesConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomValuesConfiguration","description":"The configuration of custom values for destination parameter in `DestinationParameterValueConfiguration` ."},"selectAllValueOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSelectAllValueOptions","description":"The configuration that selects all options."},"sourceColumn":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"A column of a data set."},"sourceField":{"type":"string","description":"The source field ID of the destination parameter."},"sourceParameterName":{"type":"string","description":"The source parameter name of the destination parameter."}},"type":"object"},"aws-native:quicksight:AnalysisDigitGroupingStyle":{"type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"Lakhs","value":"LAKHS"}]},"aws-native:quicksight:AnalysisDimensionField":{"properties":{"categoricalDimensionField":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoricalDimensionField","description":"The dimension type field with categorical type columns."},"dateDimensionField":{"$ref":"#/types/aws-native:quicksight:AnalysisDateDimensionField","description":"The dimension type field with date type columns."},"numericalDimensionField":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericalDimensionField","description":"The dimension type field with numerical type columns."}},"type":"object"},"aws-native:quicksight:AnalysisDonutCenterOptions":{"properties":{"labelVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines the visibility of the label in a donut chart. In the Quick Sight console, this option is called `'Show total'` ."}},"type":"object"},"aws-native:quicksight:AnalysisDonutOptions":{"properties":{"arcOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisArcOptions","description":"The option for define the arc of the chart shape. Valid values are as follows:\n\n- `WHOLE` - A pie chart\n- `SMALL` - A small-sized donut chart\n- `MEDIUM` - A medium-sized donut chart\n- `LARGE` - A large-sized donut chart"},"donutCenterOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDonutCenterOptions","description":"The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts."}},"type":"object"},"aws-native:quicksight:AnalysisDrillDownFilter":{"properties":{"categoryFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoryDrillDownFilter","description":"The category type drill down filter. This filter is used for string type columns."},"numericEqualityFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericEqualityDrillDownFilter","description":"The numeric equality type drill down filter. This filter is used for number type columns."},"timeRangeFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeRangeDrillDownFilter","description":"The time range drill down filter. This filter is used for date time columns."}},"type":"object"},"aws-native:quicksight:AnalysisDropDownControlDisplayOptions":{"properties":{"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisListControlSelectAllOptions","description":"The configuration of the `Select all` options in a dropdown control."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:AnalysisDynamicDefaultValue":{"properties":{"defaultValueColumn":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that contains the default value of each user or group."},"groupNameColumn":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that contains the group name."},"userNameColumn":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that contains the username."}},"type":"object","required":["defaultValueColumn"]},"aws-native:quicksight:AnalysisEmptyVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"dataSetIdentifier":{"type":"string","description":"The data set that is used in the empty visual. Every visual requires a dataset to render."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["dataSetIdentifier","visualId"]},"aws-native:quicksight:AnalysisEntity":{"properties":{"path":{"type":"string","description":"The hierarchical path of the entity within the analysis, template, or dashboard definition tree."}},"type":"object"},"aws-native:quicksight:AnalysisError":{"description":"\u003cp\u003eAnalysis error.\u003c/p\u003e","properties":{"message":{"type":"string","description":"\u003cp\u003eThe message associated with the analysis error.\u003c/p\u003e"},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisErrorType","description":"The type of the analysis error."},"violatedEntities":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisEntity"},"description":"\u003cp\u003eLists the violated entities that caused the analysis error\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:AnalysisErrorType":{"type":"string","enum":[{"name":"AccessDenied","value":"ACCESS_DENIED"},{"name":"SourceNotFound","value":"SOURCE_NOT_FOUND"},{"name":"DataSetNotFound","value":"DATA_SET_NOT_FOUND"},{"name":"InternalFailure","value":"INTERNAL_FAILURE"},{"name":"ParameterValueIncompatible","value":"PARAMETER_VALUE_INCOMPATIBLE"},{"name":"ParameterTypeInvalid","value":"PARAMETER_TYPE_INVALID"},{"name":"ParameterNotFound","value":"PARAMETER_NOT_FOUND"},{"name":"ColumnTypeMismatch","value":"COLUMN_TYPE_MISMATCH"},{"name":"ColumnGeographicRoleMismatch","value":"COLUMN_GEOGRAPHIC_ROLE_MISMATCH"},{"name":"ColumnReplacementMissing","value":"COLUMN_REPLACEMENT_MISSING"}]},"aws-native:quicksight:AnalysisExcludePeriodConfiguration":{"properties":{"amount":{"type":"number","description":"The amount or number of the exclude period."},"granularity":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeGranularity","description":"The granularity or unit (day, month, year) of the exclude period."},"status":{"$ref":"#/types/aws-native:quicksight:AnalysisWidgetStatus","description":"The status of the exclude period. Choose from the following options:\n\n- `ENABLED`\n- `DISABLED`"}},"type":"object","required":["amount","granularity"]},"aws-native:quicksight:AnalysisExplicitHierarchy":{"properties":{"columns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier"},"description":"The list of columns that define the explicit hierarchy."},"drillDownFilters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDrillDownFilter"},"description":"The option that determines the drill down filters for the explicit hierarchy."},"hierarchyId":{"type":"string","description":"The hierarchy ID of the explicit hierarchy."}},"type":"object","required":["columns","hierarchyId"]},"aws-native:quicksight:AnalysisFieldBasedTooltip":{"properties":{"aggregationVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of `Show aggregations` ."},"tooltipFields":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipItem"},"description":"The fields configuration in the tooltip."},"tooltipTitleType":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipTitleType","description":"The type for the \u003etooltip title. Choose one of the following options:\n\n- `NONE` : Doesn't use the primary value as the title.\n- `PRIMARY_VALUE` : Uses primary value as the title."}},"type":"object"},"aws-native:quicksight:AnalysisFieldLabelType":{"properties":{"fieldId":{"type":"string","description":"Indicates the field that is targeted by the field label."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the field label."}},"type":"object"},"aws-native:quicksight:AnalysisFieldSeriesItem":{"properties":{"axisBinding":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisBinding","description":"The axis that you are binding the field to."},"fieldId":{"type":"string","description":"The field ID of the field for which you are setting the axis binding."},"settings":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartSeriesSettings","description":"The options that determine the presentation of line series associated to the field."}},"type":"object","required":["axisBinding","fieldId"]},"aws-native:quicksight:AnalysisFieldSort":{"properties":{"direction":{"$ref":"#/types/aws-native:quicksight:AnalysisSortDirection","description":"The sort direction. Choose one of the following options:\n\n- `ASC` : Ascending\n- `DESC` : Descending"},"fieldId":{"type":"string","description":"The sort configuration target field."}},"type":"object","required":["direction","fieldId"]},"aws-native:quicksight:AnalysisFieldSortOptions":{"properties":{"columnSort":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnSort","description":"The sort configuration for a column that is not used in a field well."},"fieldSort":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSort","description":"The sort configuration for a field in a field well."}},"type":"object"},"aws-native:quicksight:AnalysisFieldTooltipItem":{"properties":{"fieldId":{"type":"string","description":"The unique ID of the field that is targeted by the tooltip."},"label":{"type":"string","description":"The label of the tooltip item."},"tooltipTarget":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipTarget","description":"Determines the target of the field tooltip item in a combo chart visual."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the tooltip item."}},"type":"object","required":["fieldId"]},"aws-native:quicksight:AnalysisFilledMapAggregatedFieldWells":{"properties":{"geospatial":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The aggregated location field well of the filled map. Values are grouped by location fields."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The aggregated color field well of a filled map. Values are aggregated based on location fields."}},"type":"object"},"aws-native:quicksight:AnalysisFilledMapConditionalFormatting":{"properties":{"conditionalFormattingOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFilledMapConditionalFormattingOption"},"description":"Conditional formatting options of a `FilledMapVisual` ."}},"type":"object","required":["conditionalFormattingOptions"]},"aws-native:quicksight:AnalysisFilledMapConditionalFormattingOption":{"properties":{"shape":{"$ref":"#/types/aws-native:quicksight:AnalysisFilledMapShapeConditionalFormatting","description":"The conditional formatting that determines the shape of the filled map."}},"type":"object","required":["shape"]},"aws-native:quicksight:AnalysisFilledMapConfiguration":{"properties":{"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisFilledMapFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions","description":"The legend display setup of the visual."},"mapStyleOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialMapStyleOptions","description":"The map style options of the filled map visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFilledMapSortConfiguration","description":"The sort configuration of a `FilledMapVisual` ."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The tooltip display setup of the visual."},"windowOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialWindowOptions","description":"The window options of the filled map visual."}},"type":"object"},"aws-native:quicksight:AnalysisFilledMapFieldWells":{"properties":{"filledMapAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisFilledMapAggregatedFieldWells","description":"The aggregated field well of the filled map."}},"type":"object"},"aws-native:quicksight:AnalysisFilledMapShapeConditionalFormatting":{"properties":{"fieldId":{"type":"string","description":"The field ID of the filled map shape."},"format":{"$ref":"#/types/aws-native:quicksight:AnalysisShapeConditionalFormat","description":"The conditional formatting that determines the background color of a filled map's shape."}},"type":"object","required":["fieldId"]},"aws-native:quicksight:AnalysisFilledMapSortConfiguration":{"properties":{"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of the location fields."}},"type":"object"},"aws-native:quicksight:AnalysisFilledMapVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFilledMapConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"conditionalFormatting":{"$ref":"#/types/aws-native:quicksight:AnalysisFilledMapConditionalFormatting","description":"The conditional formatting of a `FilledMapVisual` ."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisFilter":{"properties":{"categoryFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoryFilter","description":"A `CategoryFilter` filters text values.\n\nFor more information, see [Adding text filters](https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) in the *Amazon Quick Suite User Guide* ."},"nestedFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisNestedFilter","description":"A `NestedFilter` filters data with a subset of data that is defined by the nested inner filter."},"numericEqualityFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericEqualityFilter","description":"A `NumericEqualityFilter` filters numeric values that equal or do not equal a given numeric value."},"numericRangeFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericRangeFilter","description":"A `NumericRangeFilter` filters numeric values that are either inside or outside a given numeric range."},"relativeDatesFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisRelativeDatesFilter","description":"A `RelativeDatesFilter` filters date values that are relative to a given date."},"timeEqualityFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeEqualityFilter","description":"A `TimeEqualityFilter` filters date-time values that equal or do not equal a given date/time value."},"timeRangeFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeRangeFilter","description":"A `TimeRangeFilter` filters date-time values that are either inside or outside a given date/time range."},"topBottomFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisTopBottomFilter","description":"A `TopBottomFilter` filters data to the top or bottom values for a given column."}},"type":"object"},"aws-native:quicksight:AnalysisFilterControl":{"properties":{"crossSheet":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterCrossSheetControl","description":"A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet"},"dateTimePicker":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterDateTimePickerControl","description":"A control from a date filter that is used to specify date and time."},"dropdown":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterDropDownControl","description":"A control to display a dropdown list with buttons that are used to select a single value."},"list":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterListControl","description":"A control to display a list of buttons or boxes. This is used to select either a single value or multiple values."},"relativeDateTime":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterRelativeDateTimeControl","description":"A control from a date filter that is used to specify the relative date."},"slider":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterSliderControl","description":"A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle."},"textArea":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterTextAreaControl","description":"A control to display a text box that is used to enter multiple entries."},"textField":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterTextFieldControl","description":"A control to display a text box that is used to enter a single entry."}},"type":"object"},"aws-native:quicksight:AnalysisFilterCrossSheetControl":{"properties":{"cascadingControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisCascadingControlConfiguration","description":"The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls."},"filterControlId":{"type":"string","description":"The ID of the `FilterCrossSheetControl` ."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterCrossSheetControl` ."}},"type":"object","required":["filterControlId","sourceFilterId"]},"aws-native:quicksight:AnalysisFilterDateTimePickerControl":{"properties":{"commitMode":{"$ref":"#/types/aws-native:quicksight:AnalysisCommitMode","description":"The visibility configurationof the Apply button on a `DateTimePickerControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDateTimePickerControlDisplayOptions","description":"The display options of a control."},"filterControlId":{"type":"string","description":"The ID of the `FilterDateTimePickerControl` ."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterDateTimePickerControl` ."},"title":{"type":"string","description":"The title of the `FilterDateTimePickerControl` ."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlDateTimePickerType","description":"The type of the `FilterDropDownControl` . Choose one of the following options:\n\n- `MULTI_SELECT` : The user can select multiple entries from a dropdown menu.\n- `SINGLE_SELECT` : The user can select a single entry from a dropdown menu."}},"type":"object","required":["filterControlId","sourceFilterId","title"]},"aws-native:quicksight:AnalysisFilterDropDownControl":{"properties":{"cascadingControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisCascadingControlConfiguration","description":"The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls."},"commitMode":{"$ref":"#/types/aws-native:quicksight:AnalysisCommitMode","description":"The visibility configuration of the Apply button on a `FilterDropDownControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDropDownControlDisplayOptions","description":"The display options of the `FilterDropDownControl` ."},"filterControlId":{"type":"string","description":"The ID of the `FilterDropDownControl` ."},"selectableValues":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterSelectableValues","description":"A list of selectable values that are used in a control."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterDropDownControl` ."},"title":{"type":"string","description":"The title of the `FilterDropDownControl` ."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlListType","description":"The type of the `FilterDropDownControl` . Choose one of the following options:\n\n- `MULTI_SELECT` : The user can select multiple entries from a dropdown menu.\n- `SINGLE_SELECT` : The user can select a single entry from a dropdown menu."}},"type":"object","required":["filterControlId","sourceFilterId","title"]},"aws-native:quicksight:AnalysisFilterGroup":{"properties":{"crossDataset":{"$ref":"#/types/aws-native:quicksight:AnalysisCrossDatasetTypes","description":"The filter new feature which can apply filter group to all data sets. Choose one of the following options:\n\n- `ALL_DATASETS`\n- `SINGLE_DATASET`"},"filterGroupId":{"type":"string","description":"The value that uniquely identifies a `FilterGroup` within a dashboard, template, or analysis."},"filters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFilter"},"description":"The list of filters that are present in a `FilterGroup` ."},"scopeConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterScopeConfiguration","description":"The configuration that specifies what scope to apply to a `FilterGroup` .\n\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined."},"status":{"$ref":"#/types/aws-native:quicksight:AnalysisWidgetStatus","description":"The status of the `FilterGroup` ."}},"type":"object","required":["crossDataset","filterGroupId","filters","scopeConfiguration"]},"aws-native:quicksight:AnalysisFilterListConfiguration":{"properties":{"categoryValues":{"type":"array","items":{"type":"string"},"description":"The list of category values for the filter."},"matchOperator":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoryFilterMatchOperator","description":"The match operator that is used to determine if a filter should be applied."},"nullOption":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoryFilterSelectAllOptions","description":"Select all of the values. Null is not the assigned value of select all.\n\n- `FILTER_ALL_VALUES`"}},"type":"object","required":["matchOperator"]},"aws-native:quicksight:AnalysisFilterListControl":{"properties":{"cascadingControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisCascadingControlConfiguration","description":"The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisListControlDisplayOptions","description":"The display options of a control."},"filterControlId":{"type":"string","description":"The ID of the `FilterListControl` ."},"selectableValues":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterSelectableValues","description":"A list of selectable values that are used in a control."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterListControl` ."},"title":{"type":"string","description":"The title of the `FilterListControl` ."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlListType","description":"The type of the `FilterListControl` . Choose one of the following options:\n\n- `MULTI_SELECT` : The user can select multiple entries from the list.\n- `SINGLE_SELECT` : The user can select a single entry from the list."}},"type":"object","required":["filterControlId","sourceFilterId","title"]},"aws-native:quicksight:AnalysisFilterNullOption":{"type":"string","enum":[{"name":"AllValues","value":"ALL_VALUES"},{"name":"NullsOnly","value":"NULLS_ONLY"},{"name":"NonNullsOnly","value":"NON_NULLS_ONLY"}]},"aws-native:quicksight:AnalysisFilterOperationSelectedFieldsConfiguration":{"properties":{"selectedColumns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier"},"description":"\u003cp\u003eThe selected columns of a dataset.\u003c/p\u003e"},"selectedFieldOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSelectedFieldOptions","description":"A structure that contains the options that choose which fields are filtered in the `CustomActionFilterOperation` .\n\nValid values are defined as follows:\n\n- `ALL_FIELDS` : Applies the filter operation to all fields."},"selectedFields":{"type":"array","items":{"type":"string"},"description":"Chooses the fields that are filtered in `CustomActionFilterOperation` ."}},"type":"object"},"aws-native:quicksight:AnalysisFilterOperationTargetVisualsConfiguration":{"properties":{"sameSheetTargetVisualConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisSameSheetTargetVisualConfiguration","description":"The configuration of the same-sheet target visuals that you want to be filtered."}},"type":"object"},"aws-native:quicksight:AnalysisFilterRelativeDateTimeControl":{"properties":{"commitMode":{"$ref":"#/types/aws-native:quicksight:AnalysisCommitMode","description":"The visibility configuration of the Apply button on a `FilterRelativeDateTimeControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisRelativeDateTimeControlDisplayOptions","description":"The display options of a control."},"filterControlId":{"type":"string","description":"The ID of the `FilterTextAreaControl` ."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterTextAreaControl` ."},"title":{"type":"string","description":"The title of the `FilterTextAreaControl` ."}},"type":"object","required":["filterControlId","sourceFilterId","title"]},"aws-native:quicksight:AnalysisFilterScopeConfiguration":{"properties":{"allSheets":{"$ref":"#/types/aws-native:quicksight:AnalysisAllSheetsFilterScopeConfiguration","description":"The configuration that applies a filter to all sheets. When you choose `AllSheets` as the value for a `FilterScopeConfiguration` , this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The `AllSheetsFilterScopeConfiguration` is chosen."},"selectedSheets":{"$ref":"#/types/aws-native:quicksight:AnalysisSelectedSheetsFilterScopeConfiguration","description":"The configuration for applying a filter to specific sheets."}},"type":"object"},"aws-native:quicksight:AnalysisFilterSelectableValues":{"properties":{"values":{"type":"array","items":{"type":"string"},"description":"The values that are used in the `FilterSelectableValues` ."}},"type":"object"},"aws-native:quicksight:AnalysisFilterSliderControl":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSliderControlDisplayOptions","description":"The display options of a control."},"filterControlId":{"type":"string","description":"The ID of the `FilterSliderControl` ."},"maximumValue":{"type":"number","description":"The larger value that is displayed at the right of the slider."},"minimumValue":{"type":"number","description":"The smaller value that is displayed at the left of the slider."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterSliderControl` ."},"stepSize":{"type":"number","description":"The number of increments that the slider bar is divided into."},"title":{"type":"string","description":"The title of the `FilterSliderControl` ."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlSliderType","description":"The type of the `FilterSliderControl` . Choose one of the following options:\n\n- `SINGLE_POINT` : Filter against(equals) a single data point.\n- `RANGE` : Filter data that is in a specified range."}},"type":"object","required":["filterControlId","maximumValue","minimumValue","sourceFilterId","stepSize","title"]},"aws-native:quicksight:AnalysisFilterTextAreaControl":{"properties":{"delimiter":{"type":"string","description":"The delimiter that is used to separate the lines in text."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTextAreaControlDisplayOptions","description":"The display options of a control."},"filterControlId":{"type":"string","description":"The ID of the `FilterTextAreaControl` ."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterTextAreaControl` ."},"title":{"type":"string","description":"The title of the `FilterTextAreaControl` ."}},"type":"object","required":["filterControlId","sourceFilterId","title"]},"aws-native:quicksight:AnalysisFilterTextFieldControl":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTextFieldControlDisplayOptions","description":"The display options of a control."},"filterControlId":{"type":"string","description":"The ID of the `FilterTextFieldControl` ."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterTextFieldControl` ."},"title":{"type":"string","description":"The title of the `FilterTextFieldControl` ."}},"type":"object","required":["filterControlId","sourceFilterId","title"]},"aws-native:quicksight:AnalysisFilterVisualScope":{"type":"string","enum":[{"name":"AllVisuals","value":"ALL_VISUALS"},{"name":"SelectedVisuals","value":"SELECTED_VISUALS"}]},"aws-native:quicksight:AnalysisFontConfiguration":{"properties":{"fontColor":{"type":"string","description":"Determines the color of the text."},"fontDecoration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontDecoration","description":"Determines the appearance of decorative lines on the text."},"fontFamily":{"type":"string","description":"The font family that you want to use."},"fontSize":{"$ref":"#/types/aws-native:quicksight:AnalysisFontSize","description":"The option that determines the text display size."},"fontStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisFontStyle","description":"Determines the text display face that is inherited by the given font family."},"fontWeight":{"$ref":"#/types/aws-native:quicksight:AnalysisFontWeight","description":"The option that determines the text display weight, or boldness."}},"type":"object"},"aws-native:quicksight:AnalysisFontDecoration":{"type":"string","enum":[{"name":"Underline","value":"UNDERLINE"},{"name":"None","value":"NONE"}]},"aws-native:quicksight:AnalysisFontSize":{"properties":{"absolute":{"type":"string","description":"String based length that is composed of value and unit in px"},"relative":{"$ref":"#/types/aws-native:quicksight:AnalysisRelativeFontSize","description":"The lexical name for the text size, proportional to its surrounding context."}},"type":"object"},"aws-native:quicksight:AnalysisFontStyle":{"type":"string","enum":[{"name":"Normal","value":"NORMAL"},{"name":"Italic","value":"ITALIC"}]},"aws-native:quicksight:AnalysisFontWeight":{"properties":{"name":{"$ref":"#/types/aws-native:quicksight:AnalysisFontWeightName","description":"The lexical name for the level of boldness of the text display."}},"type":"object"},"aws-native:quicksight:AnalysisFontWeightName":{"type":"string","enum":[{"name":"Normal","value":"NORMAL"},{"name":"Bold","value":"BOLD"}]},"aws-native:quicksight:AnalysisForecastComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"customSeasonalityValue":{"type":"number","description":"The custom seasonality value setup of a forecast computation."},"lowerBoundary":{"type":"number","description":"The lower boundary setup of a forecast computation."},"name":{"type":"string","description":"The name of a computation."},"periodsBackward":{"type":"number","description":"The periods backward setup of a forecast computation."},"periodsForward":{"type":"number","description":"The periods forward setup of a forecast computation."},"predictionInterval":{"type":"number","description":"The prediction interval setup of a forecast computation."},"seasonality":{"$ref":"#/types/aws-native:quicksight:AnalysisForecastComputationSeasonality","description":"The seasonality setup of a forecast computation. Choose one of the following options:\n\n- `AUTOMATIC`\n- `CUSTOM` : Checks the custom seasonality value."},"time":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField","description":"The time field that is used in a computation."},"upperBoundary":{"type":"number","description":"The upper boundary setup of a forecast computation."},"value":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:AnalysisForecastComputationSeasonality":{"type":"string","enum":[{"name":"Automatic","value":"AUTOMATIC"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:quicksight:AnalysisForecastConfiguration":{"properties":{"forecastProperties":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeBasedForecastProperties","description":"The forecast properties setup of a forecast in the line chart."},"scenario":{"$ref":"#/types/aws-native:quicksight:AnalysisForecastScenario","description":"The forecast scenario of a forecast in the line chart."}},"type":"object"},"aws-native:quicksight:AnalysisForecastScenario":{"properties":{"whatIfPointScenario":{"$ref":"#/types/aws-native:quicksight:AnalysisWhatIfPointScenario","description":"The what-if analysis forecast setup with the target date."},"whatIfRangeScenario":{"$ref":"#/types/aws-native:quicksight:AnalysisWhatIfRangeScenario","description":"The what-if analysis forecast setup with the date range."}},"type":"object"},"aws-native:quicksight:AnalysisFormatConfiguration":{"properties":{"dateTimeFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDateTimeFormatConfiguration","description":"Formatting configuration for `DateTime` fields."},"numberFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNumberFormatConfiguration","description":"Formatting configuration for number fields."},"stringFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisStringFormatConfiguration","description":"Formatting configuration for string fields."}},"type":"object"},"aws-native:quicksight:AnalysisFreeFormLayoutCanvasSizeOptions":{"properties":{"screenCanvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisFreeFormLayoutScreenCanvasSizeOptions","description":"The options that determine the sizing of the canvas used in a free-form layout."}},"type":"object"},"aws-native:quicksight:AnalysisFreeFormLayoutConfiguration":{"properties":{"canvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisFreeFormLayoutCanvasSizeOptions"},"elements":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFreeFormLayoutElement"},"description":"The elements that are included in a free-form layout."}},"type":"object","required":["elements"]},"aws-native:quicksight:AnalysisFreeFormLayoutElement":{"properties":{"backgroundStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisFreeFormLayoutElementBackgroundStyle","description":"The background style configuration of a free-form layout element."},"borderStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisFreeFormLayoutElementBorderStyle","description":"The border style configuration of a free-form layout element."},"elementId":{"type":"string","description":"A unique identifier for an element within a free-form layout."},"elementType":{"$ref":"#/types/aws-native:quicksight:AnalysisLayoutElementType","description":"The type of element."},"height":{"type":"string","description":"String based length that is composed of value and unit in px"},"loadingAnimation":{"$ref":"#/types/aws-native:quicksight:AnalysisLoadingAnimation","description":"The loading animation configuration of a free-form layout element."},"renderingRules":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetElementRenderingRule"},"description":"The rendering rules that determine when an element should be displayed within a free-form layout."},"selectedBorderStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisFreeFormLayoutElementBorderStyle","description":"The border style configuration of a free-form layout element. This border style is used when the element is selected."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of an element within a free-form layout."},"width":{"type":"string","description":"String based length that is composed of value and unit in px"},"xAxisLocation":{"type":"string","description":"String based length that is composed of value and unit in px"},"yAxisLocation":{"type":"string","description":"String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value"}},"type":"object","required":["elementId","elementType","height","width","xAxisLocation","yAxisLocation"]},"aws-native:quicksight:AnalysisFreeFormLayoutElementBackgroundStyle":{"properties":{"color":{"type":"string","description":"The background color of a free-form layout element."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The background visibility of a free-form layout element."}},"type":"object"},"aws-native:quicksight:AnalysisFreeFormLayoutElementBorderStyle":{"properties":{"color":{"type":"string","description":"The border color of a free-form layout element."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The border visibility of a free-form layout element."}},"type":"object"},"aws-native:quicksight:AnalysisFreeFormLayoutScreenCanvasSizeOptions":{"properties":{"optimizedViewPortWidth":{"type":"string","description":"String based length that is composed of value and unit in px"}},"type":"object","required":["optimizedViewPortWidth"]},"aws-native:quicksight:AnalysisFreeFormSectionLayoutConfiguration":{"properties":{"elements":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFreeFormLayoutElement"},"description":"The elements that are included in the free-form layout."}},"type":"object","required":["elements"]},"aws-native:quicksight:AnalysisFunnelChartAggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The category field wells of a funnel chart. Values are grouped by category fields."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The value field wells of a funnel chart. Values are aggregated based on categories."}},"type":"object"},"aws-native:quicksight:AnalysisFunnelChartConfiguration":{"properties":{"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options of the categories that are displayed in a `FunnelChartVisual` ."},"dataLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisFunnelChartDataLabelOptions","description":"The options that determine the presentation of the data labels."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisFunnelChartFieldWells","description":"The field well configuration of a `FunnelChartVisual` ."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFunnelChartSortConfiguration","description":"The sort configuration of a `FunnelChartVisual` ."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The tooltip configuration of a `FunnelChartVisual` ."},"valueLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options for the values that are displayed in a `FunnelChartVisual` ."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualPalette","description":"The visual palette configuration of a `FunnelChartVisual` ."}},"type":"object"},"aws-native:quicksight:AnalysisFunnelChartDataLabelOptions":{"properties":{"categoryLabelVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the category labels within the data labels."},"labelColor":{"type":"string","description":"The color of the data label text."},"labelFontConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontConfiguration","description":"The font configuration for the data labels.\n\nOnly the `FontSize` attribute of the font configuration is used for data labels."},"measureDataLabelStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisFunnelChartMeasureDataLabelStyle","description":"Determines the style of the metric labels."},"measureLabelVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the measure labels within the data labels."},"position":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelPosition","description":"Determines the positioning of the data label relative to a section of the funnel."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility option that determines if data labels are displayed."}},"type":"object"},"aws-native:quicksight:AnalysisFunnelChartFieldWells":{"properties":{"funnelChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisFunnelChartAggregatedFieldWells","description":"The field well configuration of a `FunnelChartVisual` ."}},"type":"object"},"aws-native:quicksight:AnalysisFunnelChartMeasureDataLabelStyle":{"type":"string","enum":[{"name":"ValueOnly","value":"VALUE_ONLY"},{"name":"PercentageByFirstStage","value":"PERCENTAGE_BY_FIRST_STAGE"},{"name":"PercentageByPreviousStage","value":"PERCENTAGE_BY_PREVIOUS_STAGE"},{"name":"ValueAndPercentageByFirstStage","value":"VALUE_AND_PERCENTAGE_BY_FIRST_STAGE"},{"name":"ValueAndPercentageByPreviousStage","value":"VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE"}]},"aws-native:quicksight:AnalysisFunnelChartSortConfiguration":{"properties":{"categoryItemsLimit":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of categories displayed."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of the category fields."}},"type":"object"},"aws-native:quicksight:AnalysisFunnelChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFunnelChartConfiguration","description":"The configuration of a `FunnelChartVisual` ."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisGaugeChartArcConditionalFormatting":{"properties":{"foregroundColor":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingColor","description":"The conditional formatting of the arc foreground color."}},"type":"object"},"aws-native:quicksight:AnalysisGaugeChartColorConfiguration":{"properties":{"backgroundColor":{"type":"string","description":"The background color configuration of a `GaugeChartVisual` ."},"foregroundColor":{"type":"string","description":"The foreground color configuration of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:AnalysisGaugeChartConditionalFormatting":{"properties":{"conditionalFormattingOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisGaugeChartConditionalFormattingOption"},"description":"Conditional formatting options of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:AnalysisGaugeChartConditionalFormattingOption":{"properties":{"arc":{"$ref":"#/types/aws-native:quicksight:AnalysisGaugeChartArcConditionalFormatting","description":"The options that determine the presentation of the arc of a `GaugeChartVisual` ."},"primaryValue":{"$ref":"#/types/aws-native:quicksight:AnalysisGaugeChartPrimaryValueConditionalFormatting","description":"The conditional formatting for the primary value of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:AnalysisGaugeChartConfiguration":{"properties":{"colorConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisGaugeChartColorConfiguration","description":"The color configuration of a `GaugeChartVisual` ."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOptions","description":"The data label configuration of a `GaugeChartVisual` ."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisGaugeChartFieldWells","description":"The field well configuration of a `GaugeChartVisual` ."},"gaugeChartOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisGaugeChartOptions","description":"The options that determine the presentation of the `GaugeChartVisual` ."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"tooltipOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The tooltip configuration of a `GaugeChartVisual` ."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualPalette","description":"The visual palette configuration of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:AnalysisGaugeChartFieldWells":{"properties":{"targetValues":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The target value field wells of a `GaugeChartVisual` ."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The value field wells of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:AnalysisGaugeChartOptions":{"properties":{"arc":{"$ref":"#/types/aws-native:quicksight:AnalysisArcConfiguration","description":"The arc configuration of a `GaugeChartVisual` ."},"arcAxis":{"$ref":"#/types/aws-native:quicksight:AnalysisArcAxisConfiguration","description":"The arc axis configuration of a `GaugeChartVisual` ."},"comparison":{"$ref":"#/types/aws-native:quicksight:AnalysisComparisonConfiguration","description":"The comparison configuration of a `GaugeChartVisual` ."},"primaryValueDisplayType":{"$ref":"#/types/aws-native:quicksight:AnalysisPrimaryValueDisplayType","description":"The options that determine the primary value display type."},"primaryValueFontConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontConfiguration","description":"The options that determine the primary value font configuration."}},"type":"object"},"aws-native:quicksight:AnalysisGaugeChartPrimaryValueConditionalFormatting":{"properties":{"icon":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingIcon","description":"The conditional formatting of the primary value icon."},"textColor":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingColor","description":"The conditional formatting of the primary value text color."}},"type":"object"},"aws-native:quicksight:AnalysisGaugeChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisGaugeChartConfiguration","description":"The configuration of a `GaugeChartVisual` ."},"conditionalFormatting":{"$ref":"#/types/aws-native:quicksight:AnalysisGaugeChartConditionalFormatting","description":"The conditional formatting of a `GaugeChartVisual` ."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisGeospatialCategoricalColor":{"properties":{"categoryDataColors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialCategoricalDataColor"},"description":"A list of categorical data colors for each category."},"defaultOpacity":{"type":"number","description":"The default opacity of a categorical color."},"nullDataSettings":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialNullDataSettings","description":"The null data visualization settings."},"nullDataVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The state of visibility for null data."}},"type":"object","required":["categoryDataColors"]},"aws-native:quicksight:AnalysisGeospatialCategoricalDataColor":{"properties":{"color":{"type":"string","description":"The color and opacity values for the category data color."},"dataValue":{"type":"string","description":"The data value for the category data color."}},"type":"object","required":["color","dataValue"]},"aws-native:quicksight:AnalysisGeospatialCircleRadius":{"properties":{"radius":{"type":"number","description":"The positive value for the radius of a circle."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialCircleSymbolStyle":{"properties":{"circleRadius":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialCircleRadius","description":"The radius of the circle."},"fillColor":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialColor","description":"The color and opacity values for the fill color."},"strokeColor":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialColor","description":"The color and opacity values for the stroke color."},"strokeWidth":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialLineWidth","description":"The width of the stroke (border)."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialColor":{"properties":{"categorical":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialCategoricalColor","description":"The visualization properties for the categorical color."},"gradient":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialGradientColor","description":"The visualization properties for the gradient color."},"solid":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialSolidColor","description":"The visualization properties for the solid color."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialColorState":{"description":"Defines view state of the color","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:AnalysisGeospatialCoordinateBounds":{"properties":{"east":{"type":"number","description":"The longitude of the east bound of the geospatial coordinate bounds."},"north":{"type":"number","description":"The latitude of the north bound of the geospatial coordinate bounds."},"south":{"type":"number","description":"The latitude of the south bound of the geospatial coordinate bounds."},"west":{"type":"number","description":"The longitude of the west bound of the geospatial coordinate bounds."}},"type":"object","required":["east","north","south","west"]},"aws-native:quicksight:AnalysisGeospatialDataSourceItem":{"properties":{"staticFileDataSource":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialStaticFileSource","description":"The static file data source properties for the geospatial data."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialGradientColor":{"properties":{"defaultOpacity":{"type":"number","description":"The default opacity for the gradient color."},"nullDataSettings":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialNullDataSettings","description":"The null data visualization settings."},"nullDataVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The state of visibility for null data."},"stepColors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialGradientStepColor"},"description":"A list of gradient step colors for the gradient."}},"type":"object","required":["stepColors"]},"aws-native:quicksight:AnalysisGeospatialGradientStepColor":{"properties":{"color":{"type":"string","description":"The color and opacity values for the gradient step color."},"dataValue":{"type":"number","description":"The data value for the gradient step color."}},"type":"object","required":["color","dataValue"]},"aws-native:quicksight:AnalysisGeospatialHeatmapColorScale":{"properties":{"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialHeatmapDataColor"},"description":"The list of colors to be used in heatmap point style."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialHeatmapConfiguration":{"properties":{"heatmapColor":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialHeatmapColorScale","description":"The color scale specification for the heatmap point style."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialHeatmapDataColor":{"properties":{"color":{"type":"string","description":"The hex color to be used in the heatmap point style."}},"type":"object","required":["color"]},"aws-native:quicksight:AnalysisGeospatialLayerColorField":{"properties":{"colorDimensionsFields":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"A list of color dimension fields."},"colorValuesFields":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"A list of color measure fields."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialLayerDefinition":{"properties":{"lineLayer":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialLineLayer","description":"The definition for a line layer."},"pointLayer":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialPointLayer","description":"The definition for a point layer."},"polygonLayer":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialPolygonLayer","description":"The definition for a polygon layer."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialLayerItem":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisLayerCustomAction"},"description":"A list of custom actions for a layer."},"dataSource":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialDataSourceItem","description":"The data source for the layer."},"joinDefinition":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialLayerJoinDefinition","description":"The join definition properties for a layer."},"label":{"type":"string","description":"The label that is displayed for the layer."},"layerDefinition":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialLayerDefinition","description":"The definition properties for a layer."},"layerId":{"type":"string","description":"The ID of the layer."},"layerType":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialLayerType","description":"The layer type."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions"},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The state of visibility for the layer."}},"type":"object","required":["layerId"]},"aws-native:quicksight:AnalysisGeospatialLayerJoinDefinition":{"properties":{"colorField":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialLayerColorField","description":"The geospatial color field for the join definition."},"datasetKeyField":{"$ref":"#/types/aws-native:quicksight:AnalysisUnaggregatedField"},"shapeKeyField":{"type":"string","description":"The name of the field or property in the geospatial data source."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialLayerMapConfiguration":{"properties":{"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions"},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions"},"mapLayers":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialLayerItem"},"description":"The geospatial layers to visualize on the map."},"mapState":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialMapState","description":"The map state properties for the map."},"mapStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialMapStyle","description":"The map style properties for the map."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialLayerType":{"type":"string","enum":[{"name":"Point","value":"POINT"},{"name":"Line","value":"LINE"},{"name":"Polygon","value":"POLYGON"}]},"aws-native:quicksight:AnalysisGeospatialLineLayer":{"properties":{"style":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialLineStyle","description":"The visualization style for a line layer."}},"type":"object","required":["style"]},"aws-native:quicksight:AnalysisGeospatialLineStyle":{"properties":{"lineSymbolStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialLineSymbolStyle","description":"The symbol style for a line style."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialLineSymbolStyle":{"properties":{"fillColor":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialColor","description":"The color and opacity values for the fill color."},"lineWidth":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialLineWidth","description":"The width value for a line."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialLineWidth":{"properties":{"lineWidth":{"type":"number","description":"The positive value for the width of a line."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialMapAggregatedFieldWells":{"properties":{"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The color field wells of a geospatial map."},"geospatial":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The geospatial field wells of a geospatial map. Values are grouped by geospatial fields."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The size field wells of a geospatial map. Values are aggregated based on geospatial fields."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialMapConfiguration":{"properties":{"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialMapFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions","description":"The legend display setup of the visual."},"mapStyleOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialMapStyleOptions","description":"The map style options of the geospatial map."},"pointStyleOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialPointStyleOptions","description":"The point style options of the geospatial map."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The tooltip display setup of the visual."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualPalette"},"windowOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialWindowOptions","description":"The window options of the geospatial map."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialMapFieldWells":{"properties":{"geospatialMapAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialMapAggregatedFieldWells","description":"The aggregated field well for a geospatial map."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialMapNavigation":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:AnalysisGeospatialMapState":{"properties":{"bounds":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialCoordinateBounds"},"mapNavigation":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialMapNavigation","description":"Enables or disables map navigation for a map."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialMapStyle":{"properties":{"backgroundColor":{"type":"string","description":"The background color and opacity values for a map."},"baseMapStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisBaseMapStyleType","description":"The selected base map style."},"baseMapVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The state of visibility for the base map."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialMapStyleOptions":{"properties":{"baseMapStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisBaseMapStyleType","description":"The base map style of the geospatial map."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialMapVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialMapConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisGeospatialNullDataSettings":{"properties":{"symbolStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialNullSymbolStyle","description":"The symbol style for null data."}},"type":"object","required":["symbolStyle"]},"aws-native:quicksight:AnalysisGeospatialNullSymbolStyle":{"properties":{"fillColor":{"type":"string","description":"The color and opacity values for the fill color."},"strokeColor":{"type":"string","description":"The color and opacity values for the stroke color."},"strokeWidth":{"type":"number","description":"The width of the border stroke."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialPointLayer":{"properties":{"style":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialPointStyle","description":"The visualization style for a point layer."}},"type":"object","required":["style"]},"aws-native:quicksight:AnalysisGeospatialPointStyle":{"properties":{"circleSymbolStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialCircleSymbolStyle","description":"The circle symbol style for a point layer."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialPointStyleOptions":{"properties":{"clusterMarkerConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisClusterMarkerConfiguration","description":"The cluster marker configuration of the geospatial point style."},"heatmapConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialHeatmapConfiguration","description":"The heatmap configuration of the geospatial point style."},"selectedPointStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialSelectedPointStyle","description":"The selected point styles (point, cluster) of the geospatial map."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialPolygonLayer":{"properties":{"style":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialPolygonStyle","description":"The visualization style for a polygon layer."}},"type":"object","required":["style"]},"aws-native:quicksight:AnalysisGeospatialPolygonStyle":{"properties":{"polygonSymbolStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialPolygonSymbolStyle","description":"The polygon symbol style for a polygon layer."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialPolygonSymbolStyle":{"properties":{"fillColor":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialColor","description":"The color and opacity values for the fill color."},"strokeColor":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialColor","description":"The color and opacity values for the stroke color."},"strokeWidth":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialLineWidth","description":"The width of the border stroke."}},"type":"object"},"aws-native:quicksight:AnalysisGeospatialSelectedPointStyle":{"type":"string","enum":[{"name":"Point","value":"POINT"},{"name":"Cluster","value":"CLUSTER"},{"name":"Heatmap","value":"HEATMAP"}]},"aws-native:quicksight:AnalysisGeospatialSolidColor":{"description":"Describes the properties for a solid color","properties":{"color":{"type":"string","description":"The color and opacity values for the color."},"state":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialColorState","description":"Enables and disables the view state of the color."}},"type":"object","required":["color"]},"aws-native:quicksight:AnalysisGeospatialStaticFileSource":{"properties":{"staticFileId":{"type":"string","description":"The ID of the static file."}},"type":"object","required":["staticFileId"]},"aws-native:quicksight:AnalysisGeospatialWindowOptions":{"properties":{"bounds":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialCoordinateBounds","description":"The bounds options (north, south, west, east) of the geospatial window options."},"mapZoomMode":{"$ref":"#/types/aws-native:quicksight:AnalysisMapZoomMode","description":"The map zoom modes (manual, auto) of the geospatial window options."}},"type":"object"},"aws-native:quicksight:AnalysisGlobalTableBorderOptions":{"properties":{"sideSpecificBorder":{"$ref":"#/types/aws-native:quicksight:AnalysisTableSideBorderOptions","description":"Determines the options for side specific border."},"uniformBorder":{"$ref":"#/types/aws-native:quicksight:AnalysisTableBorderOptions","description":"Determines the options for uniform border."}},"type":"object"},"aws-native:quicksight:AnalysisGradientColor":{"properties":{"stops":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisGradientStop"},"description":"The list of gradient color stops."}},"type":"object"},"aws-native:quicksight:AnalysisGradientStop":{"properties":{"color":{"type":"string","description":"Determines the color."},"dataValue":{"type":"number","description":"Determines the data value."},"gradientOffset":{"type":"number","description":"Determines gradient offset value."}},"type":"object","required":["gradientOffset"]},"aws-native:quicksight:AnalysisGridLayoutCanvasSizeOptions":{"properties":{"screenCanvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisGridLayoutScreenCanvasSizeOptions","description":"The options that determine the sizing of the canvas used in a grid layout."}},"type":"object"},"aws-native:quicksight:AnalysisGridLayoutConfiguration":{"properties":{"canvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisGridLayoutCanvasSizeOptions"},"elements":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisGridLayoutElement"},"description":"The elements that are included in a grid layout."}},"type":"object","required":["elements"]},"aws-native:quicksight:AnalysisGridLayoutElement":{"properties":{"columnIndex":{"type":"number","description":"The column index for the upper left corner of an element."},"columnSpan":{"type":"number","description":"The width of a grid element expressed as a number of grid columns."},"elementId":{"type":"string","description":"A unique identifier for an element within a grid layout."},"elementType":{"$ref":"#/types/aws-native:quicksight:AnalysisLayoutElementType","description":"The type of element."},"rowIndex":{"type":"number","description":"The row index for the upper left corner of an element."},"rowSpan":{"type":"number","description":"The height of a grid element expressed as a number of grid rows."}},"type":"object","required":["columnSpan","elementId","elementType","rowSpan"]},"aws-native:quicksight:AnalysisGridLayoutScreenCanvasSizeOptions":{"properties":{"optimizedViewPortWidth":{"type":"string","description":"String based length that is composed of value and unit in px"},"resizeOption":{"$ref":"#/types/aws-native:quicksight:AnalysisResizeOption","description":"This value determines the layout behavior when the viewport is resized.\n\n- `FIXED` : A fixed width will be used when optimizing the layout. In the Quick Sight console, this option is called `Classic` .\n- `RESPONSIVE` : The width of the canvas will be responsive and optimized to the view port. In the Quick Sight console, this option is called `Tiled` ."}},"type":"object","required":["resizeOption"]},"aws-native:quicksight:AnalysisGrowthRateComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."},"periodSize":{"type":"number","description":"The period size setup of a growth rate computation."},"time":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField","description":"The time field that is used in a computation."},"value":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:AnalysisHeaderFooterSectionConfiguration":{"properties":{"layout":{"$ref":"#/types/aws-native:quicksight:AnalysisSectionLayoutConfiguration","description":"The layout configuration of the header or footer section."},"sectionId":{"type":"string","description":"The unique identifier of the header or footer section."},"style":{"$ref":"#/types/aws-native:quicksight:AnalysisSectionStyle","description":"The style options of a header or footer section."}},"type":"object","required":["layout","sectionId"]},"aws-native:quicksight:AnalysisHeatMapAggregatedFieldWells":{"properties":{"columns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The columns field well of a heat map."},"rows":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The rows field well of a heat map."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The values field well of a heat map."}},"type":"object"},"aws-native:quicksight:AnalysisHeatMapConfiguration":{"properties":{"colorScale":{"$ref":"#/types/aws-native:quicksight:AnalysisColorScale","description":"The color options (gradient color, point of divergence) in a heat map."},"columnLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options of the column that is displayed in a heat map."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOptions","description":"The options that determine if visual data labels are displayed."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisHeatMapFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions","description":"The legend display setup of the visual."},"rowLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options of the row that is displayed in a `heat map` ."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisHeatMapSortConfiguration","description":"The sort configuration of a heat map."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The tooltip display setup of the visual."}},"type":"object"},"aws-native:quicksight:AnalysisHeatMapFieldWells":{"properties":{"heatMapAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisHeatMapAggregatedFieldWells","description":"The aggregated field wells of a heat map."}},"type":"object"},"aws-native:quicksight:AnalysisHeatMapSortConfiguration":{"properties":{"heatMapColumnItemsLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of columns that are displayed in a heat map."},"heatMapColumnSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The column sort configuration for heat map for columns that aren't a part of a field well."},"heatMapRowItemsLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of rows that are displayed in a heat map."},"heatMapRowSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The field sort configuration of the rows fields."}},"type":"object"},"aws-native:quicksight:AnalysisHeatMapVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisHeatMapConfiguration","description":"The configuration of a heat map."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisHistogramAggregatedFieldWells":{"properties":{"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The value field wells of a histogram. Values are aggregated by `COUNT` or `DISTINCT_COUNT` ."}},"type":"object"},"aws-native:quicksight:AnalysisHistogramBinOptions":{"properties":{"binCount":{"$ref":"#/types/aws-native:quicksight:AnalysisBinCountOptions","description":"The options that determine the bin count of a histogram."},"binWidth":{"$ref":"#/types/aws-native:quicksight:AnalysisBinWidthOptions","description":"The options that determine the bin width of a histogram."},"selectedBinType":{"$ref":"#/types/aws-native:quicksight:AnalysisHistogramBinType","description":"The options that determine the selected bin type."},"startValue":{"type":"number","description":"The options that determine the bin start value."}},"type":"object"},"aws-native:quicksight:AnalysisHistogramBinType":{"type":"string","enum":[{"name":"BinCount","value":"BIN_COUNT"},{"name":"BinWidth","value":"BIN_WIDTH"}]},"aws-native:quicksight:AnalysisHistogramConfiguration":{"properties":{"binOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisHistogramBinOptions","description":"The options that determine the presentation of histogram bins."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOptions","description":"The data label configuration of a histogram."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisHistogramFieldWells","description":"The field well configuration of a histogram."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The tooltip configuration of a histogram."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualPalette","description":"The visual palette configuration of a histogram."},"xAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The options that determine the presentation of the x-axis."},"xAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The options that determine the presentation of the x-axis label."},"yAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The options that determine the presentation of the y-axis."}},"type":"object"},"aws-native:quicksight:AnalysisHistogramFieldWells":{"properties":{"histogramAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisHistogramAggregatedFieldWells","description":"The field well configuration of a histogram."}},"type":"object"},"aws-native:quicksight:AnalysisHistogramVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisHistogramConfiguration","description":"The configuration for a `HistogramVisual` ."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisHorizontalTextAlignment":{"type":"string","enum":[{"name":"Left","value":"LEFT"},{"name":"Center","value":"CENTER"},{"name":"Right","value":"RIGHT"},{"name":"Auto","value":"AUTO"}]},"aws-native:quicksight:AnalysisIcon":{"type":"string","enum":[{"name":"CaretUp","value":"CARET_UP"},{"name":"CaretDown","value":"CARET_DOWN"},{"name":"Plus","value":"PLUS"},{"name":"Minus","value":"MINUS"},{"name":"ArrowUp","value":"ARROW_UP"},{"name":"ArrowDown","value":"ARROW_DOWN"},{"name":"ArrowLeft","value":"ARROW_LEFT"},{"name":"ArrowUpLeft","value":"ARROW_UP_LEFT"},{"name":"ArrowDownLeft","value":"ARROW_DOWN_LEFT"},{"name":"ArrowRight","value":"ARROW_RIGHT"},{"name":"ArrowUpRight","value":"ARROW_UP_RIGHT"},{"name":"ArrowDownRight","value":"ARROW_DOWN_RIGHT"},{"name":"FaceUp","value":"FACE_UP"},{"name":"FaceDown","value":"FACE_DOWN"},{"name":"FaceFlat","value":"FACE_FLAT"},{"name":"OneBar","value":"ONE_BAR"},{"name":"TwoBar","value":"TWO_BAR"},{"name":"ThreeBar","value":"THREE_BAR"},{"name":"Circle","value":"CIRCLE"},{"name":"Triangle","value":"TRIANGLE"},{"name":"Square","value":"SQUARE"},{"name":"Flag","value":"FLAG"},{"name":"ThumbsUp","value":"THUMBS_UP"},{"name":"ThumbsDown","value":"THUMBS_DOWN"},{"name":"Checkmark","value":"CHECKMARK"},{"name":"X","value":"X"}]},"aws-native:quicksight:AnalysisImageCustomAction":{"properties":{"actionOperations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisImageCustomActionOperation"},"description":"A list of `ImageCustomActionOperations` .\n\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined."},"customActionId":{"type":"string","description":"The ID of the custom action."},"name":{"type":"string","description":"The name of the custom action."},"status":{"$ref":"#/types/aws-native:quicksight:AnalysisWidgetStatus","description":"The status of the custom action."},"trigger":{"$ref":"#/types/aws-native:quicksight:AnalysisImageCustomActionTrigger","description":"The trigger of the `VisualCustomAction` .\n\nValid values are defined as follows:\n\n- `CLICK` : Initiates a custom action by a left pointer click on a data point.\n- `MENU` : Initiates a custom action by right pointer click from the menu."}},"type":"object","required":["actionOperations","customActionId","name","trigger"]},"aws-native:quicksight:AnalysisImageCustomActionOperation":{"properties":{"navigationOperation":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomActionNavigationOperation"},"setParametersOperation":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomActionSetParametersOperation"},"urlOperation":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomActionUrlOperation"}},"type":"object"},"aws-native:quicksight:AnalysisImageCustomActionTrigger":{"type":"string","enum":[{"name":"Click","value":"CLICK"},{"name":"Menu","value":"MENU"}]},"aws-native:quicksight:AnalysisImageInteractionOptions":{"properties":{"imageMenuOption":{"$ref":"#/types/aws-native:quicksight:AnalysisImageMenuOption","description":"The menu options for the image."}},"type":"object"},"aws-native:quicksight:AnalysisImageMenuOption":{"properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:AnalysisDashboardBehavior","description":"The availability status of the image menu. If the value of this property is set to `ENABLED` , dashboard readers can interact with the image menu."}},"type":"object"},"aws-native:quicksight:AnalysisImageStaticFile":{"properties":{"source":{"$ref":"#/types/aws-native:quicksight:AnalysisStaticFileSource","description":"The source of the image static file."},"staticFileId":{"type":"string","description":"The ID of the static file that contains an image."}},"type":"object","required":["staticFileId"]},"aws-native:quicksight:AnalysisInnerFilter":{"properties":{"categoryInnerFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoryInnerFilter","description":"A `CategoryInnerFilter` filters text values for the `NestedFilter` ."}},"type":"object"},"aws-native:quicksight:AnalysisInsightConfiguration":{"properties":{"computations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisComputation"},"description":"The computations configurations of the insight visual"},"customNarrative":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomNarrativeOptions","description":"The custom narrative of the insight visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."}},"type":"object"},"aws-native:quicksight:AnalysisInsightVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"dataSetIdentifier":{"type":"string","description":"The dataset that is used in the insight visual."},"insightConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisInsightConfiguration","description":"The configuration of an insight visual."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["dataSetIdentifier","visualId"]},"aws-native:quicksight:AnalysisIntegerDefaultValues":{"properties":{"dynamicValue":{"$ref":"#/types/aws-native:quicksight:AnalysisDynamicDefaultValue","description":"The dynamic value of the `IntegerDefaultValues` . Different defaults are displayed according to users, groups, and values mapping."},"staticValues":{"type":"array","items":{"type":"number"},"description":"The static values of the `IntegerDefaultValues` ."}},"type":"object"},"aws-native:quicksight:AnalysisIntegerParameter":{"description":"\u003cp\u003eAn integer parameter.\u003c/p\u003e","properties":{"name":{"type":"string","description":"\u003cp\u003eThe name of the integer parameter.\u003c/p\u003e"},"values":{"type":"array","items":{"type":"number"},"description":"\u003cp\u003eThe values for the integer parameter.\u003c/p\u003e"}},"type":"object","required":["name","values"]},"aws-native:quicksight:AnalysisIntegerParameterDeclaration":{"properties":{"defaultValues":{"$ref":"#/types/aws-native:quicksight:AnalysisIntegerDefaultValues","description":"The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided."},"mappedDataSetParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMappedDataSetParameter"}},"name":{"type":"string","description":"The name of the parameter that is being declared."},"parameterValueType":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterValueType","description":"The value type determines whether the parameter is a single-value or multi-value parameter."},"valueWhenUnset":{"$ref":"#/types/aws-native:quicksight:AnalysisIntegerValueWhenUnsetConfiguration","description":"A parameter declaration for the `Integer` data type."}},"type":"object","required":["name","parameterValueType"]},"aws-native:quicksight:AnalysisIntegerValueWhenUnsetConfiguration":{"properties":{"customValue":{"type":"number","description":"A custom value that's used when the value of a parameter isn't set."},"valueWhenUnsetOption":{"$ref":"#/types/aws-native:quicksight:AnalysisValueWhenUnsetOption","description":"The built-in options for default values. The value can be one of the following:\n\n- `RECOMMENDED` : The recommended value.\n- `NULL` : The `NULL` value."}},"type":"object"},"aws-native:quicksight:AnalysisItemsLimitConfiguration":{"properties":{"itemsLimit":{"type":"number","description":"The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart."},"otherCategories":{"$ref":"#/types/aws-native:quicksight:AnalysisOtherCategories","description":"The `Show other` of an axis in the chart. Choose one of the following options:\n\n- `INCLUDE`\n- `EXCLUDE`"}},"type":"object"},"aws-native:quicksight:AnalysisKpiActualValueConditionalFormatting":{"properties":{"icon":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingIcon","description":"The conditional formatting of the actual value's icon."},"textColor":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingColor","description":"The conditional formatting of the actual value's text color."}},"type":"object"},"aws-native:quicksight:AnalysisKpiComparisonValueConditionalFormatting":{"properties":{"icon":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingIcon","description":"The conditional formatting of the comparison value's icon."},"textColor":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingColor","description":"The conditional formatting of the comparison value's text color."}},"type":"object"},"aws-native:quicksight:AnalysisKpiConditionalFormatting":{"properties":{"conditionalFormattingOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiConditionalFormattingOption"},"description":"The conditional formatting options of a KPI visual."}},"type":"object"},"aws-native:quicksight:AnalysisKpiConditionalFormattingOption":{"properties":{"actualValue":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiActualValueConditionalFormatting","description":"The conditional formatting for the actual value of a KPI visual."},"comparisonValue":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiComparisonValueConditionalFormatting","description":"The conditional formatting for the comparison value of a KPI visual."},"primaryValue":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiPrimaryValueConditionalFormatting","description":"The conditional formatting for the primary value of a KPI visual."},"progressBar":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiProgressBarConditionalFormatting","description":"The conditional formatting for the progress bar of a KPI visual."}},"type":"object"},"aws-native:quicksight:AnalysisKpiConfiguration":{"properties":{"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiFieldWells","description":"The field well configuration of a KPI visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"kpiOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiOptions","description":"The options that determine the presentation of a KPI visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiSortConfiguration","description":"The sort configuration of a KPI visual."}},"type":"object"},"aws-native:quicksight:AnalysisKpiFieldWells":{"properties":{"targetValues":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The target value field wells of a KPI visual."},"trendGroups":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The trend group field wells of a KPI visual."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The value field wells of a KPI visual."}},"type":"object"},"aws-native:quicksight:AnalysisKpiOptions":{"properties":{"comparison":{"$ref":"#/types/aws-native:quicksight:AnalysisComparisonConfiguration","description":"The comparison configuration of a KPI visual."},"primaryValueDisplayType":{"$ref":"#/types/aws-native:quicksight:AnalysisPrimaryValueDisplayType","description":"The options that determine the primary value display type."},"primaryValueFontConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontConfiguration","description":"The options that determine the primary value font configuration."},"progressBar":{"$ref":"#/types/aws-native:quicksight:AnalysisProgressBarOptions","description":"The options that determine the presentation of the progress bar of a KPI visual."},"secondaryValue":{"$ref":"#/types/aws-native:quicksight:AnalysisSecondaryValueOptions","description":"The options that determine the presentation of the secondary value of a KPI visual."},"secondaryValueFontConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontConfiguration","description":"The options that determine the secondary value font configuration."},"sparkline":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiSparklineOptions","description":"The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual."},"trendArrows":{"$ref":"#/types/aws-native:quicksight:AnalysisTrendArrowOptions","description":"The options that determine the presentation of trend arrows in a KPI visual."},"visualLayoutOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiVisualLayoutOptions","description":"The options that determine the layout a KPI visual."}},"type":"object"},"aws-native:quicksight:AnalysisKpiPrimaryValueConditionalFormatting":{"properties":{"icon":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingIcon","description":"The conditional formatting of the primary value's icon."},"textColor":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingColor","description":"The conditional formatting of the primary value's text color."}},"type":"object"},"aws-native:quicksight:AnalysisKpiProgressBarConditionalFormatting":{"properties":{"foregroundColor":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingColor","description":"The conditional formatting of the progress bar's foreground color."}},"type":"object"},"aws-native:quicksight:AnalysisKpiSortConfiguration":{"properties":{"trendGroupSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of the trend group fields."}},"type":"object"},"aws-native:quicksight:AnalysisKpiSparklineOptions":{"properties":{"color":{"type":"string","description":"The color of the sparkline."},"tooltipVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The tooltip visibility of the sparkline."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiSparklineType","description":"The type of the sparkline."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the sparkline."}},"type":"object","required":["type"]},"aws-native:quicksight:AnalysisKpiSparklineType":{"type":"string","enum":[{"name":"Line","value":"LINE"},{"name":"Area","value":"AREA"}]},"aws-native:quicksight:AnalysisKpiVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiConfiguration","description":"The configuration of a KPI visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"conditionalFormatting":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiConditionalFormatting","description":"The conditional formatting of a KPI visual."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisKpiVisualLayoutOptions":{"properties":{"standardLayout":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiVisualStandardLayout","description":"The standard layout of the KPI visual."}},"type":"object"},"aws-native:quicksight:AnalysisKpiVisualStandardLayout":{"properties":{"type":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiVisualStandardLayoutType","description":"The standard layout type."}},"type":"object","required":["type"]},"aws-native:quicksight:AnalysisKpiVisualStandardLayoutType":{"type":"string","enum":[{"name":"Classic","value":"CLASSIC"},{"name":"Vertical","value":"VERTICAL"}]},"aws-native:quicksight:AnalysisLabelOptions":{"properties":{"customLabel":{"type":"string","description":"The text for the label."},"fontConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontConfiguration","description":"The font configuration of the label."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines whether or not the label is visible."}},"type":"object"},"aws-native:quicksight:AnalysisLayerCustomAction":{"properties":{"actionOperations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisLayerCustomActionOperation"},"description":"A list of `LayerCustomActionOperations` .\n\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined."},"customActionId":{"type":"string","description":"The ID of the custom action."},"name":{"type":"string","description":"The name of the custom action."},"status":{"$ref":"#/types/aws-native:quicksight:AnalysisWidgetStatus","description":"The status of the `LayerCustomAction` ."},"trigger":{"$ref":"#/types/aws-native:quicksight:AnalysisLayerCustomActionTrigger","description":"The trigger of the `LayerCustomAction` .\n\nValid values are defined as follows:\n\n- `DATA_POINT_CLICK` : Initiates a custom action by a left pointer click on a data point.\n- `DATA_POINT_MENU` : Initiates a custom action by right pointer click from the menu."}},"type":"object","required":["actionOperations","customActionId","name","trigger"]},"aws-native:quicksight:AnalysisLayerCustomActionOperation":{"properties":{"filterOperation":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomActionFilterOperation"},"navigationOperation":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomActionNavigationOperation"},"setParametersOperation":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomActionSetParametersOperation"},"urlOperation":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomActionUrlOperation"}},"type":"object"},"aws-native:quicksight:AnalysisLayerCustomActionTrigger":{"type":"string","enum":[{"name":"DataPointClick","value":"DATA_POINT_CLICK"},{"name":"DataPointMenu","value":"DATA_POINT_MENU"}]},"aws-native:quicksight:AnalysisLayerMapVisual":{"properties":{"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialLayerMapConfiguration","description":"The configuration settings of the visual."},"dataSetIdentifier":{"type":"string","description":"The dataset that is used to create the layer map visual. You can't create a visual without a dataset."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions"},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions"},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The ID of the visual."}},"type":"object","required":["dataSetIdentifier","visualId"]},"aws-native:quicksight:AnalysisLayout":{"properties":{"configuration":{"$ref":"#/types/aws-native:quicksight:AnalysisLayoutConfiguration","description":"The configuration that determines what the type of layout for a sheet."}},"type":"object","required":["configuration"]},"aws-native:quicksight:AnalysisLayoutConfiguration":{"properties":{"freeFormLayout":{"$ref":"#/types/aws-native:quicksight:AnalysisFreeFormLayoutConfiguration","description":"A free-form is optimized for a fixed width and has more control over the exact placement of layout elements."},"gridLayout":{"$ref":"#/types/aws-native:quicksight:AnalysisGridLayoutConfiguration","description":"A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: `FIXED` or `RESPONSIVE` ."},"sectionBasedLayout":{"$ref":"#/types/aws-native:quicksight:AnalysisSectionBasedLayoutConfiguration","description":"A section based layout organizes visuals into multiple sections and has customized header, footer and page break."}},"type":"object"},"aws-native:quicksight:AnalysisLayoutElementType":{"type":"string","enum":[{"name":"Visual","value":"VISUAL"},{"name":"FilterControl","value":"FILTER_CONTROL"},{"name":"ParameterControl","value":"PARAMETER_CONTROL"},{"name":"TextBox","value":"TEXT_BOX"},{"name":"Image","value":"IMAGE"}]},"aws-native:quicksight:AnalysisLegendOptions":{"properties":{"height":{"type":"string","description":"String based length that is composed of value and unit in px"},"position":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendPosition","description":"The positions for the legend. Choose one of the following options:\n\n- `AUTO`\n- `RIGHT`\n- `BOTTOM`\n- `LEFT`"},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisLabelOptions","description":"The custom title for the legend."},"valueFontConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontConfiguration"},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines whether or not the legend is visible."},"width":{"type":"string","description":"String based length that is composed of value and unit in px"}},"type":"object"},"aws-native:quicksight:AnalysisLegendPosition":{"type":"string","enum":[{"name":"Auto","value":"AUTO"},{"name":"Right","value":"RIGHT"},{"name":"Bottom","value":"BOTTOM"},{"name":"Top","value":"TOP"}]},"aws-native:quicksight:AnalysisLineChartAggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The category field wells of a line chart. Values are grouped by category fields."},"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The color field wells of a line chart. Values are grouped by category fields."},"smallMultiples":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The small multiples field well of a line chart."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The value field wells of a line chart. Values are aggregated based on categories."}},"type":"object"},"aws-native:quicksight:AnalysisLineChartConfiguration":{"properties":{"contributionAnalysisDefaults":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisContributionAnalysisDefault"},"description":"The default configuration of a line chart's contribution analysis."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOptions","description":"The data label configuration of a line chart."},"defaultSeriesSettings":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartDefaultSeriesSettings","description":"The options that determine the default presentation of all line series in `LineChartVisual` ."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartFieldWells","description":"The field well configuration of a line chart."},"forecastConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisForecastConfiguration"},"description":"The forecast configuration of a line chart."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions","description":"The legend configuration of a line chart."},"primaryYAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisLineSeriesAxisDisplayOptions","description":"The series axis configuration of a line chart."},"primaryYAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The options that determine the presentation of the y-axis label."},"referenceLines":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLine"},"description":"The reference lines configuration of a line chart."},"secondaryYAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisLineSeriesAxisDisplayOptions","description":"The series axis configuration of a line chart."},"secondaryYAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The options that determine the presentation of the secondary y-axis label."},"series":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisSeriesItem"},"description":"The series item configuration of a line chart."},"singleAxisOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSingleAxisOptions"},"smallMultiplesOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSmallMultiplesOptions","description":"The small multiples setup for the visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartSortConfiguration","description":"The sort configuration of a line chart."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The tooltip configuration of a line chart."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartType","description":"Determines the type of the line chart."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualPalette","description":"The visual palette configuration of a line chart."},"xAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The options that determine the presentation of the x-axis."},"xAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The options that determine the presentation of the x-axis label."}},"type":"object"},"aws-native:quicksight:AnalysisLineChartDefaultSeriesSettings":{"properties":{"axisBinding":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisBinding","description":"The axis to which you are binding all line series to."},"lineStyleSettings":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartLineStyleSettings","description":"Line styles options for all line series in the visual."},"markerStyleSettings":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartMarkerStyleSettings","description":"Marker styles options for all line series in the visual."}},"type":"object"},"aws-native:quicksight:AnalysisLineChartFieldWells":{"properties":{"lineChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartAggregatedFieldWells","description":"The field well configuration of a line chart."}},"type":"object"},"aws-native:quicksight:AnalysisLineChartLineStyle":{"type":"string","enum":[{"name":"Solid","value":"SOLID"},{"name":"Dotted","value":"DOTTED"},{"name":"Dashed","value":"DASHED"}]},"aws-native:quicksight:AnalysisLineChartLineStyleSettings":{"properties":{"lineInterpolation":{"$ref":"#/types/aws-native:quicksight:AnalysisLineInterpolation","description":"Interpolation style for line series.\n\n- `LINEAR` : Show as default, linear style.\n- `SMOOTH` : Show as a smooth curve.\n- `STEPPED` : Show steps in line."},"lineStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartLineStyle","description":"Line style for line series.\n\n- `SOLID` : Show as a solid line.\n- `DOTTED` : Show as a dotted line.\n- `DASHED` : Show as a dashed line."},"lineVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Configuration option that determines whether to show the line for the series."},"lineWidth":{"type":"string","description":"String based length that is composed of value and unit in px"}},"type":"object"},"aws-native:quicksight:AnalysisLineChartMarkerShape":{"type":"string","enum":[{"name":"Circle","value":"CIRCLE"},{"name":"Triangle","value":"TRIANGLE"},{"name":"Square","value":"SQUARE"},{"name":"Diamond","value":"DIAMOND"},{"name":"RoundedSquare","value":"ROUNDED_SQUARE"}]},"aws-native:quicksight:AnalysisLineChartMarkerStyleSettings":{"properties":{"markerColor":{"type":"string","description":"Color of marker in the series."},"markerShape":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartMarkerShape","description":"Shape option for markers in the series.\n\n- `CIRCLE` : Show marker as a circle.\n- `TRIANGLE` : Show marker as a triangle.\n- `SQUARE` : Show marker as a square.\n- `DIAMOND` : Show marker as a diamond.\n- `ROUNDED_SQUARE` : Show marker as a rounded square."},"markerSize":{"type":"string","description":"String based length that is composed of value and unit in px"},"markerVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Configuration option that determines whether to show the markers in the series."}},"type":"object"},"aws-native:quicksight:AnalysisLineChartSeriesSettings":{"properties":{"lineStyleSettings":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartLineStyleSettings","description":"Line styles options for a line series in `LineChartVisual` ."},"markerStyleSettings":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartMarkerStyleSettings","description":"Marker styles options for a line series in `LineChartVisual` ."}},"type":"object"},"aws-native:quicksight:AnalysisLineChartSortConfiguration":{"properties":{"categoryItemsLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of categories that are displayed in a line chart."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of the category fields."},"colorItemsLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of lines that are displayed in a line chart."},"smallMultiplesLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of small multiples panels that are displayed."},"smallMultiplesSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of the small multiples field."}},"type":"object"},"aws-native:quicksight:AnalysisLineChartType":{"type":"string","enum":[{"name":"Line","value":"LINE"},{"name":"Area","value":"AREA"},{"name":"StackedArea","value":"STACKED_AREA"}]},"aws-native:quicksight:AnalysisLineChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartConfiguration","description":"The configuration of a line chart."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisLineInterpolation":{"type":"string","enum":[{"name":"Linear","value":"LINEAR"},{"name":"Smooth","value":"SMOOTH"},{"name":"Stepped","value":"STEPPED"}]},"aws-native:quicksight:AnalysisLineSeriesAxisDisplayOptions":{"properties":{"axisOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The options that determine the presentation of the line series axis."},"missingDataConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMissingDataConfiguration"},"description":"The configuration options that determine how missing data is treated during the rendering of a line chart."}},"type":"object"},"aws-native:quicksight:AnalysisListControlDisplayOptions":{"properties":{"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"searchOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisListControlSearchOptions","description":"The configuration of the search options in a list control."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisListControlSelectAllOptions","description":"The configuration of the `Select all` options in a list control."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:AnalysisListControlSearchOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility configuration of the search options in a list control."}},"type":"object"},"aws-native:quicksight:AnalysisListControlSelectAllOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility configuration of the `Select all` options in a list control."}},"type":"object"},"aws-native:quicksight:AnalysisLoadingAnimation":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility configuration of `LoadingAnimation` ."}},"type":"object"},"aws-native:quicksight:AnalysisLocalNavigationConfiguration":{"properties":{"targetSheetId":{"type":"string","description":"The sheet that is targeted for navigation in the same analysis."}},"type":"object","required":["targetSheetId"]},"aws-native:quicksight:AnalysisLongFormatText":{"properties":{"plainText":{"type":"string","description":"Plain text format."},"richText":{"type":"string","description":"Rich text. Examples of rich text include bold, underline, and italics."}},"type":"object"},"aws-native:quicksight:AnalysisMapZoomMode":{"type":"string","enum":[{"name":"Auto","value":"AUTO"},{"name":"Manual","value":"MANUAL"}]},"aws-native:quicksight:AnalysisMappedDataSetParameter":{"properties":{"dataSetIdentifier":{"type":"string","description":"A unique name that identifies a dataset within the analysis or dashboard."},"dataSetParameterName":{"type":"string","description":"The name of the dataset parameter."}},"type":"object","required":["dataSetIdentifier","dataSetParameterName"]},"aws-native:quicksight:AnalysisMaximumLabelType":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the maximum label."}},"type":"object"},"aws-native:quicksight:AnalysisMaximumMinimumComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."},"time":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField","description":"The time field that is used in a computation."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisMaximumMinimumComputationType","description":"The type of computation. Choose one of the following options:\n\n- MAXIMUM: A maximum computation.\n- MINIMUM: A minimum computation."},"value":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId","type"]},"aws-native:quicksight:AnalysisMaximumMinimumComputationType":{"type":"string","enum":[{"name":"Maximum","value":"MAXIMUM"},{"name":"Minimum","value":"MINIMUM"}]},"aws-native:quicksight:AnalysisMeasureField":{"properties":{"calculatedMeasureField":{"$ref":"#/types/aws-native:quicksight:AnalysisCalculatedMeasureField","description":"The calculated measure field only used in pivot tables."},"categoricalMeasureField":{"$ref":"#/types/aws-native:quicksight:AnalysisCategoricalMeasureField","description":"The measure type field with categorical type columns."},"dateMeasureField":{"$ref":"#/types/aws-native:quicksight:AnalysisDateMeasureField","description":"The measure type field with date type columns."},"numericalMeasureField":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericalMeasureField","description":"The measure type field with numerical type columns."}},"type":"object"},"aws-native:quicksight:AnalysisMetricComparisonComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"fromValue":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField","description":"The field that is used in a metric comparison from value setup."},"name":{"type":"string","description":"The name of a computation."},"targetValue":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField","description":"The field that is used in a metric comparison to value setup."},"time":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField","description":"The time field that is used in a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:AnalysisMinimumLabelType":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the minimum label."}},"type":"object"},"aws-native:quicksight:AnalysisMissingDataConfiguration":{"properties":{"treatmentOption":{"$ref":"#/types/aws-native:quicksight:AnalysisMissingDataTreatmentOption","description":"The treatment option that determines how missing data should be rendered. Choose from the following options:\n\n- `INTERPOLATE` : Interpolate missing values between the prior and the next known value.\n- `SHOW_AS_ZERO` : Show missing values as the value `0` .\n- `SHOW_AS_BLANK` : Display a blank space when rendering missing data."}},"type":"object"},"aws-native:quicksight:AnalysisMissingDataTreatmentOption":{"type":"string","enum":[{"name":"Interpolate","value":"INTERPOLATE"},{"name":"ShowAsZero","value":"SHOW_AS_ZERO"},{"name":"ShowAsBlank","value":"SHOW_AS_BLANK"}]},"aws-native:quicksight:AnalysisNegativeValueConfiguration":{"properties":{"displayMode":{"$ref":"#/types/aws-native:quicksight:AnalysisNegativeValueDisplayMode","description":"Determines the display mode of the negative value configuration."}},"type":"object","required":["displayMode"]},"aws-native:quicksight:AnalysisNegativeValueDisplayMode":{"type":"string","enum":[{"name":"Positive","value":"POSITIVE"},{"name":"Negative","value":"NEGATIVE"}]},"aws-native:quicksight:AnalysisNestedFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the filter is applied to."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"includeInnerSet":{"type":"boolean","description":"A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter."},"innerFilter":{"$ref":"#/types/aws-native:quicksight:AnalysisInnerFilter","description":"The `InnerFilter` defines the subset of data to be used with the `NestedFilter` ."}},"type":"object","required":["column","filterId","includeInnerSet","innerFilter"]},"aws-native:quicksight:AnalysisNullValueFormatConfiguration":{"properties":{"nullString":{"type":"string","description":"Determines the null string of null values."}},"type":"object","required":["nullString"]},"aws-native:quicksight:AnalysisNumberDisplayFormatConfiguration":{"properties":{"decimalPlacesConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDecimalPlacesConfiguration","description":"The option that determines the decimal places configuration."},"negativeValueConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNegativeValueConfiguration","description":"The options that determine the negative value configuration."},"nullValueFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNullValueFormatConfiguration","description":"The options that determine the null value format configuration."},"numberScale":{"$ref":"#/types/aws-native:quicksight:AnalysisNumberScale","description":"Determines the number scale value of the number format."},"prefix":{"type":"string","description":"Determines the prefix value of the number format."},"separatorConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericSeparatorConfiguration","description":"The options that determine the numeric separator configuration."},"suffix":{"type":"string","description":"Determines the suffix value of the number format."}},"type":"object"},"aws-native:quicksight:AnalysisNumberFormatConfiguration":{"properties":{"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericFormatConfiguration","description":"The options that determine the numeric format configuration."}},"type":"object"},"aws-native:quicksight:AnalysisNumberScale":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Auto","value":"AUTO"},{"name":"Thousands","value":"THOUSANDS"},{"name":"Millions","value":"MILLIONS"},{"name":"Billions","value":"BILLIONS"},{"name":"Trillions","value":"TRILLIONS"},{"name":"Lakhs","value":"LAKHS"},{"name":"Crores","value":"CRORES"}]},"aws-native:quicksight:AnalysisNumericAxisOptions":{"properties":{"range":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayRange","description":"The range setup of a numeric axis."},"scale":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisScale","description":"The scale setup of a numeric axis."}},"type":"object"},"aws-native:quicksight:AnalysisNumericEqualityDrillDownFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the filter is applied to."},"value":{"type":"number","description":"The value of the double input numeric drill down filter."}},"type":"object","required":["column","value"]},"aws-native:quicksight:AnalysisNumericEqualityFilter":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisAggregationFunction","description":"The aggregation function of the filter."},"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the filter is applied to."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"matchOperator":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericEqualityMatchOperator","description":"The match operator that is used to determine if a filter should be applied."},"nullOption":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"parameterName":{"type":"string","description":"The parameter whose value should be used for the filter value."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericFilterSelectAllOptions","description":"Select all of the values. Null is not the assigned value of select all.\n\n- `FILTER_ALL_VALUES`"},"value":{"type":"number","description":"The input value."}},"type":"object","required":["column","filterId","matchOperator","nullOption"]},"aws-native:quicksight:AnalysisNumericEqualityMatchOperator":{"type":"string","enum":[{"name":"Equals","value":"EQUALS"},{"name":"DoesNotEqual","value":"DOES_NOT_EQUAL"}]},"aws-native:quicksight:AnalysisNumericFilterSelectAllOptions":{"type":"string","enum":[{"name":"FilterAllValues","value":"FILTER_ALL_VALUES"}]},"aws-native:quicksight:AnalysisNumericFormatConfiguration":{"properties":{"currencyDisplayFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisCurrencyDisplayFormatConfiguration","description":"The options that determine the currency display format configuration."},"numberDisplayFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNumberDisplayFormatConfiguration","description":"The options that determine the number display format configuration."},"percentageDisplayFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisPercentageDisplayFormatConfiguration","description":"The options that determine the percentage display format configuration."}},"type":"object"},"aws-native:quicksight:AnalysisNumericRangeFilter":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisAggregationFunction","description":"The aggregation function of the filter."},"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the filter is applied to."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"includeMaximum":{"type":"boolean","description":"Determines whether the maximum value in the filter value range should be included in the filtered results."},"includeMinimum":{"type":"boolean","description":"Determines whether the minimum value in the filter value range should be included in the filtered results."},"nullOption":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"rangeMaximum":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericRangeFilterValue","description":"The maximum value for the filter value range."},"rangeMinimum":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericRangeFilterValue","description":"The minimum value for the filter value range."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericFilterSelectAllOptions","description":"Select all of the values. Null is not the assigned value of select all.\n\n- `FILTER_ALL_VALUES`"}},"type":"object","required":["column","filterId","nullOption"]},"aws-native:quicksight:AnalysisNumericRangeFilterValue":{"properties":{"parameter":{"type":"string","description":"The parameter that is used in the numeric range."},"staticValue":{"type":"number","description":"The static value of the numeric range filter."}},"type":"object"},"aws-native:quicksight:AnalysisNumericSeparatorConfiguration":{"properties":{"decimalSeparator":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericSeparatorSymbol","description":"Determines the decimal separator."},"thousandsSeparator":{"$ref":"#/types/aws-native:quicksight:AnalysisThousandSeparatorOptions","description":"The options that determine the thousands separator configuration."}},"type":"object"},"aws-native:quicksight:AnalysisNumericSeparatorSymbol":{"type":"string","enum":[{"name":"Comma","value":"COMMA"},{"name":"Dot","value":"DOT"},{"name":"Space","value":"SPACE"}]},"aws-native:quicksight:AnalysisNumericalAggregationFunction":{"properties":{"percentileAggregation":{"$ref":"#/types/aws-native:quicksight:AnalysisPercentileAggregation","description":"An aggregation based on the percentile of values in a dimension or measure."},"simpleNumericalAggregation":{"$ref":"#/types/aws-native:quicksight:AnalysisSimpleNumericalAggregationFunction","description":"Built-in aggregation functions for numerical values.\n\n- `SUM` : The sum of a dimension or measure.\n- `AVERAGE` : The average of a dimension or measure.\n- `MIN` : The minimum value of a dimension or measure.\n- `MAX` : The maximum value of a dimension or measure.\n- `COUNT` : The count of a dimension or measure.\n- `DISTINCT_COUNT` : The count of distinct values in a dimension or measure.\n- `VAR` : The variance of a dimension or measure.\n- `VARP` : The partitioned variance of a dimension or measure.\n- `STDEV` : The standard deviation of a dimension or measure.\n- `STDEVP` : The partitioned standard deviation of a dimension or measure.\n- `MEDIAN` : The median value of a dimension or measure."}},"type":"object"},"aws-native:quicksight:AnalysisNumericalDimensionField":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that is used in the `NumericalDimensionField` ."},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNumberFormatConfiguration","description":"The format configuration of the field."},"hierarchyId":{"type":"string","description":"The custom hierarchy ID."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:AnalysisNumericalMeasureField":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericalAggregationFunction","description":"The aggregation function of the measure field."},"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that is used in the `NumericalMeasureField` ."},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNumberFormatConfiguration","description":"The format configuration of the field."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:AnalysisOtherCategories":{"type":"string","enum":[{"name":"Include","value":"INCLUDE"},{"name":"Exclude","value":"EXCLUDE"}]},"aws-native:quicksight:AnalysisPaginationConfiguration":{"properties":{"pageNumber":{"type":"number","description":"Indicates the page number."},"pageSize":{"type":"number","description":"Indicates how many items render in one page."}},"type":"object","required":["pageNumber","pageSize"]},"aws-native:quicksight:AnalysisPanelBorderStyle":{"type":"string","enum":[{"name":"Solid","value":"SOLID"},{"name":"Dashed","value":"DASHED"},{"name":"Dotted","value":"DOTTED"}]},"aws-native:quicksight:AnalysisPanelConfiguration":{"properties":{"backgroundColor":{"type":"string","description":"Sets the background color for each panel."},"backgroundVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines whether or not a background for each small multiples panel is rendered."},"borderColor":{"type":"string","description":"Sets the line color of panel borders."},"borderStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisPanelBorderStyle","description":"Sets the line style of panel borders."},"borderThickness":{"type":"string","description":"String based length that is composed of value and unit in px"},"borderVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines whether or not each panel displays a border."},"gutterSpacing":{"type":"string","description":"String based length that is composed of value and unit in px"},"gutterVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines whether or not negative space between sibling panels is rendered."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisPanelTitleOptions","description":"Configures the title display within each small multiples panel."}},"type":"object"},"aws-native:quicksight:AnalysisPanelTitleOptions":{"properties":{"fontConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontConfiguration"},"horizontalTextAlignment":{"$ref":"#/types/aws-native:quicksight:AnalysisHorizontalTextAlignment","description":"Sets the horizontal text alignment of the title within each panel."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines whether or not panel titles are displayed."}},"type":"object"},"aws-native:quicksight:AnalysisPaperOrientation":{"type":"string","enum":[{"name":"Portrait","value":"PORTRAIT"},{"name":"Landscape","value":"LANDSCAPE"}]},"aws-native:quicksight:AnalysisPaperSize":{"type":"string","enum":[{"name":"UsLetter","value":"US_LETTER"},{"name":"UsLegal","value":"US_LEGAL"},{"name":"UsTabloidLedger","value":"US_TABLOID_LEDGER"},{"name":"A0","value":"A0"},{"name":"A1","value":"A1"},{"name":"A2","value":"A2"},{"name":"A3","value":"A3"},{"name":"A4","value":"A4"},{"name":"A5","value":"A5"},{"name":"JisB4","value":"JIS_B4"},{"name":"JisB5","value":"JIS_B5"}]},"aws-native:quicksight:AnalysisParameterControl":{"properties":{"dateTimePicker":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterDateTimePickerControl","description":"A control from a date parameter that specifies date and time."},"dropdown":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterDropDownControl","description":"A control to display a dropdown list with buttons that are used to select a single value."},"list":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterListControl","description":"A control to display a list with buttons or boxes that are used to select either a single value or multiple values."},"slider":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterSliderControl","description":"A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle."},"textArea":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterTextAreaControl","description":"A control to display a text box that is used to enter multiple entries."},"textField":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterTextFieldControl","description":"A control to display a text box that is used to enter a single entry."}},"type":"object"},"aws-native:quicksight:AnalysisParameterDateTimePickerControl":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDateTimePickerControlDisplayOptions","description":"The display options of a control."},"parameterControlId":{"type":"string","description":"The ID of the `ParameterDateTimePickerControl` ."},"sourceParameterName":{"type":"string","description":"The name of the `ParameterDateTimePickerControl` ."},"title":{"type":"string","description":"The title of the `ParameterDateTimePickerControl` ."}},"type":"object","required":["parameterControlId","sourceParameterName","title"]},"aws-native:quicksight:AnalysisParameterDeclaration":{"properties":{"dateTimeParameterDeclaration":{"$ref":"#/types/aws-native:quicksight:AnalysisDateTimeParameterDeclaration","description":"A parameter declaration for the `DateTime` data type."},"decimalParameterDeclaration":{"$ref":"#/types/aws-native:quicksight:AnalysisDecimalParameterDeclaration","description":"A parameter declaration for the `Decimal` data type."},"integerParameterDeclaration":{"$ref":"#/types/aws-native:quicksight:AnalysisIntegerParameterDeclaration","description":"A parameter declaration for the `Integer` data type."},"stringParameterDeclaration":{"$ref":"#/types/aws-native:quicksight:AnalysisStringParameterDeclaration","description":"A parameter declaration for the `String` data type."}},"type":"object"},"aws-native:quicksight:AnalysisParameterDropDownControl":{"properties":{"cascadingControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisCascadingControlConfiguration","description":"The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls."},"commitMode":{"$ref":"#/types/aws-native:quicksight:AnalysisCommitMode","description":"The visibility configuration of the Apply button on a `ParameterDropDownControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDropDownControlDisplayOptions","description":"The display options of a control."},"parameterControlId":{"type":"string","description":"The ID of the `ParameterDropDownControl` ."},"selectableValues":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterSelectableValues","description":"A list of selectable values that are used in a control."},"sourceParameterName":{"type":"string","description":"The source parameter name of the `ParameterDropDownControl` ."},"title":{"type":"string","description":"The title of the `ParameterDropDownControl` ."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlListType","description":"The type parameter name of the `ParameterDropDownControl` ."}},"type":"object","required":["parameterControlId","sourceParameterName","title"]},"aws-native:quicksight:AnalysisParameterListControl":{"properties":{"cascadingControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisCascadingControlConfiguration","description":"The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisListControlDisplayOptions","description":"The display options of a control."},"parameterControlId":{"type":"string","description":"The ID of the `ParameterListControl` ."},"selectableValues":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterSelectableValues","description":"A list of selectable values that are used in a control."},"sourceParameterName":{"type":"string","description":"The source parameter name of the `ParameterListControl` ."},"title":{"type":"string","description":"The title of the `ParameterListControl` ."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlListType","description":"The type of `ParameterListControl` ."}},"type":"object","required":["parameterControlId","sourceParameterName","title"]},"aws-native:quicksight:AnalysisParameterSelectableValues":{"properties":{"linkToDataSetColumn":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column identifier that fetches values from the data set."},"values":{"type":"array","items":{"type":"string"},"description":"The values that are used in `ParameterSelectableValues` ."}},"type":"object"},"aws-native:quicksight:AnalysisParameterSliderControl":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSliderControlDisplayOptions","description":"The display options of a control."},"maximumValue":{"type":"number","description":"The larger value that is displayed at the right of the slider."},"minimumValue":{"type":"number","description":"The smaller value that is displayed at the left of the slider."},"parameterControlId":{"type":"string","description":"The ID of the `ParameterSliderControl` ."},"sourceParameterName":{"type":"string","description":"The source parameter name of the `ParameterSliderControl` ."},"stepSize":{"type":"number","description":"The number of increments that the slider bar is divided into."},"title":{"type":"string","description":"The title of the `ParameterSliderControl` ."}},"type":"object","required":["maximumValue","minimumValue","parameterControlId","sourceParameterName","stepSize","title"]},"aws-native:quicksight:AnalysisParameterTextAreaControl":{"properties":{"delimiter":{"type":"string","description":"The delimiter that is used to separate the lines in text."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTextAreaControlDisplayOptions","description":"The display options of a control."},"parameterControlId":{"type":"string","description":"The ID of the `ParameterTextAreaControl` ."},"sourceParameterName":{"type":"string","description":"The source parameter name of the `ParameterTextAreaControl` ."},"title":{"type":"string","description":"The title of the `ParameterTextAreaControl` ."}},"type":"object","required":["parameterControlId","sourceParameterName","title"]},"aws-native:quicksight:AnalysisParameterTextFieldControl":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTextFieldControlDisplayOptions","description":"The display options of a control."},"parameterControlId":{"type":"string","description":"The ID of the `ParameterTextFieldControl` ."},"sourceParameterName":{"type":"string","description":"The source parameter name of the `ParameterTextFieldControl` ."},"title":{"type":"string","description":"The title of the `ParameterTextFieldControl` ."}},"type":"object","required":["parameterControlId","sourceParameterName","title"]},"aws-native:quicksight:AnalysisParameterValueType":{"type":"string","enum":[{"name":"MultiValued","value":"MULTI_VALUED"},{"name":"SingleValued","value":"SINGLE_VALUED"}]},"aws-native:quicksight:AnalysisParameters":{"description":"\u003cp\u003eA list of Amazon QuickSight parameters and the list's override values.\u003c/p\u003e","properties":{"dateTimeParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDateTimeParameter"},"description":"\u003cp\u003eThe parameters that have a data type of date-time.\u003c/p\u003e"},"decimalParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDecimalParameter"},"description":"\u003cp\u003eThe parameters that have a data type of decimal.\u003c/p\u003e"},"integerParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisIntegerParameter"},"description":"\u003cp\u003eThe parameters that have a data type of integer.\u003c/p\u003e"},"stringParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisStringParameter"},"description":"\u003cp\u003eThe parameters that have a data type of string.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:AnalysisPercentVisibleRange":{"properties":{"from":{"type":"number","description":"The lower bound of the range."},"to":{"type":"number","description":"The top bound of the range."}},"type":"object"},"aws-native:quicksight:AnalysisPercentageDisplayFormatConfiguration":{"properties":{"decimalPlacesConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDecimalPlacesConfiguration","description":"The option that determines the decimal places configuration."},"negativeValueConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNegativeValueConfiguration","description":"The options that determine the negative value configuration."},"nullValueFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNullValueFormatConfiguration","description":"The options that determine the null value format configuration."},"prefix":{"type":"string","description":"Determines the prefix value of the percentage format."},"separatorConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericSeparatorConfiguration","description":"The options that determine the numeric separator configuration."},"suffix":{"type":"string","description":"Determines the suffix value of the percentage format."}},"type":"object"},"aws-native:quicksight:AnalysisPercentileAggregation":{"properties":{"percentileValue":{"type":"number","description":"The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure."}},"type":"object"},"aws-native:quicksight:AnalysisPeriodOverPeriodComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."},"time":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField","description":"The time field that is used in a computation."},"value":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:AnalysisPeriodToDateComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."},"periodTimeGranularity":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeGranularity","description":"The time granularity setup of period to date computation. Choose from the following options:\n\n- YEAR: Year to date.\n- MONTH: Month to date."},"time":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField","description":"The time field that is used in a computation."},"value":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:AnalysisPieChartAggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The category (group/color) field wells of a pie chart."},"smallMultiples":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The small multiples field well of a pie chart."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The value field wells of a pie chart. Values are aggregated based on categories."}},"type":"object"},"aws-native:quicksight:AnalysisPieChartConfiguration":{"properties":{"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options of the group/color that is displayed in a pie chart."},"contributionAnalysisDefaults":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisContributionAnalysisDefault"},"description":"The contribution analysis (anomaly configuration) setup of the visual."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOptions","description":"The options that determine if visual data labels are displayed."},"donutOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisDonutOptions","description":"The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisPieChartFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions","description":"The legend display setup of the visual."},"smallMultiplesOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSmallMultiplesOptions","description":"The small multiples setup for the visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisPieChartSortConfiguration","description":"The sort configuration of a pie chart."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The tooltip display setup of the visual."},"valueLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options for the value that is displayed in a pie chart."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualPalette","description":"The palette (chart color) display setup of the visual."}},"type":"object"},"aws-native:quicksight:AnalysisPieChartFieldWells":{"properties":{"pieChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisPieChartAggregatedFieldWells","description":"The field well configuration of a pie chart."}},"type":"object"},"aws-native:quicksight:AnalysisPieChartSortConfiguration":{"properties":{"categoryItemsLimit":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of categories that are displayed in a pie chart."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of the category fields."},"smallMultiplesLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of small multiples panels that are displayed."},"smallMultiplesSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of the small multiples field."}},"type":"object"},"aws-native:quicksight:AnalysisPieChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisPieChartConfiguration","description":"The configuration of a pie chart."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisPivotFieldSortOptions":{"properties":{"fieldId":{"type":"string","description":"The field ID for the field sort options."},"sortBy":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableSortBy","description":"The sort by field for the field sort options."}},"type":"object","required":["fieldId","sortBy"]},"aws-native:quicksight:AnalysisPivotTableAggregatedFieldWells":{"properties":{"columns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The columns field well for a pivot table. Values are grouped by columns fields."},"rows":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The rows field well for a pivot table. Values are grouped by rows fields."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The values field well for a pivot table. Values are aggregated based on rows and columns fields."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableCellConditionalFormatting":{"properties":{"fieldId":{"type":"string","description":"The field ID of the cell for conditional formatting."},"scope":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableConditionalFormattingScope","description":"The scope of the cell for conditional formatting."},"scopes":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableConditionalFormattingScope"},"description":"A list of cell scopes for conditional formatting."},"textFormat":{"$ref":"#/types/aws-native:quicksight:AnalysisTextConditionalFormat","description":"The text format of the cell for conditional formatting."}},"type":"object","required":["fieldId"]},"aws-native:quicksight:AnalysisPivotTableConditionalFormatting":{"properties":{"conditionalFormattingOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableConditionalFormattingOption"},"description":"Conditional formatting options for a `PivotTableVisual` ."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableConditionalFormattingOption":{"properties":{"cell":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableCellConditionalFormatting","description":"The cell conditional formatting option for a pivot table."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableConditionalFormattingScope":{"properties":{"role":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableConditionalFormattingScopeRole","description":"The role (field, field total, grand total) of the cell for conditional formatting."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableConditionalFormattingScopeRole":{"type":"string","enum":[{"name":"Field","value":"FIELD"},{"name":"FieldTotal","value":"FIELD_TOTAL"},{"name":"GrandTotal","value":"GRAND_TOTAL"}]},"aws-native:quicksight:AnalysisPivotTableConfiguration":{"properties":{"fieldOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableFieldOptions","description":"The field options for a pivot table visual."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"paginatedReportOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTablePaginatedReportOptions","description":"The paginated report options for a pivot table visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableSortConfiguration","description":"The sort configuration for a `PivotTableVisual` ."},"tableOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableOptions","description":"The table options for a pivot table visual."},"totalOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableTotalOptions","description":"The total options for a pivot table visual."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableDataPathOption":{"properties":{"dataPathList":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDataPathValue"},"description":"The list of data path values for the data path options."},"width":{"type":"string","description":"String based length that is composed of value and unit in px"}},"type":"object","required":["dataPathList"]},"aws-native:quicksight:AnalysisPivotTableDataPathType":{"type":"string","enum":[{"name":"HierarchyRowsLayoutColumn","value":"HIERARCHY_ROWS_LAYOUT_COLUMN"},{"name":"MultipleRowMetricsColumn","value":"MULTIPLE_ROW_METRICS_COLUMN"},{"name":"EmptyColumnHeader","value":"EMPTY_COLUMN_HEADER"},{"name":"CountMetricColumn","value":"COUNT_METRIC_COLUMN"}]},"aws-native:quicksight:AnalysisPivotTableFieldCollapseState":{"type":"string","enum":[{"name":"Collapsed","value":"COLLAPSED"},{"name":"Expanded","value":"EXPANDED"}]},"aws-native:quicksight:AnalysisPivotTableFieldCollapseStateOption":{"properties":{"state":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableFieldCollapseState","description":"The state of the field target of a pivot table. Choose one of the following options:\n\n- `COLLAPSED`\n- `EXPANDED`"},"target":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableFieldCollapseStateTarget","description":"A tagged-union object that sets the collapse state."}},"type":"object","required":["target"]},"aws-native:quicksight:AnalysisPivotTableFieldCollapseStateTarget":{"properties":{"fieldDataPathValues":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDataPathValue"},"description":"The data path of the pivot table's header. Used to set the collapse state."},"fieldId":{"type":"string","description":"The field ID of the pivot table that the collapse state needs to be set to."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableFieldOption":{"properties":{"customLabel":{"type":"string","description":"The custom label of the pivot table field."},"fieldId":{"type":"string","description":"The field ID of the pivot table field."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the pivot table field."}},"type":"object","required":["fieldId"]},"aws-native:quicksight:AnalysisPivotTableFieldOptions":{"properties":{"collapseStateOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableFieldCollapseStateOption"},"description":"The collapse state options for the pivot table field options."},"dataPathOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableDataPathOption"},"description":"The data path options for the pivot table field options."},"selectedFieldOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableFieldOption"},"description":"The selected field options for the pivot table field options."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableFieldSubtotalOptions":{"properties":{"fieldId":{"type":"string","description":"The field ID of the subtotal options."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableFieldWells":{"properties":{"pivotTableAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableAggregatedFieldWells","description":"The aggregated field well for the pivot table."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableMetricPlacement":{"type":"string","enum":[{"name":"Row","value":"ROW"},{"name":"Column","value":"COLUMN"}]},"aws-native:quicksight:AnalysisPivotTableOptions":{"properties":{"cellStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"The table cell style of cells."},"collapsedRowDimensionsVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is `HIDDEN` , all collapsed columns in a pivot table are automatically hidden. The default value is `VISIBLE` ."},"columnHeaderStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"The table cell style of the column header."},"columnNamesVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the column names."},"defaultCellWidth":{"type":"string","description":"String based length that is composed of value and unit in px"},"metricPlacement":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableMetricPlacement","description":"The metric placement (row, column) options."},"rowAlternateColorOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisRowAlternateColorOptions","description":"The row alternate color options (widget status, row alternate colors)."},"rowFieldNamesStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"The table cell style of row field names."},"rowHeaderStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"The table cell style of the row headers."},"rowsLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableRowsLabelOptions","description":"The options for the label that is located above the row headers. This option is only applicable when `RowsLayout` is set to `HIERARCHY` ."},"rowsLayout":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableRowsLayout","description":"The layout for the row dimension headers of a pivot table. Choose one of the following options.\n\n- `TABULAR` : (Default) Each row field is displayed in a separate column.\n- `HIERARCHY` : All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields."},"singleMetricVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the single metric options."},"toggleButtonsVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines the visibility of the pivot table."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTablePaginatedReportOptions":{"properties":{"overflowColumnHeaderVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the repeating header rows on each page."},"verticalOverflowVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the printing table overflow across pages."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableRowsLabelOptions":{"properties":{"customLabel":{"type":"string","description":"The custom label string for the rows label."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the rows label."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableRowsLayout":{"type":"string","enum":[{"name":"Tabular","value":"TABULAR"},{"name":"Hierarchy","value":"HIERARCHY"}]},"aws-native:quicksight:AnalysisPivotTableSortBy":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnSort","description":"The column sort (field id, direction) for the pivot table sort by options."},"dataPath":{"$ref":"#/types/aws-native:quicksight:AnalysisDataPathSort","description":"The data path sort (data path value, direction) for the pivot table sort by options."},"field":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSort","description":"The field sort (field id, direction) for the pivot table sort by options."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableSortConfiguration":{"properties":{"fieldSortOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotFieldSortOptions"},"description":"The field sort options for a pivot table sort configuration."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableSubtotalLevel":{"type":"string","enum":[{"name":"All","value":"ALL"},{"name":"Custom","value":"CUSTOM"},{"name":"Last","value":"LAST"}]},"aws-native:quicksight:AnalysisPivotTableTotalOptions":{"properties":{"columnSubtotalOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSubtotalOptions","description":"The column subtotal options."},"columnTotalOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTotalOptions","description":"The column total options."},"rowSubtotalOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSubtotalOptions","description":"The row subtotal options."},"rowTotalOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTotalOptions","description":"The row total options."}},"type":"object"},"aws-native:quicksight:AnalysisPivotTableVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableConfiguration","description":"The configuration settings of the visual."},"conditionalFormatting":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableConditionalFormatting","description":"The conditional formatting for a `PivotTableVisual` ."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisPivotTotalOptions":{"properties":{"customLabel":{"type":"string","description":"The custom label string for the total cells."},"metricHeaderCellStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"The cell styling options for the total of header cells."},"placement":{"$ref":"#/types/aws-native:quicksight:AnalysisTableTotalsPlacement","description":"The placement (start, end) for the total cells."},"scrollStatus":{"$ref":"#/types/aws-native:quicksight:AnalysisTableTotalsScrollStatus","description":"The scroll status (pinned, scrolled) for the total cells."},"totalAggregationOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisTotalAggregationOption"},"description":"The total aggregation options for each value field."},"totalCellStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"The cell styling options for the total cells."},"totalsVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility configuration for the total cells."},"valueCellStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"The cell styling options for the totals of value cells."}},"type":"object"},"aws-native:quicksight:AnalysisPluginVisual":{"properties":{"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisPluginVisualConfiguration","description":"A description of the plugin field wells and their persisted properties."},"pluginArn":{"type":"string","description":"The Amazon Resource Name (ARN) that reflects the plugin and version."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions"},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions"},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The ID of the visual that you want to use."}},"type":"object","required":["pluginArn","visualId"]},"aws-native:quicksight:AnalysisPluginVisualAxisName":{"type":"string","enum":[{"name":"GroupBy","value":"GROUP_BY"},{"name":"Value","value":"VALUE"}]},"aws-native:quicksight:AnalysisPluginVisualConfiguration":{"properties":{"fieldWells":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisPluginVisualFieldWell"},"description":"The field wells configuration of the plugin visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisPluginVisualSortConfiguration","description":"The sort configuration of the plugin visual."},"visualOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisPluginVisualOptions","description":"The persisted properties of the plugin visual."}},"type":"object"},"aws-native:quicksight:AnalysisPluginVisualFieldWell":{"properties":{"axisName":{"$ref":"#/types/aws-native:quicksight:AnalysisPluginVisualAxisName","description":"The semantic axis name for the field well."},"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"A list of dimensions for the field well."},"measures":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"A list of measures that exist in the field well."},"unaggregated":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisUnaggregatedField"},"description":"A list of unaggregated fields that exist in the field well."}},"type":"object"},"aws-native:quicksight:AnalysisPluginVisualItemsLimitConfiguration":{"properties":{"itemsLimit":{"type":"number","description":"Determines how many values are be fetched at once."}},"type":"object"},"aws-native:quicksight:AnalysisPluginVisualOptions":{"properties":{"visualProperties":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisPluginVisualProperty"},"description":"The persisted properties and their values."}},"type":"object"},"aws-native:quicksight:AnalysisPluginVisualProperty":{"properties":{"name":{"type":"string","description":"The name of the plugin visual property."},"value":{"type":"string","description":"The value of the plugin visual property."}},"type":"object"},"aws-native:quicksight:AnalysisPluginVisualSortConfiguration":{"properties":{"pluginVisualTableQuerySort":{"$ref":"#/types/aws-native:quicksight:AnalysisPluginVisualTableQuerySort","description":"The table query sorting options for the plugin visual."}},"type":"object"},"aws-native:quicksight:AnalysisPluginVisualTableQuerySort":{"properties":{"itemsLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisPluginVisualItemsLimitConfiguration","description":"The maximum amount of data to be returned by a query."},"rowSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"Determines how data is sorted in the response."}},"type":"object"},"aws-native:quicksight:AnalysisPredefinedHierarchy":{"properties":{"columns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier"},"description":"The list of columns that define the predefined hierarchy."},"drillDownFilters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDrillDownFilter"},"description":"The option that determines the drill down filters for the predefined hierarchy."},"hierarchyId":{"type":"string","description":"The hierarchy ID of the predefined hierarchy."}},"type":"object","required":["columns","hierarchyId"]},"aws-native:quicksight:AnalysisPrimaryValueDisplayType":{"type":"string","enum":[{"name":"Hidden","value":"HIDDEN"},{"name":"Comparison","value":"COMPARISON"},{"name":"Actual","value":"ACTUAL"}]},"aws-native:quicksight:AnalysisProgressBarOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the progress bar."}},"type":"object"},"aws-native:quicksight:AnalysisQueryExecutionMode":{"type":"string","enum":[{"name":"Auto","value":"AUTO"},{"name":"Manual","value":"MANUAL"}]},"aws-native:quicksight:AnalysisQueryExecutionOptions":{"properties":{"queryExecutionMode":{"$ref":"#/types/aws-native:quicksight:AnalysisQueryExecutionMode","description":"A structure that describes the query execution mode."}},"type":"object"},"aws-native:quicksight:AnalysisRadarChartAggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The aggregated field well categories of a radar chart."},"color":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The color that are assigned to the aggregated field wells of a radar chart."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The values that are assigned to the aggregated field wells of a radar chart."}},"type":"object"},"aws-native:quicksight:AnalysisRadarChartAreaStyleSettings":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility settings of a radar chart."}},"type":"object"},"aws-native:quicksight:AnalysisRadarChartAxesRangeScale":{"type":"string","enum":[{"name":"Auto","value":"AUTO"},{"name":"Independent","value":"INDEPENDENT"},{"name":"Shared","value":"SHARED"}]},"aws-native:quicksight:AnalysisRadarChartConfiguration":{"properties":{"alternateBandColorsVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines the visibility of the colors of alternatign bands in a radar chart."},"alternateBandEvenColor":{"type":"string","description":"The color of the even-numbered alternate bands of a radar chart."},"alternateBandOddColor":{"type":"string","description":"The color of the odd-numbered alternate bands of a radar chart."},"axesRangeScale":{"$ref":"#/types/aws-native:quicksight:AnalysisRadarChartAxesRangeScale","description":"The axis behavior options of a radar chart."},"baseSeriesSettings":{"$ref":"#/types/aws-native:quicksight:AnalysisRadarChartSeriesSettings","description":"The base sreies settings of a radar chart."},"categoryAxis":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The category axis of a radar chart."},"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The category label options of a radar chart."},"colorAxis":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The color axis of a radar chart."},"colorLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The color label options of a radar chart."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisRadarChartFieldWells","description":"The field well configuration of a `RadarChartVisual` ."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions","description":"The legend display setup of the visual."},"shape":{"$ref":"#/types/aws-native:quicksight:AnalysisRadarChartShape","description":"The shape of the radar chart."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisRadarChartSortConfiguration","description":"The sort configuration of a `RadarChartVisual` ."},"startAngle":{"type":"number","description":"The start angle of a radar chart's axis."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualPalette","description":"The palette (chart color) display setup of the visual."}},"type":"object"},"aws-native:quicksight:AnalysisRadarChartFieldWells":{"properties":{"radarChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisRadarChartAggregatedFieldWells","description":"The aggregated field wells of a radar chart visual."}},"type":"object"},"aws-native:quicksight:AnalysisRadarChartSeriesSettings":{"properties":{"areaStyleSettings":{"$ref":"#/types/aws-native:quicksight:AnalysisRadarChartAreaStyleSettings","description":"The area style settings of a radar chart."}},"type":"object"},"aws-native:quicksight:AnalysisRadarChartShape":{"type":"string","enum":[{"name":"Circle","value":"CIRCLE"},{"name":"Polygon","value":"POLYGON"}]},"aws-native:quicksight:AnalysisRadarChartSortConfiguration":{"properties":{"categoryItemsLimit":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The category items limit for a radar chart."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The category sort options of a radar chart."},"colorItemsLimit":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The color items limit of a radar chart."},"colorSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The color sort configuration of a radar chart."}},"type":"object"},"aws-native:quicksight:AnalysisRadarChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisRadarChartConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisRangeEndsLabelType":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the range ends label."}},"type":"object"},"aws-native:quicksight:AnalysisReferenceLine":{"properties":{"dataConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLineDataConfiguration","description":"The data configuration of the reference line."},"labelConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLineLabelConfiguration","description":"The label configuration of the reference line."},"status":{"$ref":"#/types/aws-native:quicksight:AnalysisWidgetStatus","description":"The status of the reference line. Choose one of the following options:\n\n- `ENABLE`\n- `DISABLE`"},"styleConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLineStyleConfiguration","description":"The style configuration of the reference line."}},"type":"object","required":["dataConfiguration"]},"aws-native:quicksight:AnalysisReferenceLineCustomLabelConfiguration":{"properties":{"customLabel":{"type":"string","description":"The string text of the custom label."}},"type":"object","required":["customLabel"]},"aws-native:quicksight:AnalysisReferenceLineDataConfiguration":{"properties":{"axisBinding":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisBinding","description":"The axis binding type of the reference line. Choose one of the following options:\n\n- `PrimaryY`\n- `SecondaryY`"},"dynamicConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLineDynamicDataConfiguration","description":"The dynamic configuration of the reference line data configuration."},"seriesType":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLineSeriesType","description":"The series type of the reference line data configuration. Choose one of the following options:\n\n- `BAR`\n- `LINE`"},"staticConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLineStaticDataConfiguration","description":"The static data configuration of the reference line data configuration."}},"type":"object"},"aws-native:quicksight:AnalysisReferenceLineDynamicDataConfiguration":{"properties":{"calculation":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericalAggregationFunction","description":"The calculation that is used in the dynamic data."},"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the dynamic data targets."},"measureAggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisAggregationFunction","description":"The aggregation function that is used in the dynamic data."}},"type":"object","required":["calculation","column"]},"aws-native:quicksight:AnalysisReferenceLineLabelConfiguration":{"properties":{"customLabelConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLineCustomLabelConfiguration","description":"The custom label configuration of the label in a reference line."},"fontColor":{"type":"string","description":"The font color configuration of the label in a reference line."},"fontConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontConfiguration","description":"The font configuration of the label in a reference line."},"horizontalPosition":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLineLabelHorizontalPosition","description":"The horizontal position configuration of the label in a reference line. Choose one of the following options:\n\n- `LEFT`\n- `CENTER`\n- `RIGHT`"},"valueLabelConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLineValueLabelConfiguration","description":"The value label configuration of the label in a reference line."},"verticalPosition":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLineLabelVerticalPosition","description":"The vertical position configuration of the label in a reference line. Choose one of the following options:\n\n- `ABOVE`\n- `BELOW`"}},"type":"object"},"aws-native:quicksight:AnalysisReferenceLineLabelHorizontalPosition":{"type":"string","enum":[{"name":"Left","value":"LEFT"},{"name":"Center","value":"CENTER"},{"name":"Right","value":"RIGHT"}]},"aws-native:quicksight:AnalysisReferenceLineLabelVerticalPosition":{"type":"string","enum":[{"name":"Above","value":"ABOVE"},{"name":"Below","value":"BELOW"}]},"aws-native:quicksight:AnalysisReferenceLinePatternType":{"type":"string","enum":[{"name":"Solid","value":"SOLID"},{"name":"Dashed","value":"DASHED"},{"name":"Dotted","value":"DOTTED"}]},"aws-native:quicksight:AnalysisReferenceLineSeriesType":{"type":"string","enum":[{"name":"Bar","value":"BAR"},{"name":"Line","value":"LINE"}]},"aws-native:quicksight:AnalysisReferenceLineStaticDataConfiguration":{"properties":{"value":{"type":"number","description":"The double input of the static data."}},"type":"object","required":["value"]},"aws-native:quicksight:AnalysisReferenceLineStyleConfiguration":{"properties":{"color":{"type":"string","description":"The hex color of the reference line."},"pattern":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLinePatternType","description":"The pattern type of the line style. Choose one of the following options:\n\n- `SOLID`\n- `DASHED`\n- `DOTTED`"}},"type":"object"},"aws-native:quicksight:AnalysisReferenceLineValueLabelConfiguration":{"properties":{"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericFormatConfiguration","description":"The format configuration of the value label."},"relativePosition":{"$ref":"#/types/aws-native:quicksight:AnalysisReferenceLineValueLabelRelativePosition","description":"The relative position of the value label. Choose one of the following options:\n\n- `BEFORE_CUSTOM_LABEL`\n- `AFTER_CUSTOM_LABEL`"}},"type":"object"},"aws-native:quicksight:AnalysisReferenceLineValueLabelRelativePosition":{"type":"string","enum":[{"name":"BeforeCustomLabel","value":"BEFORE_CUSTOM_LABEL"},{"name":"AfterCustomLabel","value":"AFTER_CUSTOM_LABEL"}]},"aws-native:quicksight:AnalysisRelativeDateTimeControlDisplayOptions":{"properties":{"dateTimeFormat":{"type":"string","description":"Customize how dates are formatted in controls."},"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:AnalysisRelativeDateType":{"type":"string","enum":[{"name":"Previous","value":"PREVIOUS"},{"name":"This","value":"THIS"},{"name":"Last","value":"LAST"},{"name":"Now","value":"NOW"},{"name":"Next","value":"NEXT"}]},"aws-native:quicksight:AnalysisRelativeDatesFilter":{"properties":{"anchorDateConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisAnchorDateConfiguration","description":"The date configuration of the filter."},"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the filter is applied to."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"excludePeriodConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisExcludePeriodConfiguration","description":"The configuration for the exclude period of the filter."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"minimumGranularity":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeGranularity","description":"The minimum granularity (period granularity) of the relative dates filter."},"nullOption":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"parameterName":{"type":"string","description":"The parameter whose value should be used for the filter value."},"relativeDateType":{"$ref":"#/types/aws-native:quicksight:AnalysisRelativeDateType","description":"The range date type of the filter. Choose one of the options below:\n\n- `PREVIOUS`\n- `THIS`\n- `LAST`\n- `NOW`\n- `NEXT`"},"relativeDateValue":{"type":"number","description":"The date value of the filter."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeGranularity","description":"The level of time precision that is used to aggregate `DateTime` values."}},"type":"object","required":["anchorDateConfiguration","column","filterId","nullOption","relativeDateType","timeGranularity"]},"aws-native:quicksight:AnalysisRelativeFontSize":{"type":"string","enum":[{"name":"ExtraSmall","value":"EXTRA_SMALL"},{"name":"Small","value":"SMALL"},{"name":"Medium","value":"MEDIUM"},{"name":"Large","value":"LARGE"},{"name":"ExtraLarge","value":"EXTRA_LARGE"}]},"aws-native:quicksight:AnalysisResizeOption":{"type":"string","enum":[{"name":"Fixed","value":"FIXED"},{"name":"Responsive","value":"RESPONSIVE"}]},"aws-native:quicksight:AnalysisResourcePermission":{"description":"\u003cp\u003ePermission for the resource.\u003c/p\u003e","properties":{"actions":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eThe IAM action to grant or revoke permissions on.\u003c/p\u003e"},"principal":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) of the principal. This can be one of the\n            following:\u003c/p\u003e\n         \u003cul\u003e\n            \u003cli\u003e\n               \u003cp\u003eThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)\u003c/p\u003e\n            \u003c/li\u003e\n            \u003cli\u003e\n               \u003cp\u003eThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)\u003c/p\u003e\n            \u003c/li\u003e\n            \u003cli\u003e\n               \u003cp\u003eThe ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n                    ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n                    (This is less common.) \u003c/p\u003e\n            \u003c/li\u003e\n         \u003c/ul\u003e"}},"type":"object","required":["actions","principal"]},"aws-native:quicksight:AnalysisResourceStatus":{"type":"string","enum":[{"name":"CreationInProgress","value":"CREATION_IN_PROGRESS"},{"name":"CreationSuccessful","value":"CREATION_SUCCESSFUL"},{"name":"CreationFailed","value":"CREATION_FAILED"},{"name":"UpdateInProgress","value":"UPDATE_IN_PROGRESS"},{"name":"UpdateSuccessful","value":"UPDATE_SUCCESSFUL"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"PendingUpdate","value":"PENDING_UPDATE"},{"name":"Deleted","value":"DELETED"}]},"aws-native:quicksight:AnalysisRollingDateConfiguration":{"properties":{"dataSetIdentifier":{"type":"string","description":"The data set that is used in the rolling date configuration."},"expression":{"type":"string","description":"The expression of the rolling date configuration."}},"type":"object","required":["expression"]},"aws-native:quicksight:AnalysisRowAlternateColorOptions":{"properties":{"rowAlternateColors":{"type":"array","items":{"type":"string"},"description":"Determines the list of row alternate colors."},"status":{"$ref":"#/types/aws-native:quicksight:AnalysisWidgetStatus","description":"Determines the widget status."},"usePrimaryBackgroundColor":{"$ref":"#/types/aws-native:quicksight:AnalysisWidgetStatus","description":"The primary background color options for alternate rows."}},"type":"object"},"aws-native:quicksight:AnalysisSameSheetTargetVisualConfiguration":{"properties":{"targetVisualOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTargetVisualOptions","description":"The options that choose the target visual in the same sheet.\n\nValid values are defined as follows:\n\n- `ALL_VISUALS` : Applies the filter operation to all visuals in the same sheet."},"targetVisuals":{"type":"array","items":{"type":"string"},"description":"A list of the target visual IDs that are located in the same sheet of the analysis."}},"type":"object"},"aws-native:quicksight:AnalysisSankeyDiagramAggregatedFieldWells":{"properties":{"destination":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The destination field wells of a sankey diagram."},"source":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The source field wells of a sankey diagram."},"weight":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The weight field wells of a sankey diagram."}},"type":"object"},"aws-native:quicksight:AnalysisSankeyDiagramChartConfiguration":{"properties":{"dataLabels":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOptions","description":"The data label configuration of a sankey diagram."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisSankeyDiagramFieldWells","description":"The field well configuration of a sankey diagram."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisSankeyDiagramSortConfiguration","description":"The sort configuration of a sankey diagram."}},"type":"object"},"aws-native:quicksight:AnalysisSankeyDiagramFieldWells":{"properties":{"sankeyDiagramAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisSankeyDiagramAggregatedFieldWells","description":"The field well configuration of a sankey diagram."}},"type":"object"},"aws-native:quicksight:AnalysisSankeyDiagramSortConfiguration":{"properties":{"destinationItemsLimit":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of destination nodes that are displayed in a sankey diagram."},"sourceItemsLimit":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of source nodes that are displayed in a sankey diagram."},"weightSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of the weight fields."}},"type":"object"},"aws-native:quicksight:AnalysisSankeyDiagramVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisSankeyDiagramChartConfiguration","description":"The configuration of a sankey diagram."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisScatterPlotCategoricallyAggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The category field well of a scatter plot."},"label":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The label field well of a scatter plot."},"size":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The size field well of a scatter plot."},"xAxis":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The x-axis field well of a scatter plot.\n\nThe x-axis is aggregated by category."},"yAxis":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The y-axis field well of a scatter plot.\n\nThe y-axis is aggregated by category."}},"type":"object"},"aws-native:quicksight:AnalysisScatterPlotConfiguration":{"properties":{"dataLabels":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOptions","description":"The options that determine if visual data labels are displayed."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisScatterPlotFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions","description":"The legend display setup of the visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisScatterPlotSortConfiguration","description":"The sort configuration of a scatter plot."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The legend display setup of the visual."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualPalette","description":"The palette (chart color) display setup of the visual."},"xAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis."},"xAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis."},"yAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis."},"yAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis."}},"type":"object"},"aws-native:quicksight:AnalysisScatterPlotFieldWells":{"properties":{"scatterPlotCategoricallyAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisScatterPlotCategoricallyAggregatedFieldWells","description":"The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both."},"scatterPlotUnaggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisScatterPlotUnaggregatedFieldWells","description":"The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are unaggregated."}},"type":"object"},"aws-native:quicksight:AnalysisScatterPlotSortConfiguration":{"properties":{"scatterPlotLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration"}},"type":"object"},"aws-native:quicksight:AnalysisScatterPlotUnaggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The category field well of a scatter plot."},"label":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The label field well of a scatter plot."},"size":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The size field well of a scatter plot."},"xAxis":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The x-axis field well of a scatter plot.\n\nThe x-axis is a dimension field and cannot be aggregated."},"yAxis":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The y-axis field well of a scatter plot.\n\nThe y-axis is a dimension field and cannot be aggregated."}},"type":"object"},"aws-native:quicksight:AnalysisScatterPlotVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisScatterPlotConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisScrollBarOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the data zoom scroll bar."},"visibleRange":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibleRangeOptions","description":"The visibility range for the data zoom scroll bar."}},"type":"object"},"aws-native:quicksight:AnalysisSecondaryValueOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines the visibility of the secondary value."}},"type":"object"},"aws-native:quicksight:AnalysisSectionAfterPageBreak":{"properties":{"status":{"$ref":"#/types/aws-native:quicksight:AnalysisSectionPageBreakStatus","description":"The option that enables or disables a page break at the end of a section."}},"type":"object"},"aws-native:quicksight:AnalysisSectionBasedLayoutCanvasSizeOptions":{"properties":{"paperCanvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSectionBasedLayoutPaperCanvasSizeOptions","description":"The options for a paper canvas of a section-based layout."}},"type":"object"},"aws-native:quicksight:AnalysisSectionBasedLayoutConfiguration":{"properties":{"bodySections":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisBodySectionConfiguration"},"description":"A list of body section configurations."},"canvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSectionBasedLayoutCanvasSizeOptions","description":"The options for the canvas of a section-based layout."},"footerSections":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisHeaderFooterSectionConfiguration"},"description":"A list of footer section configurations."},"headerSections":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisHeaderFooterSectionConfiguration"},"description":"A list of header section configurations."}},"type":"object","required":["bodySections","canvasSizeOptions","footerSections","headerSections"]},"aws-native:quicksight:AnalysisSectionBasedLayoutPaperCanvasSizeOptions":{"properties":{"paperMargin":{"$ref":"#/types/aws-native:quicksight:AnalysisSpacing","description":"Defines the spacing between the canvas content and the top, bottom, left, and right edges."},"paperOrientation":{"$ref":"#/types/aws-native:quicksight:AnalysisPaperOrientation","description":"The paper orientation that is used to define canvas dimensions. Choose one of the following options:\n\n- PORTRAIT\n- LANDSCAPE"},"paperSize":{"$ref":"#/types/aws-native:quicksight:AnalysisPaperSize","description":"The paper size that is used to define canvas dimensions."}},"type":"object"},"aws-native:quicksight:AnalysisSectionLayoutConfiguration":{"properties":{"freeFormLayout":{"$ref":"#/types/aws-native:quicksight:AnalysisFreeFormSectionLayoutConfiguration","description":"The free-form layout configuration of a section."}},"type":"object","required":["freeFormLayout"]},"aws-native:quicksight:AnalysisSectionPageBreakConfiguration":{"properties":{"after":{"$ref":"#/types/aws-native:quicksight:AnalysisSectionAfterPageBreak","description":"The configuration of a page break after a section."}},"type":"object"},"aws-native:quicksight:AnalysisSectionPageBreakStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:AnalysisSectionStyle":{"properties":{"height":{"type":"string","description":"String based length that is composed of value and unit in px"},"padding":{"$ref":"#/types/aws-native:quicksight:AnalysisSpacing","description":"The spacing between section content and its top, bottom, left, and right edges.\n\nThere is no padding by default."}},"type":"object"},"aws-native:quicksight:AnalysisSelectAllValueOptions":{"type":"string","enum":[{"name":"AllValues","value":"ALL_VALUES"}]},"aws-native:quicksight:AnalysisSelectedFieldOptions":{"type":"string","enum":[{"name":"AllFields","value":"ALL_FIELDS"}]},"aws-native:quicksight:AnalysisSelectedSheetsFilterScopeConfiguration":{"properties":{"sheetVisualScopingConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetVisualScopingConfiguration"},"description":"The sheet ID and visual IDs of the sheet and visuals that the filter is applied to."}},"type":"object"},"aws-native:quicksight:AnalysisSelectedTooltipType":{"type":"string","enum":[{"name":"Basic","value":"BASIC"},{"name":"Detailed","value":"DETAILED"}]},"aws-native:quicksight:AnalysisSeriesItem":{"properties":{"dataFieldSeriesItem":{"$ref":"#/types/aws-native:quicksight:AnalysisDataFieldSeriesItem","description":"The data field series item configuration of a line chart."},"fieldSeriesItem":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSeriesItem","description":"The field series item configuration of a line chart."}},"type":"object"},"aws-native:quicksight:AnalysisSetParameterValueConfiguration":{"properties":{"destinationParameterName":{"type":"string","description":"The destination parameter name of the `SetParameterValueConfiguration` ."},"value":{"$ref":"#/types/aws-native:quicksight:AnalysisDestinationParameterValueConfiguration"}},"type":"object","required":["destinationParameterName","value"]},"aws-native:quicksight:AnalysisShapeConditionalFormat":{"properties":{"backgroundColor":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingColor","description":"The conditional formatting for the shape background color of a filled map visual."}},"type":"object","required":["backgroundColor"]},"aws-native:quicksight:AnalysisSheet":{"description":"\u003cp\u003eA \u003ci\u003esheet\u003c/i\u003e, which is an object that contains a set of visuals that\n            are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n            contains at least one sheet. Each sheet contains at least one visualization widget, for\n            example a chart, pivot table, or narrative insight. Sheets can be associated with other\n            components, such as controls, filters, and so on.\u003c/p\u003e","properties":{"name":{"type":"string","description":"\u003cp\u003eThe name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n            console.\u003c/p\u003e"},"sheetId":{"type":"string","description":"\u003cp\u003eThe unique identifier associated with a sheet.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:AnalysisSheetContentType":{"type":"string","enum":[{"name":"Paginated","value":"PAGINATED"},{"name":"Interactive","value":"INTERACTIVE"}]},"aws-native:quicksight:AnalysisSheetControlDateTimePickerType":{"type":"string","enum":[{"name":"SingleValued","value":"SINGLE_VALUED"},{"name":"DateRange","value":"DATE_RANGE"}]},"aws-native:quicksight:AnalysisSheetControlInfoIconLabelOptions":{"properties":{"infoIconText":{"type":"string","description":"The text content of info icon."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility configuration of info icon label options."}},"type":"object"},"aws-native:quicksight:AnalysisSheetControlLayout":{"properties":{"configuration":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlLayoutConfiguration","description":"The configuration that determines the elements and canvas size options of sheet control."}},"type":"object","required":["configuration"]},"aws-native:quicksight:AnalysisSheetControlLayoutConfiguration":{"properties":{"gridLayout":{"$ref":"#/types/aws-native:quicksight:AnalysisGridLayoutConfiguration","description":"The configuration that determines the elements and canvas size options of sheet control."}},"type":"object"},"aws-native:quicksight:AnalysisSheetControlListType":{"type":"string","enum":[{"name":"MultiSelect","value":"MULTI_SELECT"},{"name":"SingleSelect","value":"SINGLE_SELECT"}]},"aws-native:quicksight:AnalysisSheetControlSliderType":{"type":"string","enum":[{"name":"SinglePoint","value":"SINGLE_POINT"},{"name":"Range","value":"RANGE"}]},"aws-native:quicksight:AnalysisSheetDefinition":{"properties":{"contentType":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetContentType","description":"The layout content type of the sheet. Choose one of the following options:\n\n- `PAGINATED` : Creates a sheet for a paginated report.\n- `INTERACTIVE` : Creates a sheet for an interactive dashboard."},"description":{"type":"string","description":"A description of the sheet."},"filterControls":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterControl"},"description":"The list of filter controls that are on a sheet.\n\nFor more information, see [Adding filter controls to analysis sheets](https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html) in the *Amazon Quick Suite User Guide* ."},"images":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetImage"},"description":"A list of images on a sheet."},"layouts":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisLayout"},"description":"Layouts define how the components of a sheet are arranged.\n\nFor more information, see [Types of layout](https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) in the *Amazon Quick Suite User Guide* ."},"name":{"type":"string","description":"The name of the sheet. This name is displayed on the sheet's tab in the Quick Suite console."},"parameterControls":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterControl"},"description":"The list of parameter controls that are on a sheet.\n\nFor more information, see [Using a Control with a Parameter in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html) in the *Amazon Quick Suite User Guide* ."},"sheetControlLayouts":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlLayout"},"description":"The control layouts of the sheet."},"sheetId":{"type":"string","description":"The unique identifier of a sheet."},"textBoxes":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetTextBox"},"description":"The text boxes that are on a sheet."},"title":{"type":"string","description":"The title of the sheet."},"visuals":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisual"},"description":"A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet."}},"type":"object","required":["sheetId"]},"aws-native:quicksight:AnalysisSheetElementConfigurationOverrides":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines whether or not the overrides are visible. Choose one of the following options:\n\n- `VISIBLE`\n- `HIDDEN`"}},"type":"object"},"aws-native:quicksight:AnalysisSheetElementRenderingRule":{"properties":{"configurationOverrides":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetElementConfigurationOverrides","description":"The override configuration of the rendering rules of a sheet."},"expression":{"type":"string","description":"The expression of the rendering rules of a sheet."}},"type":"object","required":["configurationOverrides","expression"]},"aws-native:quicksight:AnalysisSheetImage":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisImageCustomAction"},"description":"A list of custom actions that are configured for an image."},"imageContentAltText":{"type":"string","description":"The alt text for the image."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisImageInteractionOptions","description":"The general image interactions setup for an image."},"scaling":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetImageScalingConfiguration","description":"Determines how the image is scaled."},"sheetImageId":{"type":"string","description":"The ID of the sheet image."},"source":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetImageSource","description":"The source of the image."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetImageTooltipConfiguration","description":"The tooltip to be shown when hovering over the image."}},"type":"object","required":["sheetImageId","source"]},"aws-native:quicksight:AnalysisSheetImageScalingConfiguration":{"properties":{"scalingType":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetImageScalingType","description":"The scaling option to use when fitting the image inside the container.\n\nValid values are defined as follows:\n\n- `SCALE_TO_WIDTH` : The image takes up the entire width of the container. The image aspect ratio is preserved.\n- `SCALE_TO_HEIGHT` : The image takes up the entire height of the container. The image aspect ratio is preserved.\n- `SCALE_TO_CONTAINER` : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.\n- `SCALE_NONE` : The image is displayed in its original size and is not scaled to the container."}},"type":"object"},"aws-native:quicksight:AnalysisSheetImageScalingType":{"type":"string","enum":[{"name":"ScaleToWidth","value":"SCALE_TO_WIDTH"},{"name":"ScaleToHeight","value":"SCALE_TO_HEIGHT"},{"name":"ScaleToContainer","value":"SCALE_TO_CONTAINER"},{"name":"ScaleNone","value":"SCALE_NONE"}]},"aws-native:quicksight:AnalysisSheetImageSource":{"properties":{"sheetImageStaticFileSource":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetImageStaticFileSource","description":"The source of the static file that contains the image."}},"type":"object"},"aws-native:quicksight:AnalysisSheetImageStaticFileSource":{"properties":{"staticFileId":{"type":"string","description":"The ID of the static file that contains the image."}},"type":"object","required":["staticFileId"]},"aws-native:quicksight:AnalysisSheetImageTooltipConfiguration":{"properties":{"tooltipText":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetImageTooltipText","description":"The text that appears in the tooltip."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the tooltip."}},"type":"object"},"aws-native:quicksight:AnalysisSheetImageTooltipText":{"properties":{"plainText":{"type":"string","description":"The plain text format."}},"type":"object"},"aws-native:quicksight:AnalysisSheetTextBox":{"properties":{"content":{"type":"string","description":"The content that is displayed in the text box."},"sheetTextBoxId":{"type":"string","description":"The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers."}},"type":"object","required":["sheetTextBoxId"]},"aws-native:quicksight:AnalysisSheetVisualScopingConfiguration":{"properties":{"scope":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterVisualScope","description":"The scope of the applied entities. Choose one of the following options:\n\n- `ALL_VISUALS`\n- `SELECTED_VISUALS`"},"sheetId":{"type":"string","description":"The selected sheet that the filter is applied to."},"visualIds":{"type":"array","items":{"type":"string"},"description":"The selected visuals that the filter is applied to."}},"type":"object","required":["scope","sheetId"]},"aws-native:quicksight:AnalysisShortFormatText":{"properties":{"plainText":{"type":"string","description":"Plain text format."},"richText":{"type":"string","description":"Rich text. Examples of rich text include bold, underline, and italics."}},"type":"object"},"aws-native:quicksight:AnalysisSimpleAttributeAggregationFunction":{"type":"string","enum":[{"name":"UniqueValue","value":"UNIQUE_VALUE"}]},"aws-native:quicksight:AnalysisSimpleClusterMarker":{"properties":{"color":{"type":"string","description":"The color of the simple cluster marker."}},"type":"object"},"aws-native:quicksight:AnalysisSimpleNumericalAggregationFunction":{"type":"string","enum":[{"name":"Sum","value":"SUM"},{"name":"Average","value":"AVERAGE"},{"name":"Min","value":"MIN"},{"name":"Max","value":"MAX"},{"name":"Count","value":"COUNT"},{"name":"DistinctCount","value":"DISTINCT_COUNT"},{"name":"Var","value":"VAR"},{"name":"Varp","value":"VARP"},{"name":"Stdev","value":"STDEV"},{"name":"Stdevp","value":"STDEVP"},{"name":"Median","value":"MEDIAN"}]},"aws-native:quicksight:AnalysisSimpleTotalAggregationFunction":{"type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"Sum","value":"SUM"},{"name":"Average","value":"AVERAGE"},{"name":"Min","value":"MIN"},{"name":"Max","value":"MAX"},{"name":"None","value":"NONE"}]},"aws-native:quicksight:AnalysisSingleAxisOptions":{"properties":{"yAxisOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisYAxisOptions","description":"The Y axis options of a single axis configuration."}},"type":"object"},"aws-native:quicksight:AnalysisSingleYAxisOption":{"type":"string","enum":[{"name":"PrimaryYAxis","value":"PRIMARY_Y_AXIS"}]},"aws-native:quicksight:AnalysisSliderControlDisplayOptions":{"properties":{"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:AnalysisSmallMultiplesAxisPlacement":{"type":"string","enum":[{"name":"Outside","value":"OUTSIDE"},{"name":"Inside","value":"INSIDE"}]},"aws-native:quicksight:AnalysisSmallMultiplesAxisProperties":{"properties":{"placement":{"$ref":"#/types/aws-native:quicksight:AnalysisSmallMultiplesAxisPlacement","description":"Defines the placement of the axis. By default, axes are rendered `OUTSIDE` of the panels. Axes with `INDEPENDENT` scale are rendered `INSIDE` the panels."},"scale":{"$ref":"#/types/aws-native:quicksight:AnalysisSmallMultiplesAxisScale","description":"Determines whether scale of the axes are shared or independent. The default value is `SHARED` ."}},"type":"object"},"aws-native:quicksight:AnalysisSmallMultiplesAxisScale":{"type":"string","enum":[{"name":"Shared","value":"SHARED"},{"name":"Independent","value":"INDEPENDENT"}]},"aws-native:quicksight:AnalysisSmallMultiplesOptions":{"properties":{"maxVisibleColumns":{"type":"number","description":"Sets the maximum number of visible columns to display in the grid of small multiples panels.\n\nThe default is `Auto` , which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart."},"maxVisibleRows":{"type":"number","description":"Sets the maximum number of visible rows to display in the grid of small multiples panels.\n\nThe default value is `Auto` , which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart."},"panelConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisPanelConfiguration","description":"Configures the display options for each small multiples panel."},"xAxis":{"$ref":"#/types/aws-native:quicksight:AnalysisSmallMultiplesAxisProperties","description":"The properties of a small multiples X axis."},"yAxis":{"$ref":"#/types/aws-native:quicksight:AnalysisSmallMultiplesAxisProperties","description":"The properties of a small multiples Y axis."}},"type":"object"},"aws-native:quicksight:AnalysisSortDirection":{"type":"string","enum":[{"name":"Asc","value":"ASC"},{"name":"Desc","value":"DESC"}]},"aws-native:quicksight:AnalysisSourceEntity":{"description":"\u003cp\u003eThe source entity of an analysis.\u003c/p\u003e","properties":{"sourceTemplate":{"$ref":"#/types/aws-native:quicksight:AnalysisSourceTemplate","description":"The source template for the source entity of the analysis."}},"type":"object"},"aws-native:quicksight:AnalysisSourceTemplate":{"description":"\u003cp\u003eThe source template of an analysis.\u003c/p\u003e","properties":{"arn":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) of the source template of an analysis.\u003c/p\u003e"},"dataSetReferences":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDataSetReference"},"description":"\u003cp\u003eThe dataset references of the source template of an analysis.\u003c/p\u003e"}},"type":"object","required":["arn","dataSetReferences"]},"aws-native:quicksight:AnalysisSpacing":{"properties":{"bottom":{"type":"string","description":"String based length that is composed of value and unit"},"left":{"type":"string","description":"String based length that is composed of value and unit"},"right":{"type":"string","description":"String based length that is composed of value and unit"},"top":{"type":"string","description":"String based length that is composed of value and unit"}},"type":"object"},"aws-native:quicksight:AnalysisSpatialStaticFile":{"properties":{"source":{"$ref":"#/types/aws-native:quicksight:AnalysisStaticFileSource","description":"The source of the spatial static file."},"staticFileId":{"type":"string","description":"The ID of the spatial static file."}},"type":"object","required":["staticFileId"]},"aws-native:quicksight:AnalysisSpecialValue":{"type":"string","enum":[{"name":"Empty","value":"EMPTY"},{"name":"Null","value":"NULL"},{"name":"Other","value":"OTHER"}]},"aws-native:quicksight:AnalysisStaticFile":{"properties":{"imageStaticFile":{"$ref":"#/types/aws-native:quicksight:AnalysisImageStaticFile","description":"The image static file."},"spatialStaticFile":{"$ref":"#/types/aws-native:quicksight:AnalysisSpatialStaticFile","description":"The spacial static file."}},"type":"object"},"aws-native:quicksight:AnalysisStaticFileS3SourceOptions":{"properties":{"bucketName":{"type":"string","description":"The name of the Amazon S3 bucket."},"objectKey":{"type":"string","description":"The identifier of the static file in the Amazon S3 bucket."},"region":{"type":"string","description":"The Region of the Amazon S3 account that contains the bucket."}},"type":"object","required":["bucketName","objectKey","region"]},"aws-native:quicksight:AnalysisStaticFileSource":{"properties":{"s3Options":{"$ref":"#/types/aws-native:quicksight:AnalysisStaticFileS3SourceOptions","description":"The structure that contains the Amazon S3 location to download the static file from."},"urlOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisStaticFileUrlSourceOptions","description":"The structure that contains the URL to download the static file from."}},"type":"object"},"aws-native:quicksight:AnalysisStaticFileUrlSourceOptions":{"properties":{"url":{"type":"string","description":"The URL to download the static file from."}},"type":"object","required":["url"]},"aws-native:quicksight:AnalysisStringDefaultValues":{"properties":{"dynamicValue":{"$ref":"#/types/aws-native:quicksight:AnalysisDynamicDefaultValue","description":"The dynamic value of the `StringDefaultValues` . Different defaults displayed according to users, groups, and values mapping."},"staticValues":{"type":"array","items":{"type":"string"},"description":"The static values of the `DecimalDefaultValues` ."}},"type":"object"},"aws-native:quicksight:AnalysisStringFormatConfiguration":{"properties":{"nullValueFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNullValueFormatConfiguration","description":"The options that determine the null value format configuration."},"numericFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericFormatConfiguration","description":"The formatting configuration for numeric strings."}},"type":"object"},"aws-native:quicksight:AnalysisStringParameter":{"description":"\u003cp\u003eA string parameter.\u003c/p\u003e","properties":{"name":{"type":"string","description":"\u003cp\u003eA display name for a string parameter.\u003c/p\u003e"},"values":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eThe values of a string parameter.\u003c/p\u003e"}},"type":"object","required":["name","values"]},"aws-native:quicksight:AnalysisStringParameterDeclaration":{"properties":{"defaultValues":{"$ref":"#/types/aws-native:quicksight:AnalysisStringDefaultValues","description":"The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided."},"mappedDataSetParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMappedDataSetParameter"}},"name":{"type":"string","description":"The name of the parameter that is being declared."},"parameterValueType":{"$ref":"#/types/aws-native:quicksight:AnalysisParameterValueType","description":"The value type determines whether the parameter is a single-value or multi-value parameter."},"valueWhenUnset":{"$ref":"#/types/aws-native:quicksight:AnalysisStringValueWhenUnsetConfiguration","description":"The configuration that defines the default value of a `String` parameter when a value has not been set."}},"type":"object","required":["name","parameterValueType"]},"aws-native:quicksight:AnalysisStringValueWhenUnsetConfiguration":{"properties":{"customValue":{"type":"string","description":"A custom value that's used when the value of a parameter isn't set."},"valueWhenUnsetOption":{"$ref":"#/types/aws-native:quicksight:AnalysisValueWhenUnsetOption","description":"The built-in options for default values. The value can be one of the following:\n\n- `RECOMMENDED` : The recommended value.\n- `NULL` : The `NULL` value."}},"type":"object"},"aws-native:quicksight:AnalysisStyledCellType":{"type":"string","enum":[{"name":"Total","value":"TOTAL"},{"name":"MetricHeader","value":"METRIC_HEADER"},{"name":"Value","value":"VALUE"}]},"aws-native:quicksight:AnalysisSubtotalOptions":{"properties":{"customLabel":{"type":"string","description":"The custom label string for the subtotal cells."},"fieldLevel":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableSubtotalLevel","description":"The field level (all, custom, last) for the subtotal cells."},"fieldLevelOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableFieldSubtotalOptions"},"description":"The optional configuration of subtotal cells."},"metricHeaderCellStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"The cell styling options for the subtotals of header cells."},"styleTargets":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisTableStyleTarget"},"description":"The style targets options for subtotals."},"totalCellStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"The cell styling options for the subtotal cells."},"totalsVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility configuration for the subtotal cells."},"valueCellStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"The cell styling options for the subtotals of value cells."}},"type":"object"},"aws-native:quicksight:AnalysisTableAggregatedFieldWells":{"properties":{"groupBy":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The group by field well for a pivot table. Values are grouped by group by fields."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The values field well for a pivot table. Values are aggregated based on group by fields."}},"type":"object"},"aws-native:quicksight:AnalysisTableBorderOptions":{"properties":{"color":{"type":"string","description":"The color of a table border."},"style":{"$ref":"#/types/aws-native:quicksight:AnalysisTableBorderStyle","description":"The style (none, solid) of a table border."},"thickness":{"type":"number","description":"The thickness of a table border."}},"type":"object"},"aws-native:quicksight:AnalysisTableBorderStyle":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Solid","value":"SOLID"}]},"aws-native:quicksight:AnalysisTableCellConditionalFormatting":{"properties":{"fieldId":{"type":"string","description":"The field ID of the cell for conditional formatting."},"textFormat":{"$ref":"#/types/aws-native:quicksight:AnalysisTextConditionalFormat","description":"The text format of the cell for conditional formatting."}},"type":"object","required":["fieldId"]},"aws-native:quicksight:AnalysisTableCellImageScalingConfiguration":{"type":"string","enum":[{"name":"FitToCellHeight","value":"FIT_TO_CELL_HEIGHT"},{"name":"FitToCellWidth","value":"FIT_TO_CELL_WIDTH"},{"name":"DoNotScale","value":"DO_NOT_SCALE"}]},"aws-native:quicksight:AnalysisTableCellImageSizingConfiguration":{"properties":{"tableCellImageScalingConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellImageScalingConfiguration","description":"The cell scaling configuration of the sizing options for the table image configuration."}},"type":"object"},"aws-native:quicksight:AnalysisTableCellStyle":{"properties":{"backgroundColor":{"type":"string","description":"The background color for the table cells."},"border":{"$ref":"#/types/aws-native:quicksight:AnalysisGlobalTableBorderOptions","description":"The borders for the table cells."},"fontConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontConfiguration","description":"The font configuration of the table cells."},"height":{"type":"number","description":"The height color for the table cells."},"horizontalTextAlignment":{"$ref":"#/types/aws-native:quicksight:AnalysisHorizontalTextAlignment","description":"The horizontal text alignment (left, center, right, auto) for the table cells."},"textWrap":{"$ref":"#/types/aws-native:quicksight:AnalysisTextWrap","description":"The text wrap (none, wrap) for the table cells."},"verticalTextAlignment":{"$ref":"#/types/aws-native:quicksight:AnalysisVerticalTextAlignment","description":"The vertical text alignment (top, middle, bottom) for the table cells."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the table cells."}},"type":"object"},"aws-native:quicksight:AnalysisTableConditionalFormatting":{"properties":{"conditionalFormattingOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisTableConditionalFormattingOption"},"description":"Conditional formatting options for a `PivotTableVisual` ."}},"type":"object"},"aws-native:quicksight:AnalysisTableConditionalFormattingOption":{"properties":{"cell":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellConditionalFormatting","description":"The cell conditional formatting option for a table."},"row":{"$ref":"#/types/aws-native:quicksight:AnalysisTableRowConditionalFormatting","description":"The row conditional formatting option for a table."}},"type":"object"},"aws-native:quicksight:AnalysisTableConfiguration":{"properties":{"fieldOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTableFieldOptions","description":"The field options for a table visual."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisTableFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"paginatedReportOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTablePaginatedReportOptions","description":"The paginated report options for a table visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisTableSortConfiguration","description":"The sort configuration for a `TableVisual` ."},"tableInlineVisualizations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisTableInlineVisualization"},"description":"A collection of inline visualizations to display within a chart."},"tableOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTableOptions","description":"The table options for a table visual."},"totalOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTotalOptions","description":"The total options for a table visual."}},"type":"object"},"aws-native:quicksight:AnalysisTableFieldCustomIconContent":{"properties":{"icon":{"$ref":"#/types/aws-native:quicksight:AnalysisTableFieldIconSetType","description":"The icon set type (link) of the custom icon content for table URL link content."}},"type":"object"},"aws-native:quicksight:AnalysisTableFieldCustomTextContent":{"properties":{"fontConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFontConfiguration","description":"The font configuration of the custom text content for the table URL link content."},"value":{"type":"string","description":"The string value of the custom text content for the table URL link content."}},"type":"object","required":["fontConfiguration"]},"aws-native:quicksight:AnalysisTableFieldIconSetType":{"type":"string","enum":[{"name":"Link","value":"LINK"}]},"aws-native:quicksight:AnalysisTableFieldImageConfiguration":{"properties":{"sizingOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellImageSizingConfiguration","description":"The sizing options for the table image configuration."}},"type":"object"},"aws-native:quicksight:AnalysisTableFieldLinkConfiguration":{"properties":{"content":{"$ref":"#/types/aws-native:quicksight:AnalysisTableFieldLinkContentConfiguration","description":"The URL content (text, icon) for the table link configuration."},"target":{"$ref":"#/types/aws-native:quicksight:AnalysisUrlTargetConfiguration","description":"The URL target (new tab, new window, same tab) for the table link configuration."}},"type":"object","required":["content","target"]},"aws-native:quicksight:AnalysisTableFieldLinkContentConfiguration":{"properties":{"customIconContent":{"$ref":"#/types/aws-native:quicksight:AnalysisTableFieldCustomIconContent","description":"The custom icon content for the table link content configuration."},"customTextContent":{"$ref":"#/types/aws-native:quicksight:AnalysisTableFieldCustomTextContent","description":"The custom text content (value, font configuration) for the table link content configuration."}},"type":"object"},"aws-native:quicksight:AnalysisTableFieldOption":{"properties":{"customLabel":{"type":"string","description":"The custom label for a table field."},"fieldId":{"type":"string","description":"The field ID for a table field."},"urlStyling":{"$ref":"#/types/aws-native:quicksight:AnalysisTableFieldUrlConfiguration","description":"The URL configuration for a table field."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of a table field."},"width":{"type":"string","description":"String based length that is composed of value and unit in px"}},"type":"object","required":["fieldId"]},"aws-native:quicksight:AnalysisTableFieldOptions":{"properties":{"order":{"type":"array","items":{"type":"string"},"description":"The order of the field IDs that are configured as field options for a table visual."},"pinnedFieldOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTablePinnedFieldOptions","description":"The settings for the pinned columns of a table visual."},"selectedFieldOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisTableFieldOption"},"description":"The field options to be configured to a table."},"transposedTableOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisTransposedTableOption"},"description":"The `TableOptions` of a transposed table."}},"type":"object"},"aws-native:quicksight:AnalysisTableFieldUrlConfiguration":{"properties":{"imageConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisTableFieldImageConfiguration","description":"The image configuration of a table field URL."},"linkConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisTableFieldLinkConfiguration","description":"The link configuration of a table field URL."}},"type":"object"},"aws-native:quicksight:AnalysisTableFieldWells":{"properties":{"tableAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisTableAggregatedFieldWells","description":"The aggregated field well for the table."},"tableUnaggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisTableUnaggregatedFieldWells","description":"The unaggregated field well for the table."}},"type":"object"},"aws-native:quicksight:AnalysisTableInlineVisualization":{"properties":{"dataBars":{"$ref":"#/types/aws-native:quicksight:AnalysisDataBarsOptions","description":"The configuration of the inline visualization of the data bars within a chart."}},"type":"object"},"aws-native:quicksight:AnalysisTableOptions":{"properties":{"cellStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"The table cell style of table cells."},"headerStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"The table cell style of a table header."},"orientation":{"$ref":"#/types/aws-native:quicksight:AnalysisTableOrientation","description":"The orientation (vertical, horizontal) for a table."},"rowAlternateColorOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisRowAlternateColorOptions","description":"The row alternate color options (widget status, row alternate colors) for a table."}},"type":"object"},"aws-native:quicksight:AnalysisTableOrientation":{"type":"string","enum":[{"name":"Vertical","value":"VERTICAL"},{"name":"Horizontal","value":"HORIZONTAL"}]},"aws-native:quicksight:AnalysisTablePaginatedReportOptions":{"properties":{"overflowColumnHeaderVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of repeating header rows on each page."},"verticalOverflowVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of printing table overflow across pages."}},"type":"object"},"aws-native:quicksight:AnalysisTablePinnedFieldOptions":{"properties":{"pinnedLeftFields":{"type":"array","items":{"type":"string"},"description":"A list of columns to be pinned to the left of a table visual."}},"type":"object"},"aws-native:quicksight:AnalysisTableRowConditionalFormatting":{"properties":{"backgroundColor":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingColor","description":"The conditional formatting color (solid, gradient) of the background for a table row."},"textColor":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingColor","description":"The conditional formatting color (solid, gradient) of the text for a table row."}},"type":"object"},"aws-native:quicksight:AnalysisTableSideBorderOptions":{"properties":{"bottom":{"$ref":"#/types/aws-native:quicksight:AnalysisTableBorderOptions","description":"The table border options of the bottom border."},"innerHorizontal":{"$ref":"#/types/aws-native:quicksight:AnalysisTableBorderOptions","description":"The table border options of the inner horizontal border."},"innerVertical":{"$ref":"#/types/aws-native:quicksight:AnalysisTableBorderOptions","description":"The table border options of the inner vertical border."},"left":{"$ref":"#/types/aws-native:quicksight:AnalysisTableBorderOptions","description":"The table border options of the left border."},"right":{"$ref":"#/types/aws-native:quicksight:AnalysisTableBorderOptions","description":"The table border options of the right border."},"top":{"$ref":"#/types/aws-native:quicksight:AnalysisTableBorderOptions","description":"The table border options of the top border."}},"type":"object"},"aws-native:quicksight:AnalysisTableSortConfiguration":{"properties":{"paginationConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisPaginationConfiguration","description":"The pagination configuration (page size, page number) for the table."},"rowSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The field sort options for rows in the table."}},"type":"object"},"aws-native:quicksight:AnalysisTableStyleTarget":{"properties":{"cellType":{"$ref":"#/types/aws-native:quicksight:AnalysisStyledCellType","description":"The cell type of the table style target."}},"type":"object","required":["cellType"]},"aws-native:quicksight:AnalysisTableTotalsPlacement":{"type":"string","enum":[{"name":"Start","value":"START"},{"name":"End","value":"END"},{"name":"Auto","value":"AUTO"}]},"aws-native:quicksight:AnalysisTableTotalsScrollStatus":{"type":"string","enum":[{"name":"Pinned","value":"PINNED"},{"name":"Scrolled","value":"SCROLLED"}]},"aws-native:quicksight:AnalysisTableUnaggregatedFieldWells":{"properties":{"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisUnaggregatedField"},"description":"The values field well for a pivot table. Values are unaggregated for an unaggregated table."}},"type":"object"},"aws-native:quicksight:AnalysisTableVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisTableConfiguration","description":"The configuration settings of the visual."},"conditionalFormatting":{"$ref":"#/types/aws-native:quicksight:AnalysisTableConditionalFormatting","description":"The conditional formatting for a `PivotTableVisual` ."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisTag":{"description":"\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n            resource.\u003c/p\u003e","properties":{"key":{"type":"string","description":"\u003cp\u003eTag key.\u003c/p\u003e"},"value":{"type":"string","description":"\u003cp\u003eTag value.\u003c/p\u003e"}},"type":"object","required":["key","value"]},"aws-native:quicksight:AnalysisTargetVisualOptions":{"type":"string","enum":[{"name":"AllVisuals","value":"ALL_VISUALS"}]},"aws-native:quicksight:AnalysisTextAreaControlDisplayOptions":{"properties":{"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"placeholderOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTextControlPlaceholderOptions","description":"The configuration of the placeholder options in a text area control."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:AnalysisTextConditionalFormat":{"properties":{"backgroundColor":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingColor","description":"The conditional formatting for the text background color."},"icon":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingIcon","description":"The conditional formatting for the icon."},"textColor":{"$ref":"#/types/aws-native:quicksight:AnalysisConditionalFormattingColor","description":"The conditional formatting for the text color."}},"type":"object"},"aws-native:quicksight:AnalysisTextControlPlaceholderOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility configuration of the placeholder options in a text control."}},"type":"object"},"aws-native:quicksight:AnalysisTextFieldControlDisplayOptions":{"properties":{"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"placeholderOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisTextControlPlaceholderOptions","description":"The configuration of the placeholder options in a text field control."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:AnalysisTextWrap":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Wrap","value":"WRAP"}]},"aws-native:quicksight:AnalysisThousandSeparatorOptions":{"properties":{"groupingStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisDigitGroupingStyle","description":"Determines the way numbers are styled to accommodate different readability standards. The `DEFAULT` value uses the standard international grouping system and groups numbers by the thousands. The `LAKHS` value uses the Indian numbering system and groups numbers by lakhs and crores."},"symbol":{"$ref":"#/types/aws-native:quicksight:AnalysisNumericSeparatorSymbol","description":"Determines the thousands separator symbol."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines the visibility of the thousands separator."}},"type":"object"},"aws-native:quicksight:AnalysisTimeBasedForecastProperties":{"properties":{"lowerBoundary":{"type":"number","description":"The lower boundary setup of a forecast computation."},"periodsBackward":{"type":"number","description":"The periods backward setup of a forecast computation."},"periodsForward":{"type":"number","description":"The periods forward setup of a forecast computation."},"predictionInterval":{"type":"number","description":"The prediction interval setup of a forecast computation."},"seasonality":{"type":"number","description":"The seasonality setup of a forecast computation. Choose one of the following options:\n\n- `NULL` : The input is set to `NULL` .\n- `NON_NULL` : The input is set to a custom value."},"upperBoundary":{"type":"number","description":"The upper boundary setup of a forecast computation."}},"type":"object"},"aws-native:quicksight:AnalysisTimeEqualityFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the filter is applied to."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"parameterName":{"type":"string","description":"The parameter whose value should be used for the filter value.\n\nThis field is mutually exclusive to `Value` and `RollingDate` ."},"rollingDate":{"$ref":"#/types/aws-native:quicksight:AnalysisRollingDateConfiguration","description":"The rolling date input for the `TimeEquality` filter.\n\nThis field is mutually exclusive to `Value` and `ParameterName` ."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeGranularity","description":"The level of time precision that is used to aggregate `DateTime` values."},"value":{"type":"string","description":"The value of a `TimeEquality` filter.\n\nThis field is mutually exclusive to `RollingDate` and `ParameterName` ."}},"type":"object","required":["column","filterId"]},"aws-native:quicksight:AnalysisTimeGranularity":{"type":"string","enum":[{"name":"Year","value":"YEAR"},{"name":"Quarter","value":"QUARTER"},{"name":"Month","value":"MONTH"},{"name":"Week","value":"WEEK"},{"name":"Day","value":"DAY"},{"name":"Hour","value":"HOUR"},{"name":"Minute","value":"MINUTE"},{"name":"Second","value":"SECOND"},{"name":"Millisecond","value":"MILLISECOND"}]},"aws-native:quicksight:AnalysisTimeRangeDrillDownFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the filter is applied to."},"rangeMaximum":{"type":"string","description":"The maximum value for the filter value range."},"rangeMinimum":{"type":"string","description":"The minimum value for the filter value range."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeGranularity","description":"The level of time precision that is used to aggregate `DateTime` values."}},"type":"object","required":["column","rangeMaximum","rangeMinimum","timeGranularity"]},"aws-native:quicksight:AnalysisTimeRangeFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the filter is applied to."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"excludePeriodConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisExcludePeriodConfiguration","description":"The exclude period of the time range filter."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"includeMaximum":{"type":"boolean","description":"Determines whether the maximum value in the filter value range should be included in the filtered results."},"includeMinimum":{"type":"boolean","description":"Determines whether the minimum value in the filter value range should be included in the filtered results."},"nullOption":{"$ref":"#/types/aws-native:quicksight:AnalysisFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"rangeMaximumValue":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeRangeFilterValue","description":"The maximum value for the filter value range."},"rangeMinimumValue":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeRangeFilterValue","description":"The minimum value for the filter value range."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeGranularity","description":"The level of time precision that is used to aggregate `DateTime` values."}},"type":"object","required":["column","filterId","nullOption"]},"aws-native:quicksight:AnalysisTimeRangeFilterValue":{"properties":{"parameter":{"type":"string","description":"The parameter type input value."},"rollingDate":{"$ref":"#/types/aws-native:quicksight:AnalysisRollingDateConfiguration","description":"The rolling date input value."},"staticValue":{"type":"string","description":"The static input value."}},"type":"object"},"aws-native:quicksight:AnalysisTooltipItem":{"properties":{"columnTooltipItem":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnTooltipItem","description":"The tooltip item for the columns that are not part of a field well."},"fieldTooltipItem":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldTooltipItem","description":"The tooltip item for the fields."}},"type":"object"},"aws-native:quicksight:AnalysisTooltipOptions":{"properties":{"fieldBasedTooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldBasedTooltip","description":"The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type."},"selectedTooltipType":{"$ref":"#/types/aws-native:quicksight:AnalysisSelectedTooltipType","description":"The selected type for the tooltip. Choose one of the following options:\n\n- `BASIC` : A basic tooltip.\n- `DETAILED` : A detailed tooltip."},"tooltipVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"Determines whether or not the tooltip is visible."}},"type":"object"},"aws-native:quicksight:AnalysisTooltipTarget":{"type":"string","enum":[{"name":"Both","value":"BOTH"},{"name":"Bar","value":"BAR"},{"name":"Line","value":"LINE"}]},"aws-native:quicksight:AnalysisTooltipTitleType":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"PrimaryValue","value":"PRIMARY_VALUE"}]},"aws-native:quicksight:AnalysisTopBottomComputationType":{"type":"string","enum":[{"name":"Top","value":"TOP"},{"name":"Bottom","value":"BOTTOM"}]},"aws-native:quicksight:AnalysisTopBottomFilter":{"properties":{"aggregationSortConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisAggregationSortConfiguration"},"description":"The aggregation and sort configuration of the top bottom filter."},"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that the filter is applied to."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"limit":{"type":"number","description":"The number of items to include in the top bottom filter results."},"parameterName":{"type":"string","description":"The parameter whose value should be used for the filter value."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:AnalysisTimeGranularity","description":"The level of time precision that is used to aggregate `DateTime` values."}},"type":"object","required":["aggregationSortConfigurations","column","filterId"]},"aws-native:quicksight:AnalysisTopBottomMoversComputation":{"properties":{"category":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField","description":"The category field that is used in a computation."},"computationId":{"type":"string","description":"The ID for a computation."},"moverSize":{"type":"number","description":"The mover size setup of the top and bottom movers computation."},"name":{"type":"string","description":"The name of a computation."},"sortOrder":{"$ref":"#/types/aws-native:quicksight:AnalysisTopBottomSortOrder","description":"The sort order setup of the top and bottom movers computation."},"time":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField","description":"The time field that is used in a computation."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisTopBottomComputationType","description":"The computation type. Choose from the following options:\n\n- TOP: Top movers computation.\n- BOTTOM: Bottom movers computation."},"value":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId","type"]},"aws-native:quicksight:AnalysisTopBottomRankedComputation":{"properties":{"category":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField","description":"The category field that is used in a computation."},"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."},"resultSize":{"type":"number","description":"The result size of a top and bottom ranked computation."},"type":{"$ref":"#/types/aws-native:quicksight:AnalysisTopBottomComputationType","description":"The computation type. Choose one of the following options:\n\n- TOP: A top ranked computation.\n- BOTTOM: A bottom ranked computation."},"value":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId","type"]},"aws-native:quicksight:AnalysisTopBottomSortOrder":{"type":"string","enum":[{"name":"PercentDifference","value":"PERCENT_DIFFERENCE"},{"name":"AbsoluteDifference","value":"ABSOLUTE_DIFFERENCE"}]},"aws-native:quicksight:AnalysisTotalAggregationComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."},"value":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:AnalysisTotalAggregationFunction":{"properties":{"simpleTotalAggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisSimpleTotalAggregationFunction","description":"A built in aggregation function for total values."}},"type":"object"},"aws-native:quicksight:AnalysisTotalAggregationOption":{"properties":{"fieldId":{"type":"string","description":"The field id that's associated with the total aggregation option."},"totalAggregationFunction":{"$ref":"#/types/aws-native:quicksight:AnalysisTotalAggregationFunction","description":"The total aggregation function that you want to set for a specified field id."}},"type":"object","required":["fieldId","totalAggregationFunction"]},"aws-native:quicksight:AnalysisTotalOptions":{"properties":{"customLabel":{"type":"string","description":"The custom label string for the total cells."},"placement":{"$ref":"#/types/aws-native:quicksight:AnalysisTableTotalsPlacement","description":"The placement (start, end) for the total cells."},"scrollStatus":{"$ref":"#/types/aws-native:quicksight:AnalysisTableTotalsScrollStatus","description":"The scroll status (pinned, scrolled) for the total cells."},"totalAggregationOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisTotalAggregationOption"},"description":"The total aggregation settings for each value field."},"totalCellStyle":{"$ref":"#/types/aws-native:quicksight:AnalysisTableCellStyle","description":"Cell styling options for the total cells."},"totalsVisibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility configuration for the total cells."}},"type":"object"},"aws-native:quicksight:AnalysisTransposedColumnType":{"type":"string","enum":[{"name":"RowHeaderColumn","value":"ROW_HEADER_COLUMN"},{"name":"ValueColumn","value":"VALUE_COLUMN"}]},"aws-native:quicksight:AnalysisTransposedTableOption":{"properties":{"columnIndex":{"type":"number","description":"The index of a columns in a transposed table. The index range is 0-9999."},"columnType":{"$ref":"#/types/aws-native:quicksight:AnalysisTransposedColumnType","description":"The column type of the column in a transposed table. Choose one of the following options:\n\n- `ROW_HEADER_COLUMN` : Refers to the leftmost column of the row header in the transposed table.\n- `VALUE_COLUMN` : Refers to all value columns in the transposed table."},"columnWidth":{"type":"string","description":"String based length that is composed of value and unit in px"}},"type":"object","required":["columnType"]},"aws-native:quicksight:AnalysisTreeMapAggregatedFieldWells":{"properties":{"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The color field well of a tree map. Values are grouped by aggregations based on group by fields."},"groups":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The group by field well of a tree map. Values are grouped based on group by fields."},"sizes":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The size field well of a tree map. Values are aggregated based on group by fields."}},"type":"object"},"aws-native:quicksight:AnalysisTreeMapConfiguration":{"properties":{"colorLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility) for the colors displayed in a tree map."},"colorScale":{"$ref":"#/types/aws-native:quicksight:AnalysisColorScale","description":"The color options (gradient color, point of divergence) of a tree map."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOptions","description":"The options that determine if visual data labels are displayed."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisTreeMapFieldWells","description":"The field wells of the visual."},"groupLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility) of the groups that are displayed in a tree map."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions","description":"The legend display setup of the visual."},"sizeLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility) of the sizes that are displayed in a tree map."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisTreeMapSortConfiguration","description":"The sort configuration of a tree map."},"tooltip":{"$ref":"#/types/aws-native:quicksight:AnalysisTooltipOptions","description":"The tooltip display setup of the visual."}},"type":"object"},"aws-native:quicksight:AnalysisTreeMapFieldWells":{"properties":{"treeMapAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisTreeMapAggregatedFieldWells","description":"The aggregated field wells of a tree map."}},"type":"object"},"aws-native:quicksight:AnalysisTreeMapSortConfiguration":{"properties":{"treeMapGroupItemsLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of groups that are displayed."},"treeMapSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of group by fields."}},"type":"object"},"aws-native:quicksight:AnalysisTreeMapVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisTreeMapConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisTrendArrowOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the trend arrows."}},"type":"object"},"aws-native:quicksight:AnalysisUnaggregatedField":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnIdentifier","description":"The column that is used in the `UnaggregatedField` ."},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisFormatConfiguration","description":"The format configuration of the field."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:AnalysisUniqueValuesComputation":{"properties":{"category":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField","description":"The category field that is used in a computation."},"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:AnalysisUrlTargetConfiguration":{"type":"string","enum":[{"name":"NewTab","value":"NEW_TAB"},{"name":"NewWindow","value":"NEW_WINDOW"},{"name":"SameTab","value":"SAME_TAB"}]},"aws-native:quicksight:AnalysisValidationStrategy":{"description":"\u003cp\u003eThe option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to \u003ccode\u003eLENIENT\u003c/code\u003e, validation is skipped for specific errors.\u003c/p\u003e","properties":{"mode":{"$ref":"#/types/aws-native:quicksight:AnalysisValidationStrategyMode","description":"The mode of validation for the asset to be created or updated. When you set this value to `STRICT` , strict validation for every error is enforced. When you set this value to `LENIENT` , validation is skipped for specific UI errors."}},"type":"object","required":["mode"]},"aws-native:quicksight:AnalysisValidationStrategyMode":{"type":"string","enum":[{"name":"Strict","value":"STRICT"},{"name":"Lenient","value":"LENIENT"}]},"aws-native:quicksight:AnalysisValueWhenUnsetOption":{"type":"string","enum":[{"name":"RecommendedValue","value":"RECOMMENDED_VALUE"},{"name":"Null","value":"NULL"}]},"aws-native:quicksight:AnalysisVerticalTextAlignment":{"type":"string","enum":[{"name":"Top","value":"TOP"},{"name":"Middle","value":"MIDDLE"},{"name":"Bottom","value":"BOTTOM"},{"name":"Auto","value":"AUTO"}]},"aws-native:quicksight:AnalysisVisibility":{"type":"string","enum":[{"name":"Hidden","value":"HIDDEN"},{"name":"Visible","value":"VISIBLE"}]},"aws-native:quicksight:AnalysisVisibleRangeOptions":{"properties":{"percentRange":{"$ref":"#/types/aws-native:quicksight:AnalysisPercentVisibleRange","description":"The percent range in the visible range."}},"type":"object"},"aws-native:quicksight:AnalysisVisual":{"properties":{"barChartVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisBarChartVisual","description":"A bar chart.\n\nFor more information, see [Using bar charts](https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) in the *Amazon Quick Suite User Guide* ."},"boxPlotVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisBoxPlotVisual","description":"A box plot.\n\nFor more information, see [Using box plots](https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) in the *Amazon Quick Suite User Guide* ."},"comboChartVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisComboChartVisual","description":"A combo chart.\n\nFor more information, see [Using combo charts](https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) in the *Amazon Quick Suite User Guide* ."},"customContentVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomContentVisual","description":"A visual that contains custom content.\n\nFor more information, see [Using custom visual content](https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) in the *Amazon Quick Suite User Guide* ."},"emptyVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisEmptyVisual","description":"An empty visual."},"filledMapVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisFilledMapVisual","description":"A filled map.\n\nFor more information, see [Creating filled maps](https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) in the *Amazon Quick Suite User Guide* ."},"funnelChartVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisFunnelChartVisual","description":"A funnel chart.\n\nFor more information, see [Using funnel charts](https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) in the *Amazon Quick Suite User Guide* ."},"gaugeChartVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisGaugeChartVisual","description":"A gauge chart.\n\nFor more information, see [Using gauge charts](https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) in the *Amazon Quick Suite User Guide* ."},"geospatialMapVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisGeospatialMapVisual","description":"A geospatial map or a points on map visual.\n\nFor more information, see [Creating point maps](https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html) in the *Amazon Quick Suite User Guide* ."},"heatMapVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisHeatMapVisual","description":"A heat map.\n\nFor more information, see [Using heat maps](https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) in the *Amazon Quick Suite User Guide* ."},"histogramVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisHistogramVisual","description":"A histogram.\n\nFor more information, see [Using histograms](https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) in the *Amazon Quick Suite User Guide* ."},"insightVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisInsightVisual","description":"An insight visual.\n\nFor more information, see [Working with insights](https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) in the *Amazon Quick Suite User Guide* ."},"kpiVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisKpiVisual","description":"A key performance indicator (KPI).\n\nFor more information, see [Using KPIs](https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) in the *Amazon Quick Suite User Guide* ."},"layerMapVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisLayerMapVisual","description":"The properties for a layer map visual"},"lineChartVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisLineChartVisual","description":"A line chart.\n\nFor more information, see [Using line charts](https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) in the *Amazon Quick Suite User Guide* ."},"pieChartVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisPieChartVisual","description":"A pie or donut chart.\n\nFor more information, see [Using pie charts](https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) in the *Amazon Quick Suite User Guide* ."},"pivotTableVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisPivotTableVisual","description":"A pivot table.\n\nFor more information, see [Using pivot tables](https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) in the *Amazon Quick Suite User Guide* ."},"pluginVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisPluginVisual","description":"The custom plugin visual type."},"radarChartVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisRadarChartVisual","description":"A radar chart visual.\n\nFor more information, see [Using radar charts](https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html) in the *Amazon Quick Suite User Guide* ."},"sankeyDiagramVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisSankeyDiagramVisual","description":"A sankey diagram.\n\nFor more information, see [Using Sankey diagrams](https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) in the *Amazon Quick Suite User Guide* ."},"scatterPlotVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisScatterPlotVisual","description":"A scatter plot.\n\nFor more information, see [Using scatter plots](https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) in the *Amazon Quick Suite User Guide* ."},"tableVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisTableVisual","description":"A table visual.\n\nFor more information, see [Using tables as visuals](https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) in the *Amazon Quick Suite User Guide* ."},"treeMapVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisTreeMapVisual","description":"A tree map.\n\nFor more information, see [Using tree maps](https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) in the *Amazon Quick Suite User Guide* ."},"waterfallVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisWaterfallVisual","description":"A waterfall chart.\n\nFor more information, see [Using waterfall charts](https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) in the *Amazon Quick Suite User Guide* ."},"wordCloudVisual":{"$ref":"#/types/aws-native:quicksight:AnalysisWordCloudVisual","description":"A word cloud.\n\nFor more information, see [Using word clouds](https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) in the *Amazon Quick Suite User Guide* ."}},"type":"object"},"aws-native:quicksight:AnalysisVisualCustomAction":{"properties":{"actionOperations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomActionOperation"},"description":"A list of `VisualCustomActionOperations` .\n\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined."},"customActionId":{"type":"string","description":"The ID of the `VisualCustomAction` ."},"name":{"type":"string","description":"The name of the `VisualCustomAction` ."},"status":{"$ref":"#/types/aws-native:quicksight:AnalysisWidgetStatus","description":"The status of the `VisualCustomAction` ."},"trigger":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomActionTrigger","description":"The trigger of the `VisualCustomAction` .\n\nValid values are defined as follows:\n\n- `DATA_POINT_CLICK` : Initiates a custom action by a left pointer click on a data point.\n- `DATA_POINT_MENU` : Initiates a custom action by right pointer click from the menu."}},"type":"object","required":["actionOperations","customActionId","name","trigger"]},"aws-native:quicksight:AnalysisVisualCustomActionOperation":{"properties":{"filterOperation":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomActionFilterOperation","description":"The filter operation that filters data included in a visual or in an entire sheet."},"navigationOperation":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomActionNavigationOperation","description":"The navigation operation that navigates between different sheets in the same analysis."},"setParametersOperation":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomActionSetParametersOperation","description":"The set parameter operation that sets parameters in custom action."},"urlOperation":{"$ref":"#/types/aws-native:quicksight:AnalysisCustomActionUrlOperation","description":"The URL operation that opens a link to another webpage."}},"type":"object"},"aws-native:quicksight:AnalysisVisualCustomActionTrigger":{"type":"string","enum":[{"name":"DataPointClick","value":"DATA_POINT_CLICK"},{"name":"DataPointMenu","value":"DATA_POINT_MENU"}]},"aws-native:quicksight:AnalysisVisualInteractionOptions":{"properties":{"contextMenuOption":{"$ref":"#/types/aws-native:quicksight:AnalysisContextMenuOption","description":"The context menu options for a visual."},"visualMenuOption":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualMenuOption","description":"The on-visual menu options for a visual."}},"type":"object"},"aws-native:quicksight:AnalysisVisualMenuOption":{"properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:AnalysisDashboardBehavior","description":"The availaiblity status of a visual's menu options."}},"type":"object"},"aws-native:quicksight:AnalysisVisualPalette":{"properties":{"chartColor":{"type":"string","description":"The chart color options for the visual palette."},"colorMap":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDataPathColor"},"description":"The color map options for the visual palette."}},"type":"object"},"aws-native:quicksight:AnalysisVisualSubtitleLabelOptions":{"properties":{"formatText":{"$ref":"#/types/aws-native:quicksight:AnalysisLongFormatText","description":"The long text format of the subtitle label, such as plain text or rich text."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the subtitle label."}},"type":"object"},"aws-native:quicksight:AnalysisVisualTitleLabelOptions":{"properties":{"formatText":{"$ref":"#/types/aws-native:quicksight:AnalysisShortFormatText","description":"The short text format of the title label, such as plain text or rich text."},"visibility":{"$ref":"#/types/aws-native:quicksight:AnalysisVisibility","description":"The visibility of the title label."}},"type":"object"},"aws-native:quicksight:AnalysisWaterfallChartAggregatedFieldWells":{"properties":{"breakdowns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The breakdown field wells of a waterfall visual."},"categories":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The category field wells of a waterfall visual."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The value field wells of a waterfall visual."}},"type":"object"},"aws-native:quicksight:AnalysisWaterfallChartColorConfiguration":{"properties":{"groupColorConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisWaterfallChartGroupColorConfiguration","description":"The color configuration for individual groups within a waterfall visual."}},"type":"object"},"aws-native:quicksight:AnalysisWaterfallChartConfiguration":{"properties":{"categoryAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The options that determine the presentation of the category axis."},"categoryAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The options that determine the presentation of the category axis label."},"colorConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisWaterfallChartColorConfiguration","description":"The color configuration of a waterfall visual."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:AnalysisDataLabelOptions","description":"The data label configuration of a waterfall visual."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisWaterfallChartFieldWells","description":"The field well configuration of a waterfall visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:AnalysisLegendOptions","description":"The legend configuration of a waterfall visual."},"primaryYAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisAxisDisplayOptions","description":"The options that determine the presentation of the y-axis."},"primaryYAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The options that determine the presentation of the y-axis label."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisWaterfallChartSortConfiguration","description":"The sort configuration of a waterfall visual."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualPalette","description":"The visual palette configuration of a waterfall visual."},"waterfallChartOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisWaterfallChartOptions","description":"The options that determine the presentation of a waterfall visual."}},"type":"object"},"aws-native:quicksight:AnalysisWaterfallChartFieldWells":{"properties":{"waterfallChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisWaterfallChartAggregatedFieldWells","description":"The field well configuration of a waterfall visual."}},"type":"object"},"aws-native:quicksight:AnalysisWaterfallChartGroupColorConfiguration":{"properties":{"negativeBarColor":{"type":"string","description":"Defines the color for the negative bars of a waterfall chart."},"positiveBarColor":{"type":"string","description":"Defines the color for the positive bars of a waterfall chart."},"totalBarColor":{"type":"string","description":"Defines the color for the total bars of a waterfall chart."}},"type":"object"},"aws-native:quicksight:AnalysisWaterfallChartOptions":{"properties":{"totalBarLabel":{"type":"string","description":"This option determines the total bar label of a waterfall visual."}},"type":"object"},"aws-native:quicksight:AnalysisWaterfallChartSortConfiguration":{"properties":{"breakdownItemsLimit":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of bar groups that are displayed."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of the category fields."}},"type":"object"},"aws-native:quicksight:AnalysisWaterfallVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisWaterfallChartConfiguration","description":"The configuration for a waterfall visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisWhatIfPointScenario":{"properties":{"date":{"type":"string","description":"The date that you need the forecast results for."},"value":{"type":"number","description":"The target value that you want to meet for the provided date."}},"type":"object","required":["date","value"]},"aws-native:quicksight:AnalysisWhatIfRangeScenario":{"properties":{"endDate":{"type":"string","description":"The end date in the date range that you need the forecast results for."},"startDate":{"type":"string","description":"The start date in the date range that you need the forecast results for."},"value":{"type":"number","description":"The target value that you want to meet for the provided date range."}},"type":"object","required":["endDate","startDate","value"]},"aws-native:quicksight:AnalysisWidgetStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:AnalysisWordCloudAggregatedFieldWells":{"properties":{"groupBy":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisDimensionField"},"description":"The group by field well of a word cloud. Values are grouped by group by fields."},"size":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisMeasureField"},"description":"The size field well of a word cloud. Values are aggregated based on group by fields."}},"type":"object"},"aws-native:quicksight:AnalysisWordCloudChartConfiguration":{"properties":{"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) for the word cloud category."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisWordCloudFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisWordCloudSortConfiguration","description":"The sort configuration of a word cloud visual."},"wordCloudOptions":{"$ref":"#/types/aws-native:quicksight:AnalysisWordCloudOptions","description":"The options for a word cloud visual."}},"type":"object"},"aws-native:quicksight:AnalysisWordCloudCloudLayout":{"type":"string","enum":[{"name":"Fluid","value":"FLUID"},{"name":"Normal","value":"NORMAL"}]},"aws-native:quicksight:AnalysisWordCloudFieldWells":{"properties":{"wordCloudAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:AnalysisWordCloudAggregatedFieldWells","description":"The aggregated field wells of a word cloud."}},"type":"object"},"aws-native:quicksight:AnalysisWordCloudOptions":{"properties":{"cloudLayout":{"$ref":"#/types/aws-native:quicksight:AnalysisWordCloudCloudLayout","description":"The cloud layout options (fluid, normal) of a word cloud."},"maximumStringLength":{"type":"number","description":"The length limit of each word from 1-100."},"wordCasing":{"$ref":"#/types/aws-native:quicksight:AnalysisWordCloudWordCasing","description":"The word casing options (lower_case, existing_case) for the words in a word cloud."},"wordOrientation":{"$ref":"#/types/aws-native:quicksight:AnalysisWordCloudWordOrientation","description":"The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud."},"wordPadding":{"$ref":"#/types/aws-native:quicksight:AnalysisWordCloudWordPadding","description":"The word padding options (none, small, medium, large) for the words in a word cloud."},"wordScaling":{"$ref":"#/types/aws-native:quicksight:AnalysisWordCloudWordScaling","description":"The word scaling options (emphasize, normal) for the words in a word cloud."}},"type":"object"},"aws-native:quicksight:AnalysisWordCloudSortConfiguration":{"properties":{"categoryItemsLimit":{"$ref":"#/types/aws-native:quicksight:AnalysisItemsLimitConfiguration","description":"The limit on the number of groups that are displayed in a word cloud."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisFieldSortOptions"},"description":"The sort configuration of group by fields."}},"type":"object"},"aws-native:quicksight:AnalysisWordCloudVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:AnalysisWordCloudChartConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:AnalysisColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:AnalysisVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:AnalysisWordCloudWordCasing":{"type":"string","enum":[{"name":"LowerCase","value":"LOWER_CASE"},{"name":"ExistingCase","value":"EXISTING_CASE"}]},"aws-native:quicksight:AnalysisWordCloudWordOrientation":{"type":"string","enum":[{"name":"Horizontal","value":"HORIZONTAL"},{"name":"HorizontalAndVertical","value":"HORIZONTAL_AND_VERTICAL"}]},"aws-native:quicksight:AnalysisWordCloudWordPadding":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Small","value":"SMALL"},{"name":"Medium","value":"MEDIUM"},{"name":"Large","value":"LARGE"}]},"aws-native:quicksight:AnalysisWordCloudWordScaling":{"type":"string","enum":[{"name":"Emphasize","value":"EMPHASIZE"},{"name":"Normal","value":"NORMAL"}]},"aws-native:quicksight:AnalysisYAxisOptions":{"properties":{"yAxis":{"$ref":"#/types/aws-native:quicksight:AnalysisSingleYAxisOption","description":"The Y axis type to be used in the chart.\n\nIf you choose `PRIMARY_Y_AXIS` , the primary Y Axis is located on the leftmost vertical axis of the chart."}},"type":"object","required":["yAxis"]},"aws-native:quicksight:CustomPermissionsCapabilities":{"properties":{"action":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState"},"addOrRunAnomalyDetectionForAnalyses":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to add or run anomaly detection."},"analysis":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to perform analysis-related actions."},"automate":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState"},"chatAgent":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState"},"createAndUpdateDashboardEmailReports":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to create and update email reports."},"createAndUpdateDataSources":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to create and update data sources."},"createAndUpdateDatasets":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to create and update datasets."},"createAndUpdateThemes":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to export to Create and Update themes."},"createAndUpdateThresholdAlerts":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to create and update threshold alerts."},"createChatAgents":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState"},"createSharedFolders":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to create shared folders."},"createSpiceDataset":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to create a SPICE dataset."},"dashboard":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to perform dashboard-related actions."},"exportToCsv":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to export to CSV files from the UI."},"exportToCsvInScheduledReports":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to export to CSV files in scheduled email reports."},"exportToExcel":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to export to Excel files from the UI."},"exportToExcelInScheduledReports":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to export to Excel files in scheduled email reports."},"exportToPdf":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to export to PDF files from the UI."},"exportToPdfInScheduledReports":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to export to PDF files in scheduled email reports."},"flow":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState"},"includeContentInScheduledReportsEmail":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to include content in scheduled email reports."},"knowledgeBase":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState"},"performFlowUiTask":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState"},"printReports":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to print reports."},"publishWithoutApproval":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState"},"renameSharedFolders":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to rename shared folders."},"research":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState"},"shareAnalyses":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to share analyses."},"shareDashboards":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to share dashboards."},"shareDataSources":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to share data sources."},"shareDatasets":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to share datasets."},"space":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState"},"subscribeDashboardEmailReports":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to subscribe to email reports."},"useAgentWebSearch":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState"},"useBedrockModels":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState"},"viewAccountSpiceCapacity":{"$ref":"#/types/aws-native:quicksight:CustomPermissionsCapabilityState","description":"The ability to view account SPICE capacity."}},"type":"object"},"aws-native:quicksight:CustomPermissionsCapabilityState":{"type":"string","enum":[{"name":"Deny","value":"DENY"}]},"aws-native:quicksight:CustomPermissionsTag":{"description":"\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n            resource.\u003c/p\u003e","properties":{"key":{"type":"string","description":"\u003cp\u003eTag key.\u003c/p\u003e"},"value":{"type":"string","description":"\u003cp\u003eTag value.\u003c/p\u003e"}},"type":"object","required":["key","value"]},"aws-native:quicksight:DashboardAdHocFilteringOption":{"description":"\u003cp\u003eAn ad hoc (one-time) filtering option.\u003c/p\u003e","properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"Availability status."}},"type":"object"},"aws-native:quicksight:DashboardAggregationFunction":{"properties":{"attributeAggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardAttributeAggregationFunction","description":"Aggregation for attributes."},"categoricalAggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardCategoricalAggregationFunction","description":"Aggregation for categorical values.\n\n- `COUNT` : Aggregate by the total number of values, including duplicates.\n- `DISTINCT_COUNT` : Aggregate by the total number of distinct values."},"dateAggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardDateAggregationFunction","description":"Aggregation for date values.\n\n- `COUNT` : Aggregate by the total number of values, including duplicates.\n- `DISTINCT_COUNT` : Aggregate by the total number of distinct values.\n- `MIN` : Select the smallest date value.\n- `MAX` : Select the largest date value."},"numericalAggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardNumericalAggregationFunction","description":"Aggregation for numerical values."}},"type":"object"},"aws-native:quicksight:DashboardAggregationSortConfiguration":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardAggregationFunction","description":"The function that aggregates the values in `Column` ."},"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that determines the sort order of aggregated values."},"sortDirection":{"$ref":"#/types/aws-native:quicksight:DashboardSortDirection","description":"The sort direction of values.\n\n- `ASC` : Sort in ascending order.\n- `DESC` : Sort in descending order."}},"type":"object","required":["column","sortDirection"]},"aws-native:quicksight:DashboardAllSheetsFilterScopeConfiguration":{"type":"object"},"aws-native:quicksight:DashboardAnalysisDefaults":{"properties":{"defaultNewSheetConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultNewSheetConfiguration","description":"The configuration for default new sheet settings."}},"type":"object","required":["defaultNewSheetConfiguration"]},"aws-native:quicksight:DashboardAnchorDateConfiguration":{"properties":{"anchorOption":{"$ref":"#/types/aws-native:quicksight:DashboardAnchorOption","description":"The options for the date configuration. Choose one of the options below:\n\n- `NOW`"},"parameterName":{"type":"string","description":"The name of the parameter that is used for the anchor date configuration."}},"type":"object"},"aws-native:quicksight:DashboardAnchorOption":{"type":"string","enum":[{"name":"Now","value":"NOW"}]},"aws-native:quicksight:DashboardArcAxisConfiguration":{"properties":{"range":{"$ref":"#/types/aws-native:quicksight:DashboardArcAxisDisplayRange","description":"The arc axis range of a `GaugeChartVisual` ."},"reserveRange":{"type":"number","description":"The reserved range of the arc axis."}},"type":"object"},"aws-native:quicksight:DashboardArcAxisDisplayRange":{"properties":{"max":{"type":"number","description":"The maximum value of the arc axis range."},"min":{"type":"number","description":"The minimum value of the arc axis range."}},"type":"object"},"aws-native:quicksight:DashboardArcConfiguration":{"properties":{"arcAngle":{"type":"number","description":"The option that determines the arc angle of a `GaugeChartVisual` ."},"arcThickness":{"$ref":"#/types/aws-native:quicksight:DashboardArcThicknessOptions","description":"The options that determine the arc thickness of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:DashboardArcOptions":{"properties":{"arcThickness":{"$ref":"#/types/aws-native:quicksight:DashboardArcThickness","description":"The arc thickness of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:DashboardArcThickness":{"type":"string","enum":[{"name":"Small","value":"SMALL"},{"name":"Medium","value":"MEDIUM"},{"name":"Large","value":"LARGE"},{"name":"Whole","value":"WHOLE"}]},"aws-native:quicksight:DashboardArcThicknessOptions":{"type":"string","enum":[{"name":"Small","value":"SMALL"},{"name":"Medium","value":"MEDIUM"},{"name":"Large","value":"LARGE"}]},"aws-native:quicksight:DashboardAssetOptions":{"properties":{"excludedDataSetArns":{"type":"array","items":{"type":"string"},"description":"A list of dataset ARNS to exclude from Dashboard Q\u0026A."},"qBusinessInsightsStatus":{"$ref":"#/types/aws-native:quicksight:DashboardQBusinessInsightsStatus","description":"Determines whether insight summaries from Amazon Q Business are allowed in Dashboard Q\u0026A."},"timezone":{"type":"string","description":"Determines the timezone for the analysis."},"weekStart":{"$ref":"#/types/aws-native:quicksight:DashboardDayOfTheWeek","description":"Determines the week start day for an analysis."}},"type":"object"},"aws-native:quicksight:DashboardAttributeAggregationFunction":{"properties":{"simpleAttributeAggregation":{"$ref":"#/types/aws-native:quicksight:DashboardSimpleAttributeAggregationFunction","description":"The built-in aggregation functions for attributes.\n\n- `UNIQUE_VALUE` : Returns the unique value for a field, aggregated by the dimension fields."},"valueForMultipleValues":{"type":"string","description":"Used by the `UNIQUE_VALUE` aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to '*'."}},"type":"object"},"aws-native:quicksight:DashboardAxisBinding":{"type":"string","enum":[{"name":"PrimaryYaxis","value":"PRIMARY_YAXIS"},{"name":"SecondaryYaxis","value":"SECONDARY_YAXIS"}]},"aws-native:quicksight:DashboardAxisDataOptions":{"properties":{"dateAxisOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDateAxisOptions","description":"The options for an axis with a date field."},"numericAxisOptions":{"$ref":"#/types/aws-native:quicksight:DashboardNumericAxisOptions","description":"The options for an axis with a numeric field."}},"type":"object"},"aws-native:quicksight:DashboardAxisDisplayDataDrivenRange":{"type":"object"},"aws-native:quicksight:DashboardAxisDisplayMinMaxRange":{"properties":{"maximum":{"type":"number","description":"The maximum setup for an axis display range."},"minimum":{"type":"number","description":"The minimum setup for an axis display range."}},"type":"object"},"aws-native:quicksight:DashboardAxisDisplayOptions":{"properties":{"axisLineVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines whether or not the axis line is visible."},"axisOffset":{"type":"string","description":"String based length that is composed of value and unit in px"},"dataOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDataOptions","description":"The data options for an axis."},"gridLineVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines whether or not the grid line is visible."},"scrollbarOptions":{"$ref":"#/types/aws-native:quicksight:DashboardScrollBarOptions","description":"The scroll bar options for an axis."},"tickLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisTickLabelOptions","description":"The tick label options of an axis."}},"type":"object"},"aws-native:quicksight:DashboardAxisDisplayRange":{"properties":{"dataDriven":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayDataDrivenRange","description":"The data-driven setup of an axis display range."},"minMax":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayMinMaxRange","description":"The minimum and maximum setup of an axis display range."}},"type":"object"},"aws-native:quicksight:DashboardAxisLabelOptions":{"properties":{"applyTo":{"$ref":"#/types/aws-native:quicksight:DashboardAxisLabelReferenceOptions","description":"The options that indicate which field the label belongs to."},"customLabel":{"type":"string","description":"The text for the axis label."},"fontConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFontConfiguration","description":"The font configuration of the axis label."}},"type":"object"},"aws-native:quicksight:DashboardAxisLabelReferenceOptions":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the axis label is targeted to."},"fieldId":{"type":"string","description":"The field that the axis label is targeted to."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:DashboardAxisLinearScale":{"properties":{"stepCount":{"type":"number","description":"The step count setup of a linear axis."},"stepSize":{"type":"number","description":"The step size setup of a linear axis."}},"type":"object"},"aws-native:quicksight:DashboardAxisLogarithmicScale":{"properties":{"base":{"type":"number","description":"The base setup of a logarithmic axis scale."}},"type":"object"},"aws-native:quicksight:DashboardAxisScale":{"properties":{"linear":{"$ref":"#/types/aws-native:quicksight:DashboardAxisLinearScale","description":"The linear axis scale setup."},"logarithmic":{"$ref":"#/types/aws-native:quicksight:DashboardAxisLogarithmicScale","description":"The logarithmic axis scale setup."}},"type":"object"},"aws-native:quicksight:DashboardAxisTickLabelOptions":{"properties":{"labelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardLabelOptions","description":"Determines whether or not the axis ticks are visible."},"rotationAngle":{"type":"number","description":"The rotation angle of the axis tick labels."}},"type":"object"},"aws-native:quicksight:DashboardBarChartAggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The category (y-axis) field well of a bar chart."},"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The color (group/color) field well of a bar chart."},"smallMultiples":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The small multiples field well of a bar chart."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The value field wells of a bar chart. Values are aggregated by category."}},"type":"object"},"aws-native:quicksight:DashboardBarChartConfiguration":{"properties":{"barsArrangement":{"$ref":"#/types/aws-native:quicksight:DashboardBarsArrangement","description":"Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual."},"categoryAxis":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The label display options (grid line, range, scale, axis step) for bar chart category."},"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility and sort icon visibility) for a bar chart."},"colorLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart."},"contributionAnalysisDefaults":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardContributionAnalysisDefault"},"description":"The contribution analysis (anomaly configuration) setup of the visual."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOptions","description":"The options that determine if visual data labels are displayed."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardBarChartFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions","description":"The legend display setup of the visual."},"orientation":{"$ref":"#/types/aws-native:quicksight:DashboardBarChartOrientation","description":"The orientation of the bars in a bar chart visual. There are two valid values in this structure:\n\n- `HORIZONTAL` : Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.\n- `VERTICAL` : Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts."},"referenceLines":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLine"},"description":"The reference line setup of the visual."},"smallMultiplesOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSmallMultiplesOptions","description":"The small multiples setup for the visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardBarChartSortConfiguration","description":"The sort configuration of a `BarChartVisual` ."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The tooltip display setup of the visual."},"valueAxis":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The label display options (grid line, range, scale, axis step) for a bar chart value."},"valueLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility and sort icon visibility) for a bar chart value."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPalette","description":"The palette (chart color) display setup of the visual."}},"type":"object"},"aws-native:quicksight:DashboardBarChartFieldWells":{"properties":{"barChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardBarChartAggregatedFieldWells","description":"The aggregated field wells of a bar chart."}},"type":"object"},"aws-native:quicksight:DashboardBarChartOrientation":{"type":"string","enum":[{"name":"Horizontal","value":"HORIZONTAL"},{"name":"Vertical","value":"VERTICAL"}]},"aws-native:quicksight:DashboardBarChartSortConfiguration":{"properties":{"categoryItemsLimit":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of categories displayed in a bar chart."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of category fields."},"colorItemsLimit":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of values displayed in a bar chart."},"colorSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of color fields in a bar chart."},"smallMultiplesLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of small multiples panels that are displayed."},"smallMultiplesSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of the small multiples field."}},"type":"object"},"aws-native:quicksight:DashboardBarChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardBarChartConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardBarsArrangement":{"type":"string","enum":[{"name":"Clustered","value":"CLUSTERED"},{"name":"Stacked","value":"STACKED"},{"name":"StackedPercent","value":"STACKED_PERCENT"}]},"aws-native:quicksight:DashboardBaseMapStyleType":{"type":"string","enum":[{"name":"LightGray","value":"LIGHT_GRAY"},{"name":"DarkGray","value":"DARK_GRAY"},{"name":"Street","value":"STREET"},{"name":"Imagery","value":"IMAGERY"}]},"aws-native:quicksight:DashboardBehavior":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:DashboardBinCountOptions":{"properties":{"value":{"type":"number","description":"The options that determine the bin count value."}},"type":"object"},"aws-native:quicksight:DashboardBinWidthOptions":{"properties":{"binCountLimit":{"type":"number","description":"The options that determine the bin count limit."},"value":{"type":"number","description":"The options that determine the bin width value."}},"type":"object"},"aws-native:quicksight:DashboardBodySectionConfiguration":{"properties":{"content":{"$ref":"#/types/aws-native:quicksight:DashboardBodySectionContent","description":"The configuration of content in a body section."},"pageBreakConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardSectionPageBreakConfiguration","description":"The configuration of a page break for a section."},"repeatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardBodySectionRepeatConfiguration","description":"Describes the configurations that are required to declare a section as repeating."},"sectionId":{"type":"string","description":"The unique identifier of a body section."},"style":{"$ref":"#/types/aws-native:quicksight:DashboardSectionStyle","description":"The style options of a body section."}},"type":"object","required":["content","sectionId"]},"aws-native:quicksight:DashboardBodySectionContent":{"properties":{"layout":{"$ref":"#/types/aws-native:quicksight:DashboardSectionLayoutConfiguration","description":"The layout configuration of a body section."}},"type":"object"},"aws-native:quicksight:DashboardBodySectionDynamicCategoryDimensionConfiguration":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier"},"limit":{"type":"number","description":"Number of values to use from the column for repetition."},"sortByMetrics":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnSort"},"description":"Sort criteria on the column values that you use for repetition."}},"type":"object","required":["column"]},"aws-native:quicksight:DashboardBodySectionDynamicNumericDimensionConfiguration":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier"},"limit":{"type":"number","description":"Number of values to use from the column for repetition."},"sortByMetrics":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnSort"},"description":"Sort criteria on the column values that you use for repetition."}},"type":"object","required":["column"]},"aws-native:quicksight:DashboardBodySectionRepeatConfiguration":{"properties":{"dimensionConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardBodySectionRepeatDimensionConfiguration"},"description":"List of `BodySectionRepeatDimensionConfiguration` values that describe the dataset column and constraints for the column used to repeat the contents of a section."},"nonRepeatingVisuals":{"type":"array","items":{"type":"string"},"description":"List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances."},"pageBreakConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardBodySectionRepeatPageBreakConfiguration","description":"Page break configuration to apply for each repeating instance."}},"type":"object"},"aws-native:quicksight:DashboardBodySectionRepeatDimensionConfiguration":{"properties":{"dynamicCategoryDimensionConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardBodySectionDynamicCategoryDimensionConfiguration","description":"Describes the *Category* dataset column and constraints around the dynamic values that will be used in repeating the section contents."},"dynamicNumericDimensionConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardBodySectionDynamicNumericDimensionConfiguration","description":"Describes the *Numeric* dataset column and constraints around the dynamic values used to repeat the contents of a section."}},"type":"object"},"aws-native:quicksight:DashboardBodySectionRepeatPageBreakConfiguration":{"properties":{"after":{"$ref":"#/types/aws-native:quicksight:DashboardSectionAfterPageBreak"}},"type":"object"},"aws-native:quicksight:DashboardBoxPlotAggregatedFieldWells":{"properties":{"groupBy":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The group by field well of a box plot chart. Values are grouped based on group by fields."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The value field well of a box plot chart. Values are aggregated based on group by fields."}},"type":"object"},"aws-native:quicksight:DashboardBoxPlotChartConfiguration":{"properties":{"boxPlotOptions":{"$ref":"#/types/aws-native:quicksight:DashboardBoxPlotOptions","description":"The box plot chart options for a box plot visual"},"categoryAxis":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The label display options (grid line, range, scale, axis step) of a box plot category."},"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility and sort Icon visibility) of a box plot category."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardBoxPlotFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions"},"primaryYAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The label display options (grid line, range, scale, axis step) of a box plot category."},"primaryYAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility and sort icon visibility) of a box plot value."},"referenceLines":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLine"},"description":"The reference line setup of the visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardBoxPlotSortConfiguration","description":"The sort configuration of a `BoxPlotVisual` ."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The tooltip display setup of the visual."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPalette","description":"The palette (chart color) display setup of the visual."}},"type":"object"},"aws-native:quicksight:DashboardBoxPlotFieldWells":{"properties":{"boxPlotAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardBoxPlotAggregatedFieldWells","description":"The aggregated field wells of a box plot."}},"type":"object"},"aws-native:quicksight:DashboardBoxPlotFillStyle":{"type":"string","enum":[{"name":"Solid","value":"SOLID"},{"name":"Transparent","value":"TRANSPARENT"}]},"aws-native:quicksight:DashboardBoxPlotOptions":{"properties":{"allDataPointsVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines the visibility of all data points of the box plot."},"outlierVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines the visibility of the outlier in a box plot."},"styleOptions":{"$ref":"#/types/aws-native:quicksight:DashboardBoxPlotStyleOptions","description":"The style options of the box plot."}},"type":"object"},"aws-native:quicksight:DashboardBoxPlotSortConfiguration":{"properties":{"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of a group by fields."},"paginationConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardPaginationConfiguration","description":"The pagination configuration of a table visual or box plot."}},"type":"object"},"aws-native:quicksight:DashboardBoxPlotStyleOptions":{"properties":{"fillStyle":{"$ref":"#/types/aws-native:quicksight:DashboardBoxPlotFillStyle","description":"The fill styles (solid, transparent) of the box plot."}},"type":"object"},"aws-native:quicksight:DashboardBoxPlotVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardBoxPlotChartConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardCalculatedField":{"properties":{"dataSetIdentifier":{"type":"string","description":"The data set that is used in this calculated field."},"expression":{"type":"string","description":"The expression of the calculated field."},"name":{"type":"string","description":"The name of the calculated field."}},"type":"object","required":["dataSetIdentifier","expression","name"]},"aws-native:quicksight:DashboardCalculatedMeasureField":{"properties":{"expression":{"type":"string","description":"The expression in the table calculation."},"fieldId":{"type":"string","description":"The custom field ID."}},"type":"object","required":["expression","fieldId"]},"aws-native:quicksight:DashboardCascadingControlConfiguration":{"properties":{"sourceControls":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardCascadingControlSource"},"description":"A list of source controls that determine the values that are used in the current control."}},"type":"object"},"aws-native:quicksight:DashboardCascadingControlSource":{"properties":{"columnToMatch":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column identifier that determines which column to look up for the source sheet control."},"sourceSheetControlId":{"type":"string","description":"The source sheet control ID of a `CascadingControlSource` ."}},"type":"object"},"aws-native:quicksight:DashboardCategoricalAggregationFunction":{"type":"string","enum":[{"name":"Count","value":"COUNT"},{"name":"DistinctCount","value":"DISTINCT_COUNT"}]},"aws-native:quicksight:DashboardCategoricalDimensionField":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that is used in the `CategoricalDimensionField` ."},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardStringFormatConfiguration","description":"The format configuration of the field."},"hierarchyId":{"type":"string","description":"The custom hierarchy ID."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:DashboardCategoricalMeasureField":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardCategoricalAggregationFunction","description":"The aggregation function of the measure field."},"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that is used in the `CategoricalMeasureField` ."},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardStringFormatConfiguration","description":"The format configuration of the field."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:DashboardCategoryDrillDownFilter":{"properties":{"categoryValues":{"type":"array","items":{"type":"string"},"description":"A list of the string inputs that are the values of the category drill down filter."},"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the filter is applied to."}},"type":"object","required":["categoryValues","column"]},"aws-native:quicksight:DashboardCategoryFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the filter is applied to."},"configuration":{"$ref":"#/types/aws-native:quicksight:DashboardCategoryFilterConfiguration","description":"The configuration for a `CategoryFilter` ."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."}},"type":"object","required":["column","configuration","filterId"]},"aws-native:quicksight:DashboardCategoryFilterConfiguration":{"properties":{"customFilterConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardCustomFilterConfiguration","description":"A custom filter that filters based on a single value. This filter can be partially matched."},"customFilterListConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardCustomFilterListConfiguration","description":"A list of custom filter values. In the Quick Sight console, this filter type is called a custom filter list."},"filterListConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFilterListConfiguration","description":"A list of filter configurations. In the Quick Sight console, this filter type is called a filter list."}},"type":"object"},"aws-native:quicksight:DashboardCategoryFilterMatchOperator":{"type":"string","enum":[{"name":"Equals","value":"EQUALS"},{"name":"DoesNotEqual","value":"DOES_NOT_EQUAL"},{"name":"Contains","value":"CONTAINS"},{"name":"DoesNotContain","value":"DOES_NOT_CONTAIN"},{"name":"StartsWith","value":"STARTS_WITH"},{"name":"EndsWith","value":"ENDS_WITH"}]},"aws-native:quicksight:DashboardCategoryFilterSelectAllOptions":{"type":"string","enum":[{"name":"FilterAllValues","value":"FILTER_ALL_VALUES"}]},"aws-native:quicksight:DashboardCategoryInnerFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier"},"configuration":{"$ref":"#/types/aws-native:quicksight:DashboardCategoryFilterConfiguration"},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultFilterControlConfiguration"}},"type":"object","required":["column","configuration"]},"aws-native:quicksight:DashboardChartAxisLabelOptions":{"properties":{"axisLabelOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardAxisLabelOptions"},"description":"The label options for a chart axis."},"sortIconVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility configuration of the sort icon on a chart's axis label."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of an axis label on a chart. Choose one of the following options:\n\n- `VISIBLE` : Shows the axis.\n- `HIDDEN` : Hides the axis."}},"type":"object"},"aws-native:quicksight:DashboardClusterMarker":{"properties":{"simpleClusterMarker":{"$ref":"#/types/aws-native:quicksight:DashboardSimpleClusterMarker","description":"The simple cluster marker of the cluster marker."}},"type":"object"},"aws-native:quicksight:DashboardClusterMarkerConfiguration":{"properties":{"clusterMarker":{"$ref":"#/types/aws-native:quicksight:DashboardClusterMarker","description":"The cluster marker that is a part of the cluster marker configuration."}},"type":"object"},"aws-native:quicksight:DashboardColorFillType":{"type":"string","enum":[{"name":"Discrete","value":"DISCRETE"},{"name":"Gradient","value":"GRADIENT"}]},"aws-native:quicksight:DashboardColorScale":{"properties":{"colorFillType":{"$ref":"#/types/aws-native:quicksight:DashboardColorFillType","description":"Determines the color fill type."},"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDataColor"},"description":"Determines the list of colors that are applied to the visual."},"nullValueColor":{"$ref":"#/types/aws-native:quicksight:DashboardDataColor","description":"Determines the color that is applied to null values."}},"type":"object","required":["colorFillType","colors"]},"aws-native:quicksight:DashboardColorsConfiguration":{"properties":{"customColors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardCustomColor"},"description":"A list of up to 50 custom colors."}},"type":"object"},"aws-native:quicksight:DashboardColumnConfiguration":{"properties":{"colorsConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardColorsConfiguration","description":"The color configurations of the column."},"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFormatConfiguration","description":"The format configuration of a column."},"role":{"$ref":"#/types/aws-native:quicksight:DashboardColumnRole","description":"The role of the column."}},"type":"object","required":["column"]},"aws-native:quicksight:DashboardColumnHierarchy":{"properties":{"dateTimeHierarchy":{"$ref":"#/types/aws-native:quicksight:DashboardDateTimeHierarchy","description":"The option that determines the hierarchy of any `DateTime` fields."},"explicitHierarchy":{"$ref":"#/types/aws-native:quicksight:DashboardExplicitHierarchy","description":"The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals."},"predefinedHierarchy":{"$ref":"#/types/aws-native:quicksight:DashboardPredefinedHierarchy","description":"The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source."}},"type":"object"},"aws-native:quicksight:DashboardColumnIdentifier":{"properties":{"columnName":{"type":"string","description":"The name of the column."},"dataSetIdentifier":{"type":"string","description":"The data set that the column belongs to."}},"type":"object","required":["columnName","dataSetIdentifier"]},"aws-native:quicksight:DashboardColumnRole":{"type":"string","enum":[{"name":"Dimension","value":"DIMENSION"},{"name":"Measure","value":"MEASURE"}]},"aws-native:quicksight:DashboardColumnSort":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardAggregationFunction","description":"The aggregation function that is defined in the column sort."},"direction":{"$ref":"#/types/aws-native:quicksight:DashboardSortDirection","description":"The sort direction."},"sortBy":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier"}},"type":"object","required":["direction","sortBy"]},"aws-native:quicksight:DashboardColumnTooltipItem":{"properties":{"aggregation":{"$ref":"#/types/aws-native:quicksight:DashboardAggregationFunction","description":"The aggregation function of the column tooltip item."},"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The target column of the tooltip item."},"label":{"type":"string","description":"The label of the tooltip item."},"tooltipTarget":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipTarget","description":"Determines the target of the column tooltip item in a combo chart visual."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the tooltip item."}},"type":"object","required":["column"]},"aws-native:quicksight:DashboardComboChartAggregatedFieldWells":{"properties":{"barValues":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The aggregated `BarValues` field well of a combo chart."},"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The aggregated category field wells of a combo chart."},"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The aggregated colors field well of a combo chart."},"lineValues":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The aggregated `LineValues` field well of a combo chart."}},"type":"object"},"aws-native:quicksight:DashboardComboChartConfiguration":{"properties":{"barDataLabels":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOptions","description":"The options that determine if visual data labels are displayed.\n\nThe data label options for a bar in a combo chart."},"barsArrangement":{"$ref":"#/types/aws-native:quicksight:DashboardBarsArrangement","description":"Determines the bar arrangement in a combo chart. The following are valid values in this structure:\n\n- `CLUSTERED` : For clustered bar combo charts.\n- `STACKED` : For stacked bar combo charts.\n- `STACKED_PERCENT` : Do not use. If you use this value, the operation returns a validation error."},"categoryAxis":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The category axis of a combo chart."},"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well."},"colorLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardComboChartFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions","description":"The legend display setup of the visual."},"lineDataLabels":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOptions","description":"The options that determine if visual data labels are displayed.\n\nThe data label options for a line in a combo chart."},"primaryYAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well."},"primaryYAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well."},"referenceLines":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLine"},"description":"The reference line setup of the visual."},"secondaryYAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well."},"secondaryYAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well."},"singleAxisOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSingleAxisOptions"},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardComboChartSortConfiguration","description":"The sort configuration of a `ComboChartVisual` ."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The legend display setup of the visual."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPalette","description":"The palette (chart color) display setup of the visual."}},"type":"object"},"aws-native:quicksight:DashboardComboChartFieldWells":{"properties":{"comboChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardComboChartAggregatedFieldWells","description":"The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category."}},"type":"object"},"aws-native:quicksight:DashboardComboChartSortConfiguration":{"properties":{"categoryItemsLimit":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The item limit configuration for the category field well of a combo chart."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of the category field well in a combo chart."},"colorItemsLimit":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The item limit configuration of the color field well in a combo chart."},"colorSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of the color field well in a combo chart."}},"type":"object"},"aws-native:quicksight:DashboardComboChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardComboChartConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardCommitMode":{"type":"string","enum":[{"name":"Auto","value":"AUTO"},{"name":"Manual","value":"MANUAL"}]},"aws-native:quicksight:DashboardComparisonConfiguration":{"properties":{"comparisonFormat":{"$ref":"#/types/aws-native:quicksight:DashboardComparisonFormatConfiguration","description":"The format of the comparison."},"comparisonMethod":{"$ref":"#/types/aws-native:quicksight:DashboardComparisonMethod","description":"The method of the comparison. Choose from the following options:\n\n- `DIFFERENCE`\n- `PERCENT_DIFFERENCE`\n- `PERCENT`"}},"type":"object"},"aws-native:quicksight:DashboardComparisonFormatConfiguration":{"properties":{"numberDisplayFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNumberDisplayFormatConfiguration","description":"The number display format."},"percentageDisplayFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardPercentageDisplayFormatConfiguration","description":"The percentage display format."}},"type":"object"},"aws-native:quicksight:DashboardComparisonMethod":{"type":"string","enum":[{"name":"Difference","value":"DIFFERENCE"},{"name":"PercentDifference","value":"PERCENT_DIFFERENCE"},{"name":"Percent","value":"PERCENT"}]},"aws-native:quicksight:DashboardComputation":{"properties":{"forecast":{"$ref":"#/types/aws-native:quicksight:DashboardForecastComputation","description":"The forecast computation configuration."},"growthRate":{"$ref":"#/types/aws-native:quicksight:DashboardGrowthRateComputation","description":"The growth rate computation configuration."},"maximumMinimum":{"$ref":"#/types/aws-native:quicksight:DashboardMaximumMinimumComputation","description":"The maximum and minimum computation configuration."},"metricComparison":{"$ref":"#/types/aws-native:quicksight:DashboardMetricComparisonComputation","description":"The metric comparison computation configuration."},"periodOverPeriod":{"$ref":"#/types/aws-native:quicksight:DashboardPeriodOverPeriodComputation","description":"The period over period computation configuration."},"periodToDate":{"$ref":"#/types/aws-native:quicksight:DashboardPeriodToDateComputation","description":"The period to `DataSetIdentifier` computation configuration."},"topBottomMovers":{"$ref":"#/types/aws-native:quicksight:DashboardTopBottomMoversComputation","description":"The top movers and bottom movers computation configuration."},"topBottomRanked":{"$ref":"#/types/aws-native:quicksight:DashboardTopBottomRankedComputation","description":"The top ranked and bottom ranked computation configuration."},"totalAggregation":{"$ref":"#/types/aws-native:quicksight:DashboardTotalAggregationComputation","description":"The total aggregation computation configuration."},"uniqueValues":{"$ref":"#/types/aws-native:quicksight:DashboardUniqueValuesComputation","description":"The unique values computation configuration."}},"type":"object"},"aws-native:quicksight:DashboardConditionalFormattingColor":{"properties":{"gradient":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingGradientColor","description":"Formatting configuration for gradient color."},"solid":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingSolidColor","description":"Formatting configuration for solid color."}},"type":"object"},"aws-native:quicksight:DashboardConditionalFormattingCustomIconCondition":{"properties":{"color":{"type":"string","description":"Determines the color of the icon."},"displayConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingIconDisplayConfiguration","description":"Determines the icon display configuration."},"expression":{"type":"string","description":"The expression that determines the condition of the icon set."},"iconOptions":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingCustomIconOptions","description":"Custom icon options for an icon set."}},"type":"object","required":["expression","iconOptions"]},"aws-native:quicksight:DashboardConditionalFormattingCustomIconOptions":{"properties":{"icon":{"$ref":"#/types/aws-native:quicksight:DashboardIcon","description":"Determines the type of icon."},"unicodeIcon":{"type":"string","description":"Determines the Unicode icon type."}},"type":"object"},"aws-native:quicksight:DashboardConditionalFormattingGradientColor":{"properties":{"color":{"$ref":"#/types/aws-native:quicksight:DashboardGradientColor","description":"Determines the color."},"expression":{"type":"string","description":"The expression that determines the formatting configuration for gradient color."}},"type":"object","required":["color","expression"]},"aws-native:quicksight:DashboardConditionalFormattingIcon":{"properties":{"customCondition":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingCustomIconCondition","description":"Determines the custom condition for an icon set."},"iconSet":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingIconSet","description":"Formatting configuration for icon set."}},"type":"object"},"aws-native:quicksight:DashboardConditionalFormattingIconDisplayConfiguration":{"properties":{"iconDisplayOption":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingIconDisplayOption","description":"Determines the icon display configuration."}},"type":"object"},"aws-native:quicksight:DashboardConditionalFormattingIconDisplayOption":{"type":"string","enum":[{"name":"IconOnly","value":"ICON_ONLY"}]},"aws-native:quicksight:DashboardConditionalFormattingIconSet":{"properties":{"expression":{"type":"string","description":"The expression that determines the formatting configuration for the icon set."},"iconSetType":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingIconSetType","description":"Determines the icon set type."}},"type":"object","required":["expression"]},"aws-native:quicksight:DashboardConditionalFormattingIconSetType":{"type":"string","enum":[{"name":"PlusMinus","value":"PLUS_MINUS"},{"name":"CheckX","value":"CHECK_X"},{"name":"ThreeColorArrow","value":"THREE_COLOR_ARROW"},{"name":"ThreeGrayArrow","value":"THREE_GRAY_ARROW"},{"name":"CaretUpMinusDown","value":"CARET_UP_MINUS_DOWN"},{"name":"ThreeShape","value":"THREE_SHAPE"},{"name":"ThreeCircle","value":"THREE_CIRCLE"},{"name":"Flags","value":"FLAGS"},{"name":"Bars","value":"BARS"},{"name":"FourColorArrow","value":"FOUR_COLOR_ARROW"},{"name":"FourGrayArrow","value":"FOUR_GRAY_ARROW"}]},"aws-native:quicksight:DashboardConditionalFormattingSolidColor":{"properties":{"color":{"type":"string","description":"Determines the color."},"expression":{"type":"string","description":"The expression that determines the formatting configuration for solid color."}},"type":"object","required":["expression"]},"aws-native:quicksight:DashboardContextMenuOption":{"properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"The availability status of the context menu options. If the value of this property is set to `ENABLED` , dashboard readers can interact with the context menu."}},"type":"object"},"aws-native:quicksight:DashboardContributionAnalysisDefault":{"properties":{"contributorDimensions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier"},"description":"The dimensions columns that are used in the contribution analysis, usually a list of `ColumnIdentifiers` ."},"measureFieldId":{"type":"string","description":"The measure field that is used in the contribution analysis."}},"type":"object","required":["contributorDimensions","measureFieldId"]},"aws-native:quicksight:DashboardCrossDatasetTypes":{"type":"string","enum":[{"name":"AllDatasets","value":"ALL_DATASETS"},{"name":"SingleDataset","value":"SINGLE_DATASET"}]},"aws-native:quicksight:DashboardCurrencyDisplayFormatConfiguration":{"properties":{"decimalPlacesConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDecimalPlacesConfiguration","description":"The option that determines the decimal places configuration."},"negativeValueConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNegativeValueConfiguration","description":"The options that determine the negative value configuration."},"nullValueFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNullValueFormatConfiguration","description":"The options that determine the null value format configuration."},"numberScale":{"$ref":"#/types/aws-native:quicksight:DashboardNumberScale","description":"Determines the number scale value for the currency format."},"prefix":{"type":"string","description":"Determines the prefix value of the currency format."},"separatorConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNumericSeparatorConfiguration","description":"The options that determine the numeric separator configuration."},"suffix":{"type":"string","description":"Determines the suffix value of the currency format."},"symbol":{"type":"string","description":"Determines the symbol for the currency format."}},"type":"object"},"aws-native:quicksight:DashboardCustomActionFilterOperation":{"properties":{"selectedFieldsConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFilterOperationSelectedFieldsConfiguration","description":"The configuration that chooses the fields to be filtered."},"targetVisualsConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFilterOperationTargetVisualsConfiguration","description":"The configuration that chooses the target visuals to be filtered."}},"type":"object","required":["selectedFieldsConfiguration","targetVisualsConfiguration"]},"aws-native:quicksight:DashboardCustomActionNavigationOperation":{"properties":{"localNavigationConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardLocalNavigationConfiguration","description":"The configuration that chooses the navigation target."}},"type":"object"},"aws-native:quicksight:DashboardCustomActionSetParametersOperation":{"properties":{"parameterValueConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardSetParameterValueConfiguration"},"description":"The parameter that determines the value configuration."}},"type":"object","required":["parameterValueConfigurations"]},"aws-native:quicksight:DashboardCustomActionUrlOperation":{"properties":{"urlTarget":{"$ref":"#/types/aws-native:quicksight:DashboardUrlTargetConfiguration","description":"The target of the `CustomActionURLOperation` .\n\nValid values are defined as follows:\n\n- `NEW_TAB` : Opens the target URL in a new browser tab.\n- `NEW_WINDOW` : Opens the target URL in a new browser window.\n- `SAME_TAB` : Opens the target URL in the same browser tab."},"urlTemplate":{"type":"string","description":"THe URL link of the `CustomActionURLOperation` ."}},"type":"object","required":["urlTarget","urlTemplate"]},"aws-native:quicksight:DashboardCustomColor":{"properties":{"color":{"type":"string","description":"The color that is applied to the data value."},"fieldValue":{"type":"string","description":"The data value that the color is applied to."},"specialValue":{"$ref":"#/types/aws-native:quicksight:DashboardSpecialValue","description":"The value of a special data value."}},"type":"object","required":["color"]},"aws-native:quicksight:DashboardCustomContentConfiguration":{"properties":{"contentType":{"$ref":"#/types/aws-native:quicksight:DashboardCustomContentType","description":"The content type of the custom content visual. You can use this to have the visual render as an image."},"contentUrl":{"type":"string","description":"The input URL that links to the custom content that you want in the custom visual."},"imageScaling":{"$ref":"#/types/aws-native:quicksight:DashboardCustomContentImageScalingConfiguration","description":"The sizing options for the size of the custom content visual. This structure is required when the `ContentType` of the visual is `'IMAGE'` ."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."}},"type":"object"},"aws-native:quicksight:DashboardCustomContentImageScalingConfiguration":{"type":"string","enum":[{"name":"FitToHeight","value":"FIT_TO_HEIGHT"},{"name":"FitToWidth","value":"FIT_TO_WIDTH"},{"name":"DoNotScale","value":"DO_NOT_SCALE"},{"name":"ScaleToVisual","value":"SCALE_TO_VISUAL"}]},"aws-native:quicksight:DashboardCustomContentType":{"type":"string","enum":[{"name":"Image","value":"IMAGE"},{"name":"OtherEmbeddedContent","value":"OTHER_EMBEDDED_CONTENT"}]},"aws-native:quicksight:DashboardCustomContentVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardCustomContentConfiguration","description":"The configuration of a `CustomContentVisual` ."},"dataSetIdentifier":{"type":"string","description":"The dataset that is used to create the custom content visual. You can't create a visual without a dataset."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["dataSetIdentifier","visualId"]},"aws-native:quicksight:DashboardCustomFilterConfiguration":{"properties":{"categoryValue":{"type":"string","description":"The category value for the filter.\n\nThis field is mutually exclusive to `ParameterName` ."},"matchOperator":{"$ref":"#/types/aws-native:quicksight:DashboardCategoryFilterMatchOperator","description":"The match operator that is used to determine if a filter should be applied."},"nullOption":{"$ref":"#/types/aws-native:quicksight:DashboardFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"parameterName":{"type":"string","description":"The parameter whose value should be used for the filter value.\n\nThis field is mutually exclusive to `CategoryValue` ."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:DashboardCategoryFilterSelectAllOptions","description":"Select all of the values. Null is not the assigned value of select all.\n\n- `FILTER_ALL_VALUES`"}},"type":"object","required":["matchOperator","nullOption"]},"aws-native:quicksight:DashboardCustomFilterListConfiguration":{"properties":{"categoryValues":{"type":"array","items":{"type":"string"},"description":"The list of category values for the filter."},"matchOperator":{"$ref":"#/types/aws-native:quicksight:DashboardCategoryFilterMatchOperator","description":"The match operator that is used to determine if a filter should be applied."},"nullOption":{"$ref":"#/types/aws-native:quicksight:DashboardFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:DashboardCategoryFilterSelectAllOptions","description":"Select all of the values. Null is not the assigned value of select all.\n\n- `FILTER_ALL_VALUES`"}},"type":"object","required":["matchOperator","nullOption"]},"aws-native:quicksight:DashboardCustomNarrativeOptions":{"properties":{"narrative":{"type":"string","description":"The string input of custom narrative."}},"type":"object","required":["narrative"]},"aws-native:quicksight:DashboardCustomParameterValues":{"properties":{"dateTimeValues":{"type":"array","items":{"type":"string"},"description":"A list of datetime-type parameter values."},"decimalValues":{"type":"array","items":{"type":"number"},"description":"A list of decimal-type parameter values."},"integerValues":{"type":"array","items":{"type":"number"},"description":"A list of integer-type parameter values."},"stringValues":{"type":"array","items":{"type":"string"},"description":"A list of string-type parameter values."}},"type":"object"},"aws-native:quicksight:DashboardCustomValuesConfiguration":{"properties":{"customValues":{"$ref":"#/types/aws-native:quicksight:DashboardCustomParameterValues"},"includeNullValue":{"type":"boolean","description":"Includes the null value in custom action parameter values."}},"type":"object","required":["customValues"]},"aws-native:quicksight:DashboardDataBarsOptions":{"properties":{"fieldId":{"type":"string","description":"The field ID for the data bars options."},"negativeColor":{"type":"string","description":"The color of the negative data bar."},"positiveColor":{"type":"string","description":"The color of the positive data bar."}},"type":"object","required":["fieldId"]},"aws-native:quicksight:DashboardDataColor":{"properties":{"color":{"type":"string","description":"The color that is applied to the data value."},"dataValue":{"type":"number","description":"The data value that the color is applied to."}},"type":"object"},"aws-native:quicksight:DashboardDataFieldSeriesItem":{"properties":{"axisBinding":{"$ref":"#/types/aws-native:quicksight:DashboardAxisBinding","description":"The axis that you are binding the field to."},"fieldId":{"type":"string","description":"The field ID of the field that you are setting the axis binding to."},"fieldValue":{"type":"string","description":"The field value of the field that you are setting the axis binding to."},"settings":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartSeriesSettings","description":"The options that determine the presentation of line series associated to the field."}},"type":"object","required":["axisBinding","fieldId"]},"aws-native:quicksight:DashboardDataLabelContent":{"type":"string","enum":[{"name":"Value","value":"VALUE"},{"name":"Percent","value":"PERCENT"},{"name":"ValueAndPercent","value":"VALUE_AND_PERCENT"}]},"aws-native:quicksight:DashboardDataLabelOptions":{"properties":{"categoryLabelVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines the visibility of the category field labels."},"dataLabelTypes":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelType"},"description":"The option that determines the data label type."},"labelColor":{"type":"string","description":"Determines the color of the data labels."},"labelContent":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelContent","description":"Determines the content of the data labels."},"labelFontConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFontConfiguration","description":"Determines the font configuration of the data labels."},"measureLabelVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines the visibility of the measure field labels."},"overlap":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOverlap","description":"Determines whether overlap is enabled or disabled for the data labels."},"position":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelPosition","description":"Determines the position of the data labels."},"totalsVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines the visibility of the total."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines the visibility of the data labels."}},"type":"object"},"aws-native:quicksight:DashboardDataLabelOverlap":{"type":"string","enum":[{"name":"DisableOverlap","value":"DISABLE_OVERLAP"},{"name":"EnableOverlap","value":"ENABLE_OVERLAP"}]},"aws-native:quicksight:DashboardDataLabelPosition":{"type":"string","enum":[{"name":"Inside","value":"INSIDE"},{"name":"Outside","value":"OUTSIDE"},{"name":"Left","value":"LEFT"},{"name":"Top","value":"TOP"},{"name":"Bottom","value":"BOTTOM"},{"name":"Right","value":"RIGHT"}]},"aws-native:quicksight:DashboardDataLabelType":{"properties":{"dataPathLabelType":{"$ref":"#/types/aws-native:quicksight:DashboardDataPathLabelType","description":"The option that specifies individual data values for labels."},"fieldLabelType":{"$ref":"#/types/aws-native:quicksight:DashboardFieldLabelType","description":"Determines the label configuration for the entire field."},"maximumLabelType":{"$ref":"#/types/aws-native:quicksight:DashboardMaximumLabelType","description":"Determines the label configuration for the maximum value in a visual."},"minimumLabelType":{"$ref":"#/types/aws-native:quicksight:DashboardMinimumLabelType","description":"Determines the label configuration for the minimum value in a visual."},"rangeEndsLabelType":{"$ref":"#/types/aws-native:quicksight:DashboardRangeEndsLabelType","description":"Determines the label configuration for range end value in a visual."}},"type":"object"},"aws-native:quicksight:DashboardDataPathColor":{"properties":{"color":{"type":"string","description":"The color that needs to be applied to the element."},"element":{"$ref":"#/types/aws-native:quicksight:DashboardDataPathValue","description":"The element that the color needs to be applied to."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:DashboardTimeGranularity","description":"The time granularity of the field that the color needs to be applied to."}},"type":"object","required":["color","element"]},"aws-native:quicksight:DashboardDataPathLabelType":{"properties":{"fieldId":{"type":"string","description":"The field ID of the field that the data label needs to be applied to."},"fieldValue":{"type":"string","description":"The actual value of the field that is labeled."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the data label."}},"type":"object"},"aws-native:quicksight:DashboardDataPathSort":{"properties":{"direction":{"$ref":"#/types/aws-native:quicksight:DashboardSortDirection","description":"Determines the sort direction."},"sortPaths":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDataPathValue"},"description":"The list of data paths that need to be sorted."}},"type":"object","required":["direction","sortPaths"]},"aws-native:quicksight:DashboardDataPathType":{"properties":{"pivotTableDataPathType":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableDataPathType","description":"The type of data path value utilized in a pivot table. Choose one of the following options:\n\n- `HIERARCHY_ROWS_LAYOUT_COLUMN` - The type of data path for the rows layout column, when `RowsLayout` is set to `HIERARCHY` .\n- `MULTIPLE_ROW_METRICS_COLUMN` - The type of data path for the metric column when the row is set to Metric Placement.\n- `EMPTY_COLUMN_HEADER` - The type of data path for the column with empty column header, when there is no field in `ColumnsFieldWell` and the row is set to Metric Placement.\n- `COUNT_METRIC_COLUMN` - The type of data path for the column with `COUNT` as the metric, when there is no field in the `ValuesFieldWell` ."}},"type":"object"},"aws-native:quicksight:DashboardDataPathValue":{"properties":{"dataPathType":{"$ref":"#/types/aws-native:quicksight:DashboardDataPathType","description":"The type configuration of the field."},"fieldId":{"type":"string","description":"The field ID of the field that needs to be sorted."},"fieldValue":{"type":"string","description":"The actual value of the field that needs to be sorted."}},"type":"object"},"aws-native:quicksight:DashboardDataPointDrillUpDownOption":{"description":"\u003cp\u003eThe drill down options for data points in a dashbaord.\u003c/p\u003e","properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"The status of the drill down options of data points."}},"type":"object"},"aws-native:quicksight:DashboardDataPointMenuLabelOption":{"description":"\u003cp\u003eThe data point menu options of a dashboard.\u003c/p\u003e","properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"The status of the data point menu options."}},"type":"object"},"aws-native:quicksight:DashboardDataPointTooltipOption":{"description":"\u003cp\u003eThe data point tooltip options.\u003c/p\u003e","properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"The status of the data point tool tip options."}},"type":"object"},"aws-native:quicksight:DashboardDataQaEnabledOption":{"properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"The status of the Data Q\u0026A option on the dashboard."}},"type":"object"},"aws-native:quicksight:DashboardDataSetIdentifierDeclaration":{"properties":{"dataSetArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the data set."},"identifier":{"type":"string","description":"The identifier of the data set, typically the data set's name."}},"type":"object","required":["dataSetArn","identifier"]},"aws-native:quicksight:DashboardDataSetReference":{"description":"\u003cp\u003eDataset reference.\u003c/p\u003e","properties":{"dataSetArn":{"type":"string","description":"\u003cp\u003eDataset Amazon Resource Name (ARN).\u003c/p\u003e"},"dataSetPlaceholder":{"type":"string","description":"\u003cp\u003eDataset placeholder.\u003c/p\u003e"}},"type":"object","required":["dataSetArn","dataSetPlaceholder"]},"aws-native:quicksight:DashboardDataStoriesSharingOption":{"properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"Availability status."}},"type":"object"},"aws-native:quicksight:DashboardDateAggregationFunction":{"type":"string","enum":[{"name":"Count","value":"COUNT"},{"name":"DistinctCount","value":"DISTINCT_COUNT"},{"name":"Min","value":"MIN"},{"name":"Max","value":"MAX"}]},"aws-native:quicksight:DashboardDateAxisOptions":{"properties":{"missingDateVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines whether or not missing dates are displayed."}},"type":"object"},"aws-native:quicksight:DashboardDateDimensionField":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that is used in the `DateDimensionField` ."},"dateGranularity":{"$ref":"#/types/aws-native:quicksight:DashboardTimeGranularity","description":"The date granularity of the `DateDimensionField` . Choose one of the following options:\n\n- `YEAR`\n- `QUARTER`\n- `MONTH`\n- `WEEK`\n- `DAY`\n- `HOUR`\n- `MINUTE`\n- `SECOND`\n- `MILLISECOND`"},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDateTimeFormatConfiguration","description":"The format configuration of the field."},"hierarchyId":{"type":"string","description":"The custom hierarchy ID."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:DashboardDateMeasureField":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardDateAggregationFunction","description":"The aggregation function of the measure field."},"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that is used in the `DateMeasureField` ."},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDateTimeFormatConfiguration","description":"The format configuration of the field."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:DashboardDateTimeDefaultValues":{"properties":{"dynamicValue":{"$ref":"#/types/aws-native:quicksight:DashboardDynamicDefaultValue","description":"The dynamic value of the `DataTimeDefaultValues` . Different defaults are displayed according to users, groups, and values mapping."},"rollingDate":{"$ref":"#/types/aws-native:quicksight:DashboardRollingDateConfiguration","description":"The rolling date of the `DataTimeDefaultValues` . The date is determined from the dataset based on input expression."},"staticValues":{"type":"array","items":{"type":"string"},"description":"The static values of the `DataTimeDefaultValues` ."}},"type":"object"},"aws-native:quicksight:DashboardDateTimeFormatConfiguration":{"properties":{"dateTimeFormat":{"type":"string","description":"Determines the `DateTime` format."},"nullValueFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNullValueFormatConfiguration","description":"The options that determine the null value format configuration."},"numericFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNumericFormatConfiguration","description":"The formatting configuration for numeric `DateTime` fields."}},"type":"object"},"aws-native:quicksight:DashboardDateTimeHierarchy":{"properties":{"drillDownFilters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDrillDownFilter"},"description":"The option that determines the drill down filters for the `DateTime` hierarchy."},"hierarchyId":{"type":"string","description":"The hierarchy ID of the `DateTime` hierarchy."}},"type":"object","required":["hierarchyId"]},"aws-native:quicksight:DashboardDateTimeParameter":{"description":"\u003cp\u003eA date-time parameter.\u003c/p\u003e","properties":{"name":{"type":"string","description":"\u003cp\u003eA display name for the date-time parameter.\u003c/p\u003e"},"values":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eThe values for the date-time parameter.\u003c/p\u003e"}},"type":"object","required":["name","values"]},"aws-native:quicksight:DashboardDateTimeParameterDeclaration":{"properties":{"defaultValues":{"$ref":"#/types/aws-native:quicksight:DashboardDateTimeDefaultValues","description":"The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided."},"mappedDataSetParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMappedDataSetParameter"}},"name":{"type":"string","description":"The name of the parameter that is being declared."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:DashboardTimeGranularity","description":"The level of time precision that is used to aggregate `DateTime` values."},"valueWhenUnset":{"$ref":"#/types/aws-native:quicksight:DashboardDateTimeValueWhenUnsetConfiguration","description":"The configuration that defines the default value of a `DateTime` parameter when a value has not been set."}},"type":"object","required":["name"]},"aws-native:quicksight:DashboardDateTimePickerControlDisplayOptions":{"properties":{"dateIconVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The date icon visibility of the `DateTimePickerControlDisplayOptions` ."},"dateTimeFormat":{"type":"string","description":"Customize how dates are formatted in controls."},"helperTextVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The helper text visibility of the `DateTimePickerControlDisplayOptions` ."},"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:DashboardLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:DashboardDateTimeValueWhenUnsetConfiguration":{"properties":{"customValue":{"type":"string","description":"A custom value that's used when the value of a parameter isn't set."},"valueWhenUnsetOption":{"$ref":"#/types/aws-native:quicksight:DashboardValueWhenUnsetOption","description":"The built-in options for default values. The value can be one of the following:\n\n- `RECOMMENDED` : The recommended value.\n- `NULL` : The `NULL` value."}},"type":"object"},"aws-native:quicksight:DashboardDayOfTheWeek":{"type":"string","enum":[{"name":"Sunday","value":"SUNDAY"},{"name":"Monday","value":"MONDAY"},{"name":"Tuesday","value":"TUESDAY"},{"name":"Wednesday","value":"WEDNESDAY"},{"name":"Thursday","value":"THURSDAY"},{"name":"Friday","value":"FRIDAY"},{"name":"Saturday","value":"SATURDAY"}]},"aws-native:quicksight:DashboardDecimalDefaultValues":{"properties":{"dynamicValue":{"$ref":"#/types/aws-native:quicksight:DashboardDynamicDefaultValue","description":"The dynamic value of the `DecimalDefaultValues` . Different defaults are displayed according to users, groups, and values mapping."},"staticValues":{"type":"array","items":{"type":"number"},"description":"The static values of the `DecimalDefaultValues` ."}},"type":"object"},"aws-native:quicksight:DashboardDecimalParameter":{"description":"\u003cp\u003eA decimal parameter.\u003c/p\u003e","properties":{"name":{"type":"string","description":"\u003cp\u003eA display name for the decimal parameter.\u003c/p\u003e"},"values":{"type":"array","items":{"type":"number"},"description":"\u003cp\u003eThe values for the decimal parameter.\u003c/p\u003e"}},"type":"object","required":["name","values"]},"aws-native:quicksight:DashboardDecimalParameterDeclaration":{"properties":{"defaultValues":{"$ref":"#/types/aws-native:quicksight:DashboardDecimalDefaultValues","description":"The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided."},"mappedDataSetParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMappedDataSetParameter"}},"name":{"type":"string","description":"The name of the parameter that is being declared."},"parameterValueType":{"$ref":"#/types/aws-native:quicksight:DashboardParameterValueType","description":"The value type determines whether the parameter is a single-value or multi-value parameter."},"valueWhenUnset":{"$ref":"#/types/aws-native:quicksight:DashboardDecimalValueWhenUnsetConfiguration","description":"The configuration that defines the default value of a `Decimal` parameter when a value has not been set."}},"type":"object","required":["name","parameterValueType"]},"aws-native:quicksight:DashboardDecimalPlacesConfiguration":{"properties":{"decimalPlaces":{"type":"number","description":"The values of the decimal places."}},"type":"object","required":["decimalPlaces"]},"aws-native:quicksight:DashboardDecimalValueWhenUnsetConfiguration":{"properties":{"customValue":{"type":"number","description":"A custom value that's used when the value of a parameter isn't set."},"valueWhenUnsetOption":{"$ref":"#/types/aws-native:quicksight:DashboardValueWhenUnsetOption","description":"The built-in options for default values. The value can be one of the following:\n\n- `RECOMMENDED` : The recommended value.\n- `NULL` : The `NULL` value."}},"type":"object"},"aws-native:quicksight:DashboardDefaultDateTimePickerControlOptions":{"properties":{"commitMode":{"$ref":"#/types/aws-native:quicksight:DashboardCommitMode","description":"The visibility configuration of the Apply button on a `DateTimePickerControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDateTimePickerControlDisplayOptions","description":"The display options of a control."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlDateTimePickerType","description":"The date time picker type of the `DefaultDateTimePickerControlOptions` . Choose one of the following options:\n\n- `SINGLE_VALUED` : The filter condition is a fixed date.\n- `DATE_RANGE` : The filter condition is a date time range."}},"type":"object"},"aws-native:quicksight:DashboardDefaultFilterControlConfiguration":{"properties":{"controlOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultFilterControlOptions","description":"The control option for the `DefaultFilterControlConfiguration` ."},"title":{"type":"string","description":"The title of the `DefaultFilterControlConfiguration` . This title is shared by all controls that are tied to this filter."}},"type":"object","required":["controlOptions","title"]},"aws-native:quicksight:DashboardDefaultFilterControlOptions":{"properties":{"defaultDateTimePickerOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultDateTimePickerControlOptions","description":"The default options that correspond to the filter control type of a `DateTimePicker` ."},"defaultDropdownOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultFilterDropDownControlOptions","description":"The default options that correspond to the `Dropdown` filter control type."},"defaultListOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultFilterListControlOptions","description":"The default options that correspond to the `List` filter control type."},"defaultRelativeDateTimeOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultRelativeDateTimeControlOptions","description":"The default options that correspond to the `RelativeDateTime` filter control type."},"defaultSliderOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultSliderControlOptions","description":"The default options that correspond to the `Slider` filter control type."},"defaultTextAreaOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultTextAreaControlOptions","description":"The default options that correspond to the `TextArea` filter control type."},"defaultTextFieldOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultTextFieldControlOptions","description":"The default options that correspond to the `TextField` filter control type."}},"type":"object"},"aws-native:quicksight:DashboardDefaultFilterDropDownControlOptions":{"properties":{"commitMode":{"$ref":"#/types/aws-native:quicksight:DashboardCommitMode","description":"The visibility configuration of the Apply button on a `FilterDropDownControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDropDownControlDisplayOptions","description":"The display options of a control."},"selectableValues":{"$ref":"#/types/aws-native:quicksight:DashboardFilterSelectableValues","description":"A list of selectable values that are used in a control."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlListType","description":"The type of the `FilterDropDownControl` . Choose one of the following options:\n\n- `MULTI_SELECT` : The user can select multiple entries from a dropdown menu.\n- `SINGLE_SELECT` : The user can select a single entry from a dropdown menu."}},"type":"object"},"aws-native:quicksight:DashboardDefaultFilterListControlOptions":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardListControlDisplayOptions","description":"The display options of a control."},"selectableValues":{"$ref":"#/types/aws-native:quicksight:DashboardFilterSelectableValues","description":"A list of selectable values that are used in a control."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlListType","description":"The type of the `DefaultFilterListControlOptions` . Choose one of the following options:\n\n- `MULTI_SELECT` : The user can select multiple entries from the list.\n- `SINGLE_SELECT` : The user can select a single entry from the list."}},"type":"object"},"aws-native:quicksight:DashboardDefaultFreeFormLayoutConfiguration":{"properties":{"canvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:DashboardFreeFormLayoutCanvasSizeOptions","description":"Determines the screen canvas size options for a free-form layout."}},"type":"object","required":["canvasSizeOptions"]},"aws-native:quicksight:DashboardDefaultGridLayoutConfiguration":{"properties":{"canvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:DashboardGridLayoutCanvasSizeOptions","description":"Determines the screen canvas size options for a grid layout."}},"type":"object","required":["canvasSizeOptions"]},"aws-native:quicksight:DashboardDefaultInteractiveLayoutConfiguration":{"properties":{"freeForm":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultFreeFormLayoutConfiguration","description":"The options that determine the default settings of a free-form layout configuration."},"grid":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultGridLayoutConfiguration","description":"The options that determine the default settings for a grid layout configuration."}},"type":"object"},"aws-native:quicksight:DashboardDefaultNewSheetConfiguration":{"properties":{"interactiveLayoutConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultInteractiveLayoutConfiguration","description":"The options that determine the default settings for interactive layout configuration."},"paginatedLayoutConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultPaginatedLayoutConfiguration","description":"The options that determine the default settings for a paginated layout configuration."},"sheetContentType":{"$ref":"#/types/aws-native:quicksight:DashboardSheetContentType","description":"The option that determines the sheet content type."}},"type":"object"},"aws-native:quicksight:DashboardDefaultPaginatedLayoutConfiguration":{"properties":{"sectionBased":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultSectionBasedLayoutConfiguration","description":"The options that determine the default settings for a section-based layout configuration."}},"type":"object"},"aws-native:quicksight:DashboardDefaultRelativeDateTimeControlOptions":{"properties":{"commitMode":{"$ref":"#/types/aws-native:quicksight:DashboardCommitMode","description":"The visibility configuration of the Apply button on a `RelativeDateTimeControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardRelativeDateTimeControlDisplayOptions","description":"The display options of a control."}},"type":"object"},"aws-native:quicksight:DashboardDefaultSectionBasedLayoutConfiguration":{"properties":{"canvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSectionBasedLayoutCanvasSizeOptions","description":"Determines the screen canvas size options for a section-based layout."}},"type":"object","required":["canvasSizeOptions"]},"aws-native:quicksight:DashboardDefaultSliderControlOptions":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSliderControlDisplayOptions","description":"The display options of a control."},"maximumValue":{"type":"number","description":"The larger value that is displayed at the right of the slider."},"minimumValue":{"type":"number","description":"The smaller value that is displayed at the left of the slider."},"stepSize":{"type":"number","description":"The number of increments that the slider bar is divided into."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlSliderType","description":"The type of the `DefaultSliderControlOptions` . Choose one of the following options:\n\n- `SINGLE_POINT` : Filter against(equals) a single data point.\n- `RANGE` : Filter data that is in a specified range."}},"type":"object","required":["maximumValue","minimumValue","stepSize"]},"aws-native:quicksight:DashboardDefaultTextAreaControlOptions":{"properties":{"delimiter":{"type":"string","description":"The delimiter that is used to separate the lines in text."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTextAreaControlDisplayOptions","description":"The display options of a control."}},"type":"object"},"aws-native:quicksight:DashboardDefaultTextFieldControlOptions":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTextFieldControlDisplayOptions","description":"The display options of a control."}},"type":"object"},"aws-native:quicksight:DashboardDestinationParameterValueConfiguration":{"properties":{"customValuesConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardCustomValuesConfiguration","description":"The configuration of custom values for destination parameter in `DestinationParameterValueConfiguration` ."},"selectAllValueOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSelectAllValueOptions","description":"The configuration that selects all options."},"sourceColumn":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"A column of a data set."},"sourceField":{"type":"string","description":"The source field ID of the destination parameter."},"sourceParameterName":{"type":"string","description":"The source parameter name of the destination parameter."}},"type":"object"},"aws-native:quicksight:DashboardDigitGroupingStyle":{"type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"Lakhs","value":"LAKHS"}]},"aws-native:quicksight:DashboardDimensionField":{"properties":{"categoricalDimensionField":{"$ref":"#/types/aws-native:quicksight:DashboardCategoricalDimensionField","description":"The dimension type field with categorical type columns."},"dateDimensionField":{"$ref":"#/types/aws-native:quicksight:DashboardDateDimensionField","description":"The dimension type field with date type columns."},"numericalDimensionField":{"$ref":"#/types/aws-native:quicksight:DashboardNumericalDimensionField","description":"The dimension type field with numerical type columns."}},"type":"object"},"aws-native:quicksight:DashboardDonutCenterOptions":{"properties":{"labelVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines the visibility of the label in a donut chart. In the Quick Sight console, this option is called `'Show total'` ."}},"type":"object"},"aws-native:quicksight:DashboardDonutOptions":{"properties":{"arcOptions":{"$ref":"#/types/aws-native:quicksight:DashboardArcOptions","description":"The option for define the arc of the chart shape. Valid values are as follows:\n\n- `WHOLE` - A pie chart\n- `SMALL` - A small-sized donut chart\n- `MEDIUM` - A medium-sized donut chart\n- `LARGE` - A large-sized donut chart"},"donutCenterOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDonutCenterOptions","description":"The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts."}},"type":"object"},"aws-native:quicksight:DashboardDrillDownFilter":{"properties":{"categoryFilter":{"$ref":"#/types/aws-native:quicksight:DashboardCategoryDrillDownFilter","description":"The category type drill down filter. This filter is used for string type columns."},"numericEqualityFilter":{"$ref":"#/types/aws-native:quicksight:DashboardNumericEqualityDrillDownFilter","description":"The numeric equality type drill down filter. This filter is used for number type columns."},"timeRangeFilter":{"$ref":"#/types/aws-native:quicksight:DashboardTimeRangeDrillDownFilter","description":"The time range drill down filter. This filter is used for date time columns."}},"type":"object"},"aws-native:quicksight:DashboardDropDownControlDisplayOptions":{"properties":{"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:DashboardListControlSelectAllOptions","description":"The configuration of the `Select all` options in a dropdown control."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:DashboardLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:DashboardDynamicDefaultValue":{"properties":{"defaultValueColumn":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that contains the default value of each user or group."},"groupNameColumn":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that contains the group name."},"userNameColumn":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that contains the username."}},"type":"object","required":["defaultValueColumn"]},"aws-native:quicksight:DashboardEmptyVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"dataSetIdentifier":{"type":"string","description":"The data set that is used in the empty visual. Every visual requires a dataset to render."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["dataSetIdentifier","visualId"]},"aws-native:quicksight:DashboardEntity":{"properties":{"path":{"type":"string","description":"The hierarchical path of the entity within the analysis, template, or dashboard definition tree."}},"type":"object"},"aws-native:quicksight:DashboardError":{"description":"\u003cp\u003eDashboard error.\u003c/p\u003e","properties":{"message":{"type":"string","description":"\u003cp\u003eMessage.\u003c/p\u003e"},"type":{"$ref":"#/types/aws-native:quicksight:DashboardErrorType","description":"Type."},"violatedEntities":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardEntity"},"description":"\u003cp\u003eLists the violated entities that caused the dashboard error.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DashboardErrorType":{"type":"string","enum":[{"name":"AccessDenied","value":"ACCESS_DENIED"},{"name":"SourceNotFound","value":"SOURCE_NOT_FOUND"},{"name":"DataSetNotFound","value":"DATA_SET_NOT_FOUND"},{"name":"InternalFailure","value":"INTERNAL_FAILURE"},{"name":"ParameterValueIncompatible","value":"PARAMETER_VALUE_INCOMPATIBLE"},{"name":"ParameterTypeInvalid","value":"PARAMETER_TYPE_INVALID"},{"name":"ParameterNotFound","value":"PARAMETER_NOT_FOUND"},{"name":"ColumnTypeMismatch","value":"COLUMN_TYPE_MISMATCH"},{"name":"ColumnGeographicRoleMismatch","value":"COLUMN_GEOGRAPHIC_ROLE_MISMATCH"},{"name":"ColumnReplacementMissing","value":"COLUMN_REPLACEMENT_MISSING"}]},"aws-native:quicksight:DashboardExcludePeriodConfiguration":{"properties":{"amount":{"type":"number","description":"The amount or number of the exclude period."},"granularity":{"$ref":"#/types/aws-native:quicksight:DashboardTimeGranularity","description":"The granularity or unit (day, month, year) of the exclude period."},"status":{"$ref":"#/types/aws-native:quicksight:DashboardWidgetStatus","description":"The status of the exclude period. Choose from the following options:\n\n- `ENABLED`\n- `DISABLED`"}},"type":"object","required":["amount","granularity"]},"aws-native:quicksight:DashboardExecutiveSummaryOption":{"properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"Availability status."}},"type":"object"},"aws-native:quicksight:DashboardExplicitHierarchy":{"properties":{"columns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier"},"description":"The list of columns that define the explicit hierarchy."},"drillDownFilters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDrillDownFilter"},"description":"The option that determines the drill down filters for the explicit hierarchy."},"hierarchyId":{"type":"string","description":"The hierarchy ID of the explicit hierarchy."}},"type":"object","required":["columns","hierarchyId"]},"aws-native:quicksight:DashboardExportHiddenFieldsOption":{"description":"\u003cp\u003eDetermines if hidden fields are included in an exported dashboard.\u003c/p\u003e","properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"The status of the export hidden fields options of a dashbaord."}},"type":"object"},"aws-native:quicksight:DashboardExportToCsvOption":{"description":"\u003cp\u003eExport to .csv option.\u003c/p\u003e","properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"Availability status."}},"type":"object"},"aws-native:quicksight:DashboardExportWithHiddenFieldsOption":{"description":"\u003cp\u003eDetermines whether or not hidden fields are visible on exported dashbaords.\u003c/p\u003e","properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"The status of the export with hidden fields options."}},"type":"object"},"aws-native:quicksight:DashboardFieldBasedTooltip":{"properties":{"aggregationVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of `Show aggregations` ."},"tooltipFields":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipItem"},"description":"The fields configuration in the tooltip."},"tooltipTitleType":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipTitleType","description":"The type for the \u003etooltip title. Choose one of the following options:\n\n- `NONE` : Doesn't use the primary value as the title.\n- `PRIMARY_VALUE` : Uses primary value as the title."}},"type":"object"},"aws-native:quicksight:DashboardFieldLabelType":{"properties":{"fieldId":{"type":"string","description":"Indicates the field that is targeted by the field label."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the field label."}},"type":"object"},"aws-native:quicksight:DashboardFieldSeriesItem":{"properties":{"axisBinding":{"$ref":"#/types/aws-native:quicksight:DashboardAxisBinding","description":"The axis that you are binding the field to."},"fieldId":{"type":"string","description":"The field ID of the field for which you are setting the axis binding."},"settings":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartSeriesSettings","description":"The options that determine the presentation of line series associated to the field."}},"type":"object","required":["axisBinding","fieldId"]},"aws-native:quicksight:DashboardFieldSort":{"properties":{"direction":{"$ref":"#/types/aws-native:quicksight:DashboardSortDirection","description":"The sort direction. Choose one of the following options:\n\n- `ASC` : Ascending\n- `DESC` : Descending"},"fieldId":{"type":"string","description":"The sort configuration target field."}},"type":"object","required":["direction","fieldId"]},"aws-native:quicksight:DashboardFieldSortOptions":{"properties":{"columnSort":{"$ref":"#/types/aws-native:quicksight:DashboardColumnSort","description":"The sort configuration for a column that is not used in a field well."},"fieldSort":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSort","description":"The sort configuration for a field in a field well."}},"type":"object"},"aws-native:quicksight:DashboardFieldTooltipItem":{"properties":{"fieldId":{"type":"string","description":"The unique ID of the field that is targeted by the tooltip."},"label":{"type":"string","description":"The label of the tooltip item."},"tooltipTarget":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipTarget","description":"Determines the target of the field tooltip item in a combo chart visual."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the tooltip item."}},"type":"object","required":["fieldId"]},"aws-native:quicksight:DashboardFilledMapAggregatedFieldWells":{"properties":{"geospatial":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The aggregated location field well of the filled map. Values are grouped by location fields."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The aggregated color field well of a filled map. Values are aggregated based on location fields."}},"type":"object"},"aws-native:quicksight:DashboardFilledMapConditionalFormatting":{"properties":{"conditionalFormattingOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFilledMapConditionalFormattingOption"},"description":"Conditional formatting options of a `FilledMapVisual` ."}},"type":"object","required":["conditionalFormattingOptions"]},"aws-native:quicksight:DashboardFilledMapConditionalFormattingOption":{"properties":{"shape":{"$ref":"#/types/aws-native:quicksight:DashboardFilledMapShapeConditionalFormatting","description":"The conditional formatting that determines the shape of the filled map."}},"type":"object","required":["shape"]},"aws-native:quicksight:DashboardFilledMapConfiguration":{"properties":{"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardFilledMapFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions","description":"The legend display setup of the visual."},"mapStyleOptions":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialMapStyleOptions","description":"The map style options of the filled map visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFilledMapSortConfiguration","description":"The sort configuration of a `FilledMapVisual` ."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The tooltip display setup of the visual."},"windowOptions":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialWindowOptions","description":"The window options of the filled map visual."}},"type":"object"},"aws-native:quicksight:DashboardFilledMapFieldWells":{"properties":{"filledMapAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardFilledMapAggregatedFieldWells","description":"The aggregated field well of the filled map."}},"type":"object"},"aws-native:quicksight:DashboardFilledMapShapeConditionalFormatting":{"properties":{"fieldId":{"type":"string","description":"The field ID of the filled map shape."},"format":{"$ref":"#/types/aws-native:quicksight:DashboardShapeConditionalFormat","description":"The conditional formatting that determines the background color of a filled map's shape."}},"type":"object","required":["fieldId"]},"aws-native:quicksight:DashboardFilledMapSortConfiguration":{"properties":{"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of the location fields."}},"type":"object"},"aws-native:quicksight:DashboardFilledMapVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFilledMapConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"conditionalFormatting":{"$ref":"#/types/aws-native:quicksight:DashboardFilledMapConditionalFormatting","description":"The conditional formatting of a `FilledMapVisual` ."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardFilter":{"properties":{"categoryFilter":{"$ref":"#/types/aws-native:quicksight:DashboardCategoryFilter","description":"A `CategoryFilter` filters text values.\n\nFor more information, see [Adding text filters](https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) in the *Amazon Quick Suite User Guide* ."},"nestedFilter":{"$ref":"#/types/aws-native:quicksight:DashboardNestedFilter","description":"A `NestedFilter` filters data with a subset of data that is defined by the nested inner filter."},"numericEqualityFilter":{"$ref":"#/types/aws-native:quicksight:DashboardNumericEqualityFilter","description":"A `NumericEqualityFilter` filters numeric values that equal or do not equal a given numeric value."},"numericRangeFilter":{"$ref":"#/types/aws-native:quicksight:DashboardNumericRangeFilter","description":"A `NumericRangeFilter` filters numeric values that are either inside or outside a given numeric range."},"relativeDatesFilter":{"$ref":"#/types/aws-native:quicksight:DashboardRelativeDatesFilter","description":"A `RelativeDatesFilter` filters date values that are relative to a given date."},"timeEqualityFilter":{"$ref":"#/types/aws-native:quicksight:DashboardTimeEqualityFilter","description":"A `TimeEqualityFilter` filters date-time values that equal or do not equal a given date/time value."},"timeRangeFilter":{"$ref":"#/types/aws-native:quicksight:DashboardTimeRangeFilter","description":"A `TimeRangeFilter` filters date-time values that are either inside or outside a given date/time range."},"topBottomFilter":{"$ref":"#/types/aws-native:quicksight:DashboardTopBottomFilter","description":"A `TopBottomFilter` filters data to the top or bottom values for a given column."}},"type":"object"},"aws-native:quicksight:DashboardFilterControl":{"properties":{"crossSheet":{"$ref":"#/types/aws-native:quicksight:DashboardFilterCrossSheetControl","description":"A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet"},"dateTimePicker":{"$ref":"#/types/aws-native:quicksight:DashboardFilterDateTimePickerControl","description":"A control from a date filter that is used to specify date and time."},"dropdown":{"$ref":"#/types/aws-native:quicksight:DashboardFilterDropDownControl","description":"A control to display a dropdown list with buttons that are used to select a single value."},"list":{"$ref":"#/types/aws-native:quicksight:DashboardFilterListControl","description":"A control to display a list of buttons or boxes. This is used to select either a single value or multiple values."},"relativeDateTime":{"$ref":"#/types/aws-native:quicksight:DashboardFilterRelativeDateTimeControl","description":"A control from a date filter that is used to specify the relative date."},"slider":{"$ref":"#/types/aws-native:quicksight:DashboardFilterSliderControl","description":"A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle."},"textArea":{"$ref":"#/types/aws-native:quicksight:DashboardFilterTextAreaControl","description":"A control to display a text box that is used to enter multiple entries."},"textField":{"$ref":"#/types/aws-native:quicksight:DashboardFilterTextFieldControl","description":"A control to display a text box that is used to enter a single entry."}},"type":"object"},"aws-native:quicksight:DashboardFilterCrossSheetControl":{"properties":{"cascadingControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardCascadingControlConfiguration","description":"The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls."},"filterControlId":{"type":"string","description":"The ID of the `FilterCrossSheetControl` ."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterCrossSheetControl` ."}},"type":"object","required":["filterControlId","sourceFilterId"]},"aws-native:quicksight:DashboardFilterDateTimePickerControl":{"properties":{"commitMode":{"$ref":"#/types/aws-native:quicksight:DashboardCommitMode","description":"The visibility configurationof the Apply button on a `DateTimePickerControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDateTimePickerControlDisplayOptions","description":"The display options of a control."},"filterControlId":{"type":"string","description":"The ID of the `FilterDateTimePickerControl` ."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterDateTimePickerControl` ."},"title":{"type":"string","description":"The title of the `FilterDateTimePickerControl` ."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlDateTimePickerType","description":"The type of the `FilterDropDownControl` . Choose one of the following options:\n\n- `MULTI_SELECT` : The user can select multiple entries from a dropdown menu.\n- `SINGLE_SELECT` : The user can select a single entry from a dropdown menu."}},"type":"object","required":["filterControlId","sourceFilterId","title"]},"aws-native:quicksight:DashboardFilterDropDownControl":{"properties":{"cascadingControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardCascadingControlConfiguration","description":"The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls."},"commitMode":{"$ref":"#/types/aws-native:quicksight:DashboardCommitMode","description":"The visibility configuration of the Apply button on a `FilterDropDownControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDropDownControlDisplayOptions","description":"The display options of the `FilterDropDownControl` ."},"filterControlId":{"type":"string","description":"The ID of the `FilterDropDownControl` ."},"selectableValues":{"$ref":"#/types/aws-native:quicksight:DashboardFilterSelectableValues","description":"A list of selectable values that are used in a control."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterDropDownControl` ."},"title":{"type":"string","description":"The title of the `FilterDropDownControl` ."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlListType","description":"The type of the `FilterDropDownControl` . Choose one of the following options:\n\n- `MULTI_SELECT` : The user can select multiple entries from a dropdown menu.\n- `SINGLE_SELECT` : The user can select a single entry from a dropdown menu."}},"type":"object","required":["filterControlId","sourceFilterId","title"]},"aws-native:quicksight:DashboardFilterGroup":{"properties":{"crossDataset":{"$ref":"#/types/aws-native:quicksight:DashboardCrossDatasetTypes","description":"The filter new feature which can apply filter group to all data sets. Choose one of the following options:\n\n- `ALL_DATASETS`\n- `SINGLE_DATASET`"},"filterGroupId":{"type":"string","description":"The value that uniquely identifies a `FilterGroup` within a dashboard, template, or analysis."},"filters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFilter"},"description":"The list of filters that are present in a `FilterGroup` ."},"scopeConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFilterScopeConfiguration","description":"The configuration that specifies what scope to apply to a `FilterGroup` .\n\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined."},"status":{"$ref":"#/types/aws-native:quicksight:DashboardWidgetStatus","description":"The status of the `FilterGroup` ."}},"type":"object","required":["crossDataset","filterGroupId","filters","scopeConfiguration"]},"aws-native:quicksight:DashboardFilterListConfiguration":{"properties":{"categoryValues":{"type":"array","items":{"type":"string"},"description":"The list of category values for the filter."},"matchOperator":{"$ref":"#/types/aws-native:quicksight:DashboardCategoryFilterMatchOperator","description":"The match operator that is used to determine if a filter should be applied."},"nullOption":{"$ref":"#/types/aws-native:quicksight:DashboardFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:DashboardCategoryFilterSelectAllOptions","description":"Select all of the values. Null is not the assigned value of select all.\n\n- `FILTER_ALL_VALUES`"}},"type":"object","required":["matchOperator"]},"aws-native:quicksight:DashboardFilterListControl":{"properties":{"cascadingControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardCascadingControlConfiguration","description":"The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardListControlDisplayOptions","description":"The display options of a control."},"filterControlId":{"type":"string","description":"The ID of the `FilterListControl` ."},"selectableValues":{"$ref":"#/types/aws-native:quicksight:DashboardFilterSelectableValues","description":"A list of selectable values that are used in a control."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterListControl` ."},"title":{"type":"string","description":"The title of the `FilterListControl` ."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlListType","description":"The type of the `FilterListControl` . Choose one of the following options:\n\n- `MULTI_SELECT` : The user can select multiple entries from the list.\n- `SINGLE_SELECT` : The user can select a single entry from the list."}},"type":"object","required":["filterControlId","sourceFilterId","title"]},"aws-native:quicksight:DashboardFilterNullOption":{"type":"string","enum":[{"name":"AllValues","value":"ALL_VALUES"},{"name":"NullsOnly","value":"NULLS_ONLY"},{"name":"NonNullsOnly","value":"NON_NULLS_ONLY"}]},"aws-native:quicksight:DashboardFilterOperationSelectedFieldsConfiguration":{"properties":{"selectedColumns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier"},"description":"\u003cp\u003eThe selected columns of a dataset.\u003c/p\u003e"},"selectedFieldOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSelectedFieldOptions","description":"A structure that contains the options that choose which fields are filtered in the `CustomActionFilterOperation` .\n\nValid values are defined as follows:\n\n- `ALL_FIELDS` : Applies the filter operation to all fields."},"selectedFields":{"type":"array","items":{"type":"string"},"description":"Chooses the fields that are filtered in `CustomActionFilterOperation` ."}},"type":"object"},"aws-native:quicksight:DashboardFilterOperationTargetVisualsConfiguration":{"properties":{"sameSheetTargetVisualConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardSameSheetTargetVisualConfiguration","description":"The configuration of the same-sheet target visuals that you want to be filtered."}},"type":"object"},"aws-native:quicksight:DashboardFilterRelativeDateTimeControl":{"properties":{"commitMode":{"$ref":"#/types/aws-native:quicksight:DashboardCommitMode","description":"The visibility configuration of the Apply button on a `FilterRelativeDateTimeControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardRelativeDateTimeControlDisplayOptions","description":"The display options of a control."},"filterControlId":{"type":"string","description":"The ID of the `FilterTextAreaControl` ."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterTextAreaControl` ."},"title":{"type":"string","description":"The title of the `FilterTextAreaControl` ."}},"type":"object","required":["filterControlId","sourceFilterId","title"]},"aws-native:quicksight:DashboardFilterScopeConfiguration":{"properties":{"allSheets":{"$ref":"#/types/aws-native:quicksight:DashboardAllSheetsFilterScopeConfiguration","description":"The configuration that applies a filter to all sheets. When you choose `AllSheets` as the value for a `FilterScopeConfiguration` , this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The `AllSheetsFilterScopeConfiguration` is chosen."},"selectedSheets":{"$ref":"#/types/aws-native:quicksight:DashboardSelectedSheetsFilterScopeConfiguration","description":"The configuration for applying a filter to specific sheets."}},"type":"object"},"aws-native:quicksight:DashboardFilterSelectableValues":{"properties":{"values":{"type":"array","items":{"type":"string"},"description":"The values that are used in the `FilterSelectableValues` ."}},"type":"object"},"aws-native:quicksight:DashboardFilterSliderControl":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSliderControlDisplayOptions","description":"The display options of a control."},"filterControlId":{"type":"string","description":"The ID of the `FilterSliderControl` ."},"maximumValue":{"type":"number","description":"The larger value that is displayed at the right of the slider."},"minimumValue":{"type":"number","description":"The smaller value that is displayed at the left of the slider."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterSliderControl` ."},"stepSize":{"type":"number","description":"The number of increments that the slider bar is divided into."},"title":{"type":"string","description":"The title of the `FilterSliderControl` ."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlSliderType","description":"The type of the `FilterSliderControl` . Choose one of the following options:\n\n- `SINGLE_POINT` : Filter against(equals) a single data point.\n- `RANGE` : Filter data that is in a specified range."}},"type":"object","required":["filterControlId","maximumValue","minimumValue","sourceFilterId","stepSize","title"]},"aws-native:quicksight:DashboardFilterTextAreaControl":{"properties":{"delimiter":{"type":"string","description":"The delimiter that is used to separate the lines in text."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTextAreaControlDisplayOptions","description":"The display options of a control."},"filterControlId":{"type":"string","description":"The ID of the `FilterTextAreaControl` ."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterTextAreaControl` ."},"title":{"type":"string","description":"The title of the `FilterTextAreaControl` ."}},"type":"object","required":["filterControlId","sourceFilterId","title"]},"aws-native:quicksight:DashboardFilterTextFieldControl":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTextFieldControlDisplayOptions","description":"The display options of a control."},"filterControlId":{"type":"string","description":"The ID of the `FilterTextFieldControl` ."},"sourceFilterId":{"type":"string","description":"The source filter ID of the `FilterTextFieldControl` ."},"title":{"type":"string","description":"The title of the `FilterTextFieldControl` ."}},"type":"object","required":["filterControlId","sourceFilterId","title"]},"aws-native:quicksight:DashboardFilterVisualScope":{"type":"string","enum":[{"name":"AllVisuals","value":"ALL_VISUALS"},{"name":"SelectedVisuals","value":"SELECTED_VISUALS"}]},"aws-native:quicksight:DashboardFontConfiguration":{"properties":{"fontColor":{"type":"string","description":"Determines the color of the text."},"fontDecoration":{"$ref":"#/types/aws-native:quicksight:DashboardFontDecoration","description":"Determines the appearance of decorative lines on the text."},"fontFamily":{"type":"string","description":"The font family that you want to use."},"fontSize":{"$ref":"#/types/aws-native:quicksight:DashboardFontSize","description":"The option that determines the text display size."},"fontStyle":{"$ref":"#/types/aws-native:quicksight:DashboardFontStyle","description":"Determines the text display face that is inherited by the given font family."},"fontWeight":{"$ref":"#/types/aws-native:quicksight:DashboardFontWeight","description":"The option that determines the text display weight, or boldness."}},"type":"object"},"aws-native:quicksight:DashboardFontDecoration":{"type":"string","enum":[{"name":"Underline","value":"UNDERLINE"},{"name":"None","value":"NONE"}]},"aws-native:quicksight:DashboardFontSize":{"properties":{"absolute":{"type":"string","description":"String based length that is composed of value and unit in px"},"relative":{"$ref":"#/types/aws-native:quicksight:DashboardRelativeFontSize","description":"The lexical name for the text size, proportional to its surrounding context."}},"type":"object"},"aws-native:quicksight:DashboardFontStyle":{"type":"string","enum":[{"name":"Normal","value":"NORMAL"},{"name":"Italic","value":"ITALIC"}]},"aws-native:quicksight:DashboardFontWeight":{"properties":{"name":{"$ref":"#/types/aws-native:quicksight:DashboardFontWeightName","description":"The lexical name for the level of boldness of the text display."}},"type":"object"},"aws-native:quicksight:DashboardFontWeightName":{"type":"string","enum":[{"name":"Normal","value":"NORMAL"},{"name":"Bold","value":"BOLD"}]},"aws-native:quicksight:DashboardForecastComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"customSeasonalityValue":{"type":"number","description":"The custom seasonality value setup of a forecast computation."},"lowerBoundary":{"type":"number","description":"The lower boundary setup of a forecast computation."},"name":{"type":"string","description":"The name of a computation."},"periodsBackward":{"type":"number","description":"The periods backward setup of a forecast computation."},"periodsForward":{"type":"number","description":"The periods forward setup of a forecast computation."},"predictionInterval":{"type":"number","description":"The prediction interval setup of a forecast computation."},"seasonality":{"$ref":"#/types/aws-native:quicksight:DashboardForecastComputationSeasonality","description":"The seasonality setup of a forecast computation. Choose one of the following options:\n\n- `AUTOMATIC`\n- `CUSTOM` : Checks the custom seasonality value."},"time":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField","description":"The time field that is used in a computation."},"upperBoundary":{"type":"number","description":"The upper boundary setup of a forecast computation."},"value":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:DashboardForecastComputationSeasonality":{"type":"string","enum":[{"name":"Automatic","value":"AUTOMATIC"},{"name":"Custom","value":"CUSTOM"}]},"aws-native:quicksight:DashboardForecastConfiguration":{"properties":{"forecastProperties":{"$ref":"#/types/aws-native:quicksight:DashboardTimeBasedForecastProperties","description":"The forecast properties setup of a forecast in the line chart."},"scenario":{"$ref":"#/types/aws-native:quicksight:DashboardForecastScenario","description":"The forecast scenario of a forecast in the line chart."}},"type":"object"},"aws-native:quicksight:DashboardForecastScenario":{"properties":{"whatIfPointScenario":{"$ref":"#/types/aws-native:quicksight:DashboardWhatIfPointScenario","description":"The what-if analysis forecast setup with the target date."},"whatIfRangeScenario":{"$ref":"#/types/aws-native:quicksight:DashboardWhatIfRangeScenario","description":"The what-if analysis forecast setup with the date range."}},"type":"object"},"aws-native:quicksight:DashboardFormatConfiguration":{"properties":{"dateTimeFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDateTimeFormatConfiguration","description":"Formatting configuration for `DateTime` fields."},"numberFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNumberFormatConfiguration","description":"Formatting configuration for number fields."},"stringFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardStringFormatConfiguration","description":"Formatting configuration for string fields."}},"type":"object"},"aws-native:quicksight:DashboardFreeFormLayoutCanvasSizeOptions":{"properties":{"screenCanvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:DashboardFreeFormLayoutScreenCanvasSizeOptions","description":"The options that determine the sizing of the canvas used in a free-form layout."}},"type":"object"},"aws-native:quicksight:DashboardFreeFormLayoutConfiguration":{"properties":{"canvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:DashboardFreeFormLayoutCanvasSizeOptions"},"elements":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFreeFormLayoutElement"},"description":"The elements that are included in a free-form layout."}},"type":"object","required":["elements"]},"aws-native:quicksight:DashboardFreeFormLayoutElement":{"properties":{"backgroundStyle":{"$ref":"#/types/aws-native:quicksight:DashboardFreeFormLayoutElementBackgroundStyle","description":"The background style configuration of a free-form layout element."},"borderRadius":{"type":"string","description":"The border radius of a free-form layout element."},"borderStyle":{"$ref":"#/types/aws-native:quicksight:DashboardFreeFormLayoutElementBorderStyle","description":"The border style configuration of a free-form layout element."},"elementId":{"type":"string","description":"A unique identifier for an element within a free-form layout."},"elementType":{"$ref":"#/types/aws-native:quicksight:DashboardLayoutElementType","description":"The type of element."},"height":{"type":"string","description":"String based length that is composed of value and unit in px"},"loadingAnimation":{"$ref":"#/types/aws-native:quicksight:DashboardLoadingAnimation","description":"The loading animation configuration of a free-form layout element."},"padding":{"type":"string","description":"The padding of a free-form layout element."},"renderingRules":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardSheetElementRenderingRule"},"description":"The rendering rules that determine when an element should be displayed within a free-form layout."},"selectedBorderStyle":{"$ref":"#/types/aws-native:quicksight:DashboardFreeFormLayoutElementBorderStyle","description":"The border style configuration of a free-form layout element. This border style is used when the element is selected."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of an element within a free-form layout."},"width":{"type":"string","description":"String based length that is composed of value and unit in px"},"xAxisLocation":{"type":"string","description":"String based length that is composed of value and unit in px"},"yAxisLocation":{"type":"string","description":"String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value"}},"type":"object","required":["elementId","elementType","height","width","xAxisLocation","yAxisLocation"]},"aws-native:quicksight:DashboardFreeFormLayoutElementBackgroundStyle":{"properties":{"color":{"type":"string","description":"The background color of a free-form layout element."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The background visibility of a free-form layout element."}},"type":"object"},"aws-native:quicksight:DashboardFreeFormLayoutElementBorderStyle":{"properties":{"color":{"type":"string","description":"The border color of a free-form layout element."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The border visibility of a free-form layout element."},"width":{"type":"string","description":"String to encapsulate the most generic way Width can be formatted with whatever units (px, em etc)"}},"type":"object"},"aws-native:quicksight:DashboardFreeFormLayoutScreenCanvasSizeOptions":{"properties":{"optimizedViewPortWidth":{"type":"string","description":"String based length that is composed of value and unit in px"}},"type":"object","required":["optimizedViewPortWidth"]},"aws-native:quicksight:DashboardFreeFormSectionLayoutConfiguration":{"properties":{"elements":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFreeFormLayoutElement"},"description":"The elements that are included in the free-form layout."}},"type":"object","required":["elements"]},"aws-native:quicksight:DashboardFunnelChartAggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The category field wells of a funnel chart. Values are grouped by category fields."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The value field wells of a funnel chart. Values are aggregated based on categories."}},"type":"object"},"aws-native:quicksight:DashboardFunnelChartConfiguration":{"properties":{"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options of the categories that are displayed in a `FunnelChartVisual` ."},"dataLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardFunnelChartDataLabelOptions","description":"The options that determine the presentation of the data labels."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardFunnelChartFieldWells","description":"The field well configuration of a `FunnelChartVisual` ."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFunnelChartSortConfiguration","description":"The sort configuration of a `FunnelChartVisual` ."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The tooltip configuration of a `FunnelChartVisual` ."},"valueLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options for the values that are displayed in a `FunnelChartVisual` ."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPalette","description":"The visual palette configuration of a `FunnelChartVisual` ."}},"type":"object"},"aws-native:quicksight:DashboardFunnelChartDataLabelOptions":{"properties":{"categoryLabelVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the category labels within the data labels."},"labelColor":{"type":"string","description":"The color of the data label text."},"labelFontConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFontConfiguration","description":"The font configuration for the data labels.\n\nOnly the `FontSize` attribute of the font configuration is used for data labels."},"measureDataLabelStyle":{"$ref":"#/types/aws-native:quicksight:DashboardFunnelChartMeasureDataLabelStyle","description":"Determines the style of the metric labels."},"measureLabelVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the measure labels within the data labels."},"position":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelPosition","description":"Determines the positioning of the data label relative to a section of the funnel."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility option that determines if data labels are displayed."}},"type":"object"},"aws-native:quicksight:DashboardFunnelChartFieldWells":{"properties":{"funnelChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardFunnelChartAggregatedFieldWells","description":"The field well configuration of a `FunnelChartVisual` ."}},"type":"object"},"aws-native:quicksight:DashboardFunnelChartMeasureDataLabelStyle":{"type":"string","enum":[{"name":"ValueOnly","value":"VALUE_ONLY"},{"name":"PercentageByFirstStage","value":"PERCENTAGE_BY_FIRST_STAGE"},{"name":"PercentageByPreviousStage","value":"PERCENTAGE_BY_PREVIOUS_STAGE"},{"name":"ValueAndPercentageByFirstStage","value":"VALUE_AND_PERCENTAGE_BY_FIRST_STAGE"},{"name":"ValueAndPercentageByPreviousStage","value":"VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE"}]},"aws-native:quicksight:DashboardFunnelChartSortConfiguration":{"properties":{"categoryItemsLimit":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of categories displayed."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of the category fields."}},"type":"object"},"aws-native:quicksight:DashboardFunnelChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFunnelChartConfiguration","description":"The configuration of a `FunnelChartVisual` ."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardGaugeChartArcConditionalFormatting":{"properties":{"foregroundColor":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingColor","description":"The conditional formatting of the arc foreground color."}},"type":"object"},"aws-native:quicksight:DashboardGaugeChartColorConfiguration":{"properties":{"backgroundColor":{"type":"string","description":"The background color configuration of a `GaugeChartVisual` ."},"foregroundColor":{"type":"string","description":"The foreground color configuration of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:DashboardGaugeChartConditionalFormatting":{"properties":{"conditionalFormattingOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardGaugeChartConditionalFormattingOption"},"description":"Conditional formatting options of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:DashboardGaugeChartConditionalFormattingOption":{"properties":{"arc":{"$ref":"#/types/aws-native:quicksight:DashboardGaugeChartArcConditionalFormatting","description":"The options that determine the presentation of the arc of a `GaugeChartVisual` ."},"primaryValue":{"$ref":"#/types/aws-native:quicksight:DashboardGaugeChartPrimaryValueConditionalFormatting","description":"The conditional formatting for the primary value of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:DashboardGaugeChartConfiguration":{"properties":{"colorConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardGaugeChartColorConfiguration","description":"The color configuration of a `GaugeChartVisual` ."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOptions","description":"The data label configuration of a `GaugeChartVisual` ."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardGaugeChartFieldWells","description":"The field well configuration of a `GaugeChartVisual` ."},"gaugeChartOptions":{"$ref":"#/types/aws-native:quicksight:DashboardGaugeChartOptions","description":"The options that determine the presentation of the `GaugeChartVisual` ."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"tooltipOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The tooltip configuration of a `GaugeChartVisual` ."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPalette","description":"The visual palette configuration of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:DashboardGaugeChartFieldWells":{"properties":{"targetValues":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The target value field wells of a `GaugeChartVisual` ."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The value field wells of a `GaugeChartVisual` ."}},"type":"object"},"aws-native:quicksight:DashboardGaugeChartOptions":{"properties":{"arc":{"$ref":"#/types/aws-native:quicksight:DashboardArcConfiguration","description":"The arc configuration of a `GaugeChartVisual` ."},"arcAxis":{"$ref":"#/types/aws-native:quicksight:DashboardArcAxisConfiguration","description":"The arc axis configuration of a `GaugeChartVisual` ."},"comparison":{"$ref":"#/types/aws-native:quicksight:DashboardComparisonConfiguration","description":"The comparison configuration of a `GaugeChartVisual` ."},"primaryValueDisplayType":{"$ref":"#/types/aws-native:quicksight:DashboardPrimaryValueDisplayType","description":"The options that determine the primary value display type."},"primaryValueFontConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFontConfiguration","description":"The options that determine the primary value font configuration."}},"type":"object"},"aws-native:quicksight:DashboardGaugeChartPrimaryValueConditionalFormatting":{"properties":{"icon":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingIcon","description":"The conditional formatting of the primary value icon."},"textColor":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingColor","description":"The conditional formatting of the primary value text color."}},"type":"object"},"aws-native:quicksight:DashboardGaugeChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardGaugeChartConfiguration","description":"The configuration of a `GaugeChartVisual` ."},"conditionalFormatting":{"$ref":"#/types/aws-native:quicksight:DashboardGaugeChartConditionalFormatting","description":"The conditional formatting of a `GaugeChartVisual` ."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardGeospatialCategoricalColor":{"properties":{"categoryDataColors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialCategoricalDataColor"},"description":"A list of categorical data colors for each category."},"defaultOpacity":{"type":"number","description":"The default opacity of a categorical color."},"nullDataSettings":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialNullDataSettings","description":"The null data visualization settings."},"nullDataVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The state of visibility for null data."}},"type":"object","required":["categoryDataColors"]},"aws-native:quicksight:DashboardGeospatialCategoricalDataColor":{"properties":{"color":{"type":"string","description":"The color and opacity values for the category data color."},"dataValue":{"type":"string","description":"The data value for the category data color."}},"type":"object","required":["color","dataValue"]},"aws-native:quicksight:DashboardGeospatialCircleRadius":{"properties":{"radius":{"type":"number","description":"The positive value for the radius of a circle."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialCircleSymbolStyle":{"properties":{"circleRadius":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialCircleRadius","description":"The radius of the circle."},"fillColor":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialColor","description":"The color and opacity values for the fill color."},"strokeColor":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialColor","description":"The color and opacity values for the stroke color."},"strokeWidth":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialLineWidth","description":"The width of the stroke (border)."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialColor":{"properties":{"categorical":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialCategoricalColor","description":"The visualization properties for the categorical color."},"gradient":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialGradientColor","description":"The visualization properties for the gradient color."},"solid":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialSolidColor","description":"The visualization properties for the solid color."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialColorState":{"description":"Defines view state of the color","type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:DashboardGeospatialCoordinateBounds":{"properties":{"east":{"type":"number","description":"The longitude of the east bound of the geospatial coordinate bounds."},"north":{"type":"number","description":"The latitude of the north bound of the geospatial coordinate bounds."},"south":{"type":"number","description":"The latitude of the south bound of the geospatial coordinate bounds."},"west":{"type":"number","description":"The longitude of the west bound of the geospatial coordinate bounds."}},"type":"object","required":["east","north","south","west"]},"aws-native:quicksight:DashboardGeospatialDataSourceItem":{"properties":{"staticFileDataSource":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialStaticFileSource","description":"The static file data source properties for the geospatial data."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialGradientColor":{"properties":{"defaultOpacity":{"type":"number","description":"The default opacity for the gradient color."},"nullDataSettings":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialNullDataSettings","description":"The null data visualization settings."},"nullDataVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The state of visibility for null data."},"stepColors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialGradientStepColor"},"description":"A list of gradient step colors for the gradient."}},"type":"object","required":["stepColors"]},"aws-native:quicksight:DashboardGeospatialGradientStepColor":{"properties":{"color":{"type":"string","description":"The color and opacity values for the gradient step color."},"dataValue":{"type":"number","description":"The data value for the gradient step color."}},"type":"object","required":["color","dataValue"]},"aws-native:quicksight:DashboardGeospatialHeatmapColorScale":{"properties":{"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialHeatmapDataColor"},"description":"The list of colors to be used in heatmap point style."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialHeatmapConfiguration":{"properties":{"heatmapColor":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialHeatmapColorScale","description":"The color scale specification for the heatmap point style."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialHeatmapDataColor":{"properties":{"color":{"type":"string","description":"The hex color to be used in the heatmap point style."}},"type":"object","required":["color"]},"aws-native:quicksight:DashboardGeospatialLayerColorField":{"properties":{"colorDimensionsFields":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"A list of color dimension fields."},"colorValuesFields":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"A list of color measure fields."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialLayerDefinition":{"properties":{"lineLayer":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialLineLayer","description":"The definition for a line layer."},"pointLayer":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialPointLayer","description":"The definition for a point layer."},"polygonLayer":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialPolygonLayer","description":"The definition for a polygon layer."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialLayerItem":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardLayerCustomAction"},"description":"A list of custom actions for a layer."},"dataSource":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialDataSourceItem","description":"The data source for the layer."},"joinDefinition":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialLayerJoinDefinition","description":"The join definition properties for a layer."},"label":{"type":"string","description":"The label that is displayed for the layer."},"layerDefinition":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialLayerDefinition","description":"The definition properties for a layer."},"layerId":{"type":"string","description":"The ID of the layer."},"layerType":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialLayerType","description":"The layer type."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions"},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The state of visibility for the layer."}},"type":"object","required":["layerId"]},"aws-native:quicksight:DashboardGeospatialLayerJoinDefinition":{"properties":{"colorField":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialLayerColorField","description":"The geospatial color field for the join definition."},"datasetKeyField":{"$ref":"#/types/aws-native:quicksight:DashboardUnaggregatedField"},"shapeKeyField":{"type":"string","description":"The name of the field or property in the geospatial data source."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialLayerMapConfiguration":{"properties":{"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions"},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions"},"mapLayers":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialLayerItem"},"description":"The geospatial layers to visualize on the map."},"mapState":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialMapState","description":"The map state properties for the map."},"mapStyle":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialMapStyle","description":"The map style properties for the map."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialLayerType":{"type":"string","enum":[{"name":"Point","value":"POINT"},{"name":"Line","value":"LINE"},{"name":"Polygon","value":"POLYGON"}]},"aws-native:quicksight:DashboardGeospatialLineLayer":{"properties":{"style":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialLineStyle","description":"The visualization style for a line layer."}},"type":"object","required":["style"]},"aws-native:quicksight:DashboardGeospatialLineStyle":{"properties":{"lineSymbolStyle":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialLineSymbolStyle","description":"The symbol style for a line style."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialLineSymbolStyle":{"properties":{"fillColor":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialColor","description":"The color and opacity values for the fill color."},"lineWidth":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialLineWidth","description":"The width value for a line."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialLineWidth":{"properties":{"lineWidth":{"type":"number","description":"The positive value for the width of a line."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialMapAggregatedFieldWells":{"properties":{"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The color field wells of a geospatial map."},"geospatial":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The geospatial field wells of a geospatial map. Values are grouped by geospatial fields."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The size field wells of a geospatial map. Values are aggregated based on geospatial fields."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialMapConfiguration":{"properties":{"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialMapFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions","description":"The legend display setup of the visual."},"mapStyleOptions":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialMapStyleOptions","description":"The map style options of the geospatial map."},"pointStyleOptions":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialPointStyleOptions","description":"The point style options of the geospatial map."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The tooltip display setup of the visual."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPalette"},"windowOptions":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialWindowOptions","description":"The window options of the geospatial map."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialMapFieldWells":{"properties":{"geospatialMapAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialMapAggregatedFieldWells","description":"The aggregated field well for a geospatial map."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialMapNavigation":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:DashboardGeospatialMapState":{"properties":{"bounds":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialCoordinateBounds"},"mapNavigation":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialMapNavigation","description":"Enables or disables map navigation for a map."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialMapStyle":{"properties":{"backgroundColor":{"type":"string","description":"The background color and opacity values for a map."},"baseMapStyle":{"$ref":"#/types/aws-native:quicksight:DashboardBaseMapStyleType","description":"The selected base map style."},"baseMapVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The state of visibility for the base map."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialMapStyleOptions":{"properties":{"baseMapStyle":{"$ref":"#/types/aws-native:quicksight:DashboardBaseMapStyleType","description":"The base map style of the geospatial map."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialMapVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialMapConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardGeospatialNullDataSettings":{"properties":{"symbolStyle":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialNullSymbolStyle","description":"The symbol style for null data."}},"type":"object","required":["symbolStyle"]},"aws-native:quicksight:DashboardGeospatialNullSymbolStyle":{"properties":{"fillColor":{"type":"string","description":"The color and opacity values for the fill color."},"strokeColor":{"type":"string","description":"The color and opacity values for the stroke color."},"strokeWidth":{"type":"number","description":"The width of the border stroke."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialPointLayer":{"properties":{"style":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialPointStyle","description":"The visualization style for a point layer."}},"type":"object","required":["style"]},"aws-native:quicksight:DashboardGeospatialPointStyle":{"properties":{"circleSymbolStyle":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialCircleSymbolStyle","description":"The circle symbol style for a point layer."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialPointStyleOptions":{"properties":{"clusterMarkerConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardClusterMarkerConfiguration","description":"The cluster marker configuration of the geospatial point style."},"heatmapConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialHeatmapConfiguration","description":"The heatmap configuration of the geospatial point style."},"selectedPointStyle":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialSelectedPointStyle","description":"The selected point styles (point, cluster) of the geospatial map."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialPolygonLayer":{"properties":{"style":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialPolygonStyle","description":"The visualization style for a polygon layer."}},"type":"object","required":["style"]},"aws-native:quicksight:DashboardGeospatialPolygonStyle":{"properties":{"polygonSymbolStyle":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialPolygonSymbolStyle","description":"The polygon symbol style for a polygon layer."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialPolygonSymbolStyle":{"properties":{"fillColor":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialColor","description":"The color and opacity values for the fill color."},"strokeColor":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialColor","description":"The color and opacity values for the stroke color."},"strokeWidth":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialLineWidth","description":"The width of the border stroke."}},"type":"object"},"aws-native:quicksight:DashboardGeospatialSelectedPointStyle":{"type":"string","enum":[{"name":"Point","value":"POINT"},{"name":"Cluster","value":"CLUSTER"},{"name":"Heatmap","value":"HEATMAP"}]},"aws-native:quicksight:DashboardGeospatialSolidColor":{"description":"Describes the properties for a solid color","properties":{"color":{"type":"string","description":"The color and opacity values for the color."},"state":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialColorState","description":"Enables and disables the view state of the color."}},"type":"object","required":["color"]},"aws-native:quicksight:DashboardGeospatialStaticFileSource":{"properties":{"staticFileId":{"type":"string","description":"The ID of the static file."}},"type":"object","required":["staticFileId"]},"aws-native:quicksight:DashboardGeospatialWindowOptions":{"properties":{"bounds":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialCoordinateBounds","description":"The bounds options (north, south, west, east) of the geospatial window options."},"mapZoomMode":{"$ref":"#/types/aws-native:quicksight:DashboardMapZoomMode","description":"The map zoom modes (manual, auto) of the geospatial window options."}},"type":"object"},"aws-native:quicksight:DashboardGlobalTableBorderOptions":{"properties":{"sideSpecificBorder":{"$ref":"#/types/aws-native:quicksight:DashboardTableSideBorderOptions","description":"Determines the options for side specific border."},"uniformBorder":{"$ref":"#/types/aws-native:quicksight:DashboardTableBorderOptions","description":"Determines the options for uniform border."}},"type":"object"},"aws-native:quicksight:DashboardGradientColor":{"properties":{"stops":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardGradientStop"},"description":"The list of gradient color stops."}},"type":"object"},"aws-native:quicksight:DashboardGradientStop":{"properties":{"color":{"type":"string","description":"Determines the color."},"dataValue":{"type":"number","description":"Determines the data value."},"gradientOffset":{"type":"number","description":"Determines gradient offset value."}},"type":"object","required":["gradientOffset"]},"aws-native:quicksight:DashboardGridLayoutCanvasSizeOptions":{"properties":{"screenCanvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:DashboardGridLayoutScreenCanvasSizeOptions","description":"The options that determine the sizing of the canvas used in a grid layout."}},"type":"object"},"aws-native:quicksight:DashboardGridLayoutConfiguration":{"properties":{"canvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:DashboardGridLayoutCanvasSizeOptions"},"elements":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardGridLayoutElement"},"description":"The elements that are included in a grid layout."}},"type":"object","required":["elements"]},"aws-native:quicksight:DashboardGridLayoutElement":{"properties":{"backgroundStyle":{"$ref":"#/types/aws-native:quicksight:DashboardGridLayoutElementBackgroundStyle","description":"The background style configuration of a grid layout element."},"borderRadius":{"type":"string","description":"The border radius of a grid layout element."},"borderStyle":{"$ref":"#/types/aws-native:quicksight:DashboardGridLayoutElementBorderStyle","description":"The border style configuration of a grid layout element."},"columnIndex":{"type":"number","description":"The column index for the upper left corner of an element."},"columnSpan":{"type":"number","description":"The width of a grid element expressed as a number of grid columns."},"elementId":{"type":"string","description":"A unique identifier for an element within a grid layout."},"elementType":{"$ref":"#/types/aws-native:quicksight:DashboardLayoutElementType","description":"The type of element."},"loadingAnimation":{"$ref":"#/types/aws-native:quicksight:DashboardLoadingAnimation"},"padding":{"type":"string","description":"The padding of a grid layout element."},"rowIndex":{"type":"number","description":"The row index for the upper left corner of an element."},"rowSpan":{"type":"number","description":"The height of a grid element expressed as a number of grid rows."},"selectedBorderStyle":{"$ref":"#/types/aws-native:quicksight:DashboardGridLayoutElementBorderStyle","description":"The border style configuration of a grid layout element. This border style is used when the element is selected."}},"type":"object","required":["columnSpan","elementId","elementType","rowSpan"]},"aws-native:quicksight:DashboardGridLayoutElementBackgroundStyle":{"properties":{"color":{"type":"string","description":"The background color of a grid layout element."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The background visibility of a grid layout element."}},"type":"object"},"aws-native:quicksight:DashboardGridLayoutElementBorderStyle":{"properties":{"color":{"type":"string","description":"The border color of a grid layout element."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The border visibility of a grid layout element."},"width":{"type":"string","description":"String to encapsulate the most generic way Width can be formatted with whatever units (px, em etc)"}},"type":"object"},"aws-native:quicksight:DashboardGridLayoutScreenCanvasSizeOptions":{"properties":{"optimizedViewPortWidth":{"type":"string","description":"String based length that is composed of value and unit in px"},"resizeOption":{"$ref":"#/types/aws-native:quicksight:DashboardResizeOption","description":"This value determines the layout behavior when the viewport is resized.\n\n- `FIXED` : A fixed width will be used when optimizing the layout. In the Quick Sight console, this option is called `Classic` .\n- `RESPONSIVE` : The width of the canvas will be responsive and optimized to the view port. In the Quick Sight console, this option is called `Tiled` ."}},"type":"object","required":["resizeOption"]},"aws-native:quicksight:DashboardGrowthRateComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."},"periodSize":{"type":"number","description":"The period size setup of a growth rate computation."},"time":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField","description":"The time field that is used in a computation."},"value":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:DashboardHeaderFooterSectionConfiguration":{"properties":{"layout":{"$ref":"#/types/aws-native:quicksight:DashboardSectionLayoutConfiguration","description":"The layout configuration of the header or footer section."},"sectionId":{"type":"string","description":"The unique identifier of the header or footer section."},"style":{"$ref":"#/types/aws-native:quicksight:DashboardSectionStyle","description":"The style options of a header or footer section."}},"type":"object","required":["layout","sectionId"]},"aws-native:quicksight:DashboardHeatMapAggregatedFieldWells":{"properties":{"columns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The columns field well of a heat map."},"rows":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The rows field well of a heat map."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The values field well of a heat map."}},"type":"object"},"aws-native:quicksight:DashboardHeatMapConfiguration":{"properties":{"colorScale":{"$ref":"#/types/aws-native:quicksight:DashboardColorScale","description":"The color options (gradient color, point of divergence) in a heat map."},"columnLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options of the column that is displayed in a heat map."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOptions","description":"The options that determine if visual data labels are displayed."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardHeatMapFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions","description":"The legend display setup of the visual."},"rowLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options of the row that is displayed in a `heat map` ."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardHeatMapSortConfiguration","description":"The sort configuration of a heat map."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The tooltip display setup of the visual."}},"type":"object"},"aws-native:quicksight:DashboardHeatMapFieldWells":{"properties":{"heatMapAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardHeatMapAggregatedFieldWells","description":"The aggregated field wells of a heat map."}},"type":"object"},"aws-native:quicksight:DashboardHeatMapSortConfiguration":{"properties":{"heatMapColumnItemsLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of columns that are displayed in a heat map."},"heatMapColumnSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The column sort configuration for heat map for columns that aren't a part of a field well."},"heatMapRowItemsLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of rows that are displayed in a heat map."},"heatMapRowSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The field sort configuration of the rows fields."}},"type":"object"},"aws-native:quicksight:DashboardHeatMapVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardHeatMapConfiguration","description":"The configuration of a heat map."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardHistogramAggregatedFieldWells":{"properties":{"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The value field wells of a histogram. Values are aggregated by `COUNT` or `DISTINCT_COUNT` ."}},"type":"object"},"aws-native:quicksight:DashboardHistogramBinOptions":{"properties":{"binCount":{"$ref":"#/types/aws-native:quicksight:DashboardBinCountOptions","description":"The options that determine the bin count of a histogram."},"binWidth":{"$ref":"#/types/aws-native:quicksight:DashboardBinWidthOptions","description":"The options that determine the bin width of a histogram."},"selectedBinType":{"$ref":"#/types/aws-native:quicksight:DashboardHistogramBinType","description":"The options that determine the selected bin type."},"startValue":{"type":"number","description":"The options that determine the bin start value."}},"type":"object"},"aws-native:quicksight:DashboardHistogramBinType":{"type":"string","enum":[{"name":"BinCount","value":"BIN_COUNT"},{"name":"BinWidth","value":"BIN_WIDTH"}]},"aws-native:quicksight:DashboardHistogramConfiguration":{"properties":{"binOptions":{"$ref":"#/types/aws-native:quicksight:DashboardHistogramBinOptions","description":"The options that determine the presentation of histogram bins."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOptions","description":"The data label configuration of a histogram."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardHistogramFieldWells","description":"The field well configuration of a histogram."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The tooltip configuration of a histogram."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPalette","description":"The visual palette configuration of a histogram."},"xAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The options that determine the presentation of the x-axis."},"xAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The options that determine the presentation of the x-axis label."},"yAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The options that determine the presentation of the y-axis."}},"type":"object"},"aws-native:quicksight:DashboardHistogramFieldWells":{"properties":{"histogramAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardHistogramAggregatedFieldWells","description":"The field well configuration of a histogram."}},"type":"object"},"aws-native:quicksight:DashboardHistogramVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardHistogramConfiguration","description":"The configuration for a `HistogramVisual` ."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardHorizontalTextAlignment":{"type":"string","enum":[{"name":"Left","value":"LEFT"},{"name":"Center","value":"CENTER"},{"name":"Right","value":"RIGHT"},{"name":"Auto","value":"AUTO"}]},"aws-native:quicksight:DashboardIcon":{"type":"string","enum":[{"name":"CaretUp","value":"CARET_UP"},{"name":"CaretDown","value":"CARET_DOWN"},{"name":"Plus","value":"PLUS"},{"name":"Minus","value":"MINUS"},{"name":"ArrowUp","value":"ARROW_UP"},{"name":"ArrowDown","value":"ARROW_DOWN"},{"name":"ArrowLeft","value":"ARROW_LEFT"},{"name":"ArrowUpLeft","value":"ARROW_UP_LEFT"},{"name":"ArrowDownLeft","value":"ARROW_DOWN_LEFT"},{"name":"ArrowRight","value":"ARROW_RIGHT"},{"name":"ArrowUpRight","value":"ARROW_UP_RIGHT"},{"name":"ArrowDownRight","value":"ARROW_DOWN_RIGHT"},{"name":"FaceUp","value":"FACE_UP"},{"name":"FaceDown","value":"FACE_DOWN"},{"name":"FaceFlat","value":"FACE_FLAT"},{"name":"OneBar","value":"ONE_BAR"},{"name":"TwoBar","value":"TWO_BAR"},{"name":"ThreeBar","value":"THREE_BAR"},{"name":"Circle","value":"CIRCLE"},{"name":"Triangle","value":"TRIANGLE"},{"name":"Square","value":"SQUARE"},{"name":"Flag","value":"FLAG"},{"name":"ThumbsUp","value":"THUMBS_UP"},{"name":"ThumbsDown","value":"THUMBS_DOWN"},{"name":"Checkmark","value":"CHECKMARK"},{"name":"X","value":"X"}]},"aws-native:quicksight:DashboardImageCustomAction":{"properties":{"actionOperations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardImageCustomActionOperation"},"description":"A list of `ImageCustomActionOperations` .\n\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined."},"customActionId":{"type":"string","description":"The ID of the custom action."},"name":{"type":"string","description":"The name of the custom action."},"status":{"$ref":"#/types/aws-native:quicksight:DashboardWidgetStatus","description":"The status of the custom action."},"trigger":{"$ref":"#/types/aws-native:quicksight:DashboardImageCustomActionTrigger","description":"The trigger of the `VisualCustomAction` .\n\nValid values are defined as follows:\n\n- `CLICK` : Initiates a custom action by a left pointer click on a data point.\n- `MENU` : Initiates a custom action by right pointer click from the menu."}},"type":"object","required":["actionOperations","customActionId","name","trigger"]},"aws-native:quicksight:DashboardImageCustomActionOperation":{"properties":{"navigationOperation":{"$ref":"#/types/aws-native:quicksight:DashboardCustomActionNavigationOperation"},"setParametersOperation":{"$ref":"#/types/aws-native:quicksight:DashboardCustomActionSetParametersOperation"},"urlOperation":{"$ref":"#/types/aws-native:quicksight:DashboardCustomActionUrlOperation"}},"type":"object"},"aws-native:quicksight:DashboardImageCustomActionTrigger":{"type":"string","enum":[{"name":"Click","value":"CLICK"},{"name":"Menu","value":"MENU"}]},"aws-native:quicksight:DashboardImageInteractionOptions":{"properties":{"imageMenuOption":{"$ref":"#/types/aws-native:quicksight:DashboardImageMenuOption","description":"The menu options for the image."}},"type":"object"},"aws-native:quicksight:DashboardImageMenuOption":{"properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"The availability status of the image menu. If the value of this property is set to `ENABLED` , dashboard readers can interact with the image menu."}},"type":"object"},"aws-native:quicksight:DashboardImageStaticFile":{"properties":{"source":{"$ref":"#/types/aws-native:quicksight:DashboardStaticFileSource","description":"The source of the image static file."},"staticFileId":{"type":"string","description":"The ID of the static file that contains an image."}},"type":"object","required":["staticFileId"]},"aws-native:quicksight:DashboardInnerFilter":{"properties":{"categoryInnerFilter":{"$ref":"#/types/aws-native:quicksight:DashboardCategoryInnerFilter","description":"A `CategoryInnerFilter` filters text values for the `NestedFilter` ."}},"type":"object"},"aws-native:quicksight:DashboardInsightConfiguration":{"properties":{"computations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardComputation"},"description":"The computations configurations of the insight visual"},"customNarrative":{"$ref":"#/types/aws-native:quicksight:DashboardCustomNarrativeOptions","description":"The custom narrative of the insight visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."}},"type":"object"},"aws-native:quicksight:DashboardInsightVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"dataSetIdentifier":{"type":"string","description":"The dataset that is used in the insight visual."},"insightConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardInsightConfiguration","description":"The configuration of an insight visual."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["dataSetIdentifier","visualId"]},"aws-native:quicksight:DashboardIntegerDefaultValues":{"properties":{"dynamicValue":{"$ref":"#/types/aws-native:quicksight:DashboardDynamicDefaultValue","description":"The dynamic value of the `IntegerDefaultValues` . Different defaults are displayed according to users, groups, and values mapping."},"staticValues":{"type":"array","items":{"type":"number"},"description":"The static values of the `IntegerDefaultValues` ."}},"type":"object"},"aws-native:quicksight:DashboardIntegerParameter":{"description":"\u003cp\u003eAn integer parameter.\u003c/p\u003e","properties":{"name":{"type":"string","description":"\u003cp\u003eThe name of the integer parameter.\u003c/p\u003e"},"values":{"type":"array","items":{"type":"number"},"description":"\u003cp\u003eThe values for the integer parameter.\u003c/p\u003e"}},"type":"object","required":["name","values"]},"aws-native:quicksight:DashboardIntegerParameterDeclaration":{"properties":{"defaultValues":{"$ref":"#/types/aws-native:quicksight:DashboardIntegerDefaultValues","description":"The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided."},"mappedDataSetParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMappedDataSetParameter"}},"name":{"type":"string","description":"The name of the parameter that is being declared."},"parameterValueType":{"$ref":"#/types/aws-native:quicksight:DashboardParameterValueType","description":"The value type determines whether the parameter is a single-value or multi-value parameter."},"valueWhenUnset":{"$ref":"#/types/aws-native:quicksight:DashboardIntegerValueWhenUnsetConfiguration","description":"A parameter declaration for the `Integer` data type."}},"type":"object","required":["name","parameterValueType"]},"aws-native:quicksight:DashboardIntegerValueWhenUnsetConfiguration":{"properties":{"customValue":{"type":"number","description":"A custom value that's used when the value of a parameter isn't set."},"valueWhenUnsetOption":{"$ref":"#/types/aws-native:quicksight:DashboardValueWhenUnsetOption","description":"The built-in options for default values. The value can be one of the following:\n\n- `RECOMMENDED` : The recommended value.\n- `NULL` : The `NULL` value."}},"type":"object"},"aws-native:quicksight:DashboardItemsLimitConfiguration":{"properties":{"itemsLimit":{"type":"number","description":"The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart."},"otherCategories":{"$ref":"#/types/aws-native:quicksight:DashboardOtherCategories","description":"The `Show other` of an axis in the chart. Choose one of the following options:\n\n- `INCLUDE`\n- `EXCLUDE`"}},"type":"object"},"aws-native:quicksight:DashboardKpiActualValueConditionalFormatting":{"properties":{"icon":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingIcon","description":"The conditional formatting of the actual value's icon."},"textColor":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingColor","description":"The conditional formatting of the actual value's text color."}},"type":"object"},"aws-native:quicksight:DashboardKpiComparisonValueConditionalFormatting":{"properties":{"icon":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingIcon","description":"The conditional formatting of the comparison value's icon."},"textColor":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingColor","description":"The conditional formatting of the comparison value's text color."}},"type":"object"},"aws-native:quicksight:DashboardKpiConditionalFormatting":{"properties":{"conditionalFormattingOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardKpiConditionalFormattingOption"},"description":"The conditional formatting options of a KPI visual."}},"type":"object"},"aws-native:quicksight:DashboardKpiConditionalFormattingOption":{"properties":{"actualValue":{"$ref":"#/types/aws-native:quicksight:DashboardKpiActualValueConditionalFormatting","description":"The conditional formatting for the actual value of a KPI visual."},"comparisonValue":{"$ref":"#/types/aws-native:quicksight:DashboardKpiComparisonValueConditionalFormatting","description":"The conditional formatting for the comparison value of a KPI visual."},"primaryValue":{"$ref":"#/types/aws-native:quicksight:DashboardKpiPrimaryValueConditionalFormatting","description":"The conditional formatting for the primary value of a KPI visual."},"progressBar":{"$ref":"#/types/aws-native:quicksight:DashboardKpiProgressBarConditionalFormatting","description":"The conditional formatting for the progress bar of a KPI visual."}},"type":"object"},"aws-native:quicksight:DashboardKpiConfiguration":{"properties":{"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardKpiFieldWells","description":"The field well configuration of a KPI visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"kpiOptions":{"$ref":"#/types/aws-native:quicksight:DashboardKpiOptions","description":"The options that determine the presentation of a KPI visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardKpiSortConfiguration","description":"The sort configuration of a KPI visual."}},"type":"object"},"aws-native:quicksight:DashboardKpiFieldWells":{"properties":{"targetValues":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The target value field wells of a KPI visual."},"trendGroups":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The trend group field wells of a KPI visual."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The value field wells of a KPI visual."}},"type":"object"},"aws-native:quicksight:DashboardKpiOptions":{"properties":{"comparison":{"$ref":"#/types/aws-native:quicksight:DashboardComparisonConfiguration","description":"The comparison configuration of a KPI visual."},"primaryValueDisplayType":{"$ref":"#/types/aws-native:quicksight:DashboardPrimaryValueDisplayType","description":"The options that determine the primary value display type."},"primaryValueFontConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFontConfiguration","description":"The options that determine the primary value font configuration."},"progressBar":{"$ref":"#/types/aws-native:quicksight:DashboardProgressBarOptions","description":"The options that determine the presentation of the progress bar of a KPI visual."},"secondaryValue":{"$ref":"#/types/aws-native:quicksight:DashboardSecondaryValueOptions","description":"The options that determine the presentation of the secondary value of a KPI visual."},"secondaryValueFontConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFontConfiguration","description":"The options that determine the secondary value font configuration."},"sparkline":{"$ref":"#/types/aws-native:quicksight:DashboardKpiSparklineOptions","description":"The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual."},"trendArrows":{"$ref":"#/types/aws-native:quicksight:DashboardTrendArrowOptions","description":"The options that determine the presentation of trend arrows in a KPI visual."},"visualLayoutOptions":{"$ref":"#/types/aws-native:quicksight:DashboardKpiVisualLayoutOptions","description":"The options that determine the layout a KPI visual."}},"type":"object"},"aws-native:quicksight:DashboardKpiPrimaryValueConditionalFormatting":{"properties":{"icon":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingIcon","description":"The conditional formatting of the primary value's icon."},"textColor":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingColor","description":"The conditional formatting of the primary value's text color."}},"type":"object"},"aws-native:quicksight:DashboardKpiProgressBarConditionalFormatting":{"properties":{"foregroundColor":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingColor","description":"The conditional formatting of the progress bar's foreground color."}},"type":"object"},"aws-native:quicksight:DashboardKpiSortConfiguration":{"properties":{"trendGroupSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of the trend group fields."}},"type":"object"},"aws-native:quicksight:DashboardKpiSparklineOptions":{"properties":{"color":{"type":"string","description":"The color of the sparkline."},"tooltipVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The tooltip visibility of the sparkline."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardKpiSparklineType","description":"The type of the sparkline."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the sparkline."}},"type":"object","required":["type"]},"aws-native:quicksight:DashboardKpiSparklineType":{"type":"string","enum":[{"name":"Line","value":"LINE"},{"name":"Area","value":"AREA"}]},"aws-native:quicksight:DashboardKpiVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardKpiConfiguration","description":"The configuration of a KPI visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"conditionalFormatting":{"$ref":"#/types/aws-native:quicksight:DashboardKpiConditionalFormatting","description":"The conditional formatting of a KPI visual."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardKpiVisualLayoutOptions":{"properties":{"standardLayout":{"$ref":"#/types/aws-native:quicksight:DashboardKpiVisualStandardLayout","description":"The standard layout of the KPI visual."}},"type":"object"},"aws-native:quicksight:DashboardKpiVisualStandardLayout":{"properties":{"type":{"$ref":"#/types/aws-native:quicksight:DashboardKpiVisualStandardLayoutType","description":"The standard layout type."}},"type":"object","required":["type"]},"aws-native:quicksight:DashboardKpiVisualStandardLayoutType":{"type":"string","enum":[{"name":"Classic","value":"CLASSIC"},{"name":"Vertical","value":"VERTICAL"}]},"aws-native:quicksight:DashboardLabelOptions":{"properties":{"customLabel":{"type":"string","description":"The text for the label."},"fontConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFontConfiguration","description":"The font configuration of the label."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines whether or not the label is visible."}},"type":"object"},"aws-native:quicksight:DashboardLayerCustomAction":{"properties":{"actionOperations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardLayerCustomActionOperation"},"description":"A list of `LayerCustomActionOperations` .\n\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined."},"customActionId":{"type":"string","description":"The ID of the custom action."},"name":{"type":"string","description":"The name of the custom action."},"status":{"$ref":"#/types/aws-native:quicksight:DashboardWidgetStatus","description":"The status of the `LayerCustomAction` ."},"trigger":{"$ref":"#/types/aws-native:quicksight:DashboardLayerCustomActionTrigger","description":"The trigger of the `LayerCustomAction` .\n\nValid values are defined as follows:\n\n- `DATA_POINT_CLICK` : Initiates a custom action by a left pointer click on a data point.\n- `DATA_POINT_MENU` : Initiates a custom action by right pointer click from the menu."}},"type":"object","required":["actionOperations","customActionId","name","trigger"]},"aws-native:quicksight:DashboardLayerCustomActionOperation":{"properties":{"filterOperation":{"$ref":"#/types/aws-native:quicksight:DashboardCustomActionFilterOperation"},"navigationOperation":{"$ref":"#/types/aws-native:quicksight:DashboardCustomActionNavigationOperation"},"setParametersOperation":{"$ref":"#/types/aws-native:quicksight:DashboardCustomActionSetParametersOperation"},"urlOperation":{"$ref":"#/types/aws-native:quicksight:DashboardCustomActionUrlOperation"}},"type":"object"},"aws-native:quicksight:DashboardLayerCustomActionTrigger":{"type":"string","enum":[{"name":"DataPointClick","value":"DATA_POINT_CLICK"},{"name":"DataPointMenu","value":"DATA_POINT_MENU"}]},"aws-native:quicksight:DashboardLayerMapVisual":{"properties":{"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialLayerMapConfiguration","description":"The configuration settings of the visual."},"dataSetIdentifier":{"type":"string","description":"The dataset that is used to create the layer map visual. You can't create a visual without a dataset."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions"},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions"},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The ID of the visual."}},"type":"object","required":["dataSetIdentifier","visualId"]},"aws-native:quicksight:DashboardLayout":{"properties":{"configuration":{"$ref":"#/types/aws-native:quicksight:DashboardLayoutConfiguration","description":"The configuration that determines what the type of layout for a sheet."}},"type":"object","required":["configuration"]},"aws-native:quicksight:DashboardLayoutConfiguration":{"properties":{"freeFormLayout":{"$ref":"#/types/aws-native:quicksight:DashboardFreeFormLayoutConfiguration","description":"A free-form is optimized for a fixed width and has more control over the exact placement of layout elements."},"gridLayout":{"$ref":"#/types/aws-native:quicksight:DashboardGridLayoutConfiguration","description":"A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: `FIXED` or `RESPONSIVE` ."},"sectionBasedLayout":{"$ref":"#/types/aws-native:quicksight:DashboardSectionBasedLayoutConfiguration","description":"A section based layout organizes visuals into multiple sections and has customized header, footer and page break."}},"type":"object"},"aws-native:quicksight:DashboardLayoutElementType":{"type":"string","enum":[{"name":"Visual","value":"VISUAL"},{"name":"FilterControl","value":"FILTER_CONTROL"},{"name":"ParameterControl","value":"PARAMETER_CONTROL"},{"name":"TextBox","value":"TEXT_BOX"},{"name":"Image","value":"IMAGE"}]},"aws-native:quicksight:DashboardLegendOptions":{"properties":{"height":{"type":"string","description":"String based length that is composed of value and unit in px"},"position":{"$ref":"#/types/aws-native:quicksight:DashboardLegendPosition","description":"The positions for the legend. Choose one of the following options:\n\n- `AUTO`\n- `RIGHT`\n- `BOTTOM`\n- `LEFT`"},"title":{"$ref":"#/types/aws-native:quicksight:DashboardLabelOptions","description":"The custom title for the legend."},"valueFontConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFontConfiguration"},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines whether or not the legend is visible."},"width":{"type":"string","description":"String based length that is composed of value and unit in px"}},"type":"object"},"aws-native:quicksight:DashboardLegendPosition":{"type":"string","enum":[{"name":"Auto","value":"AUTO"},{"name":"Right","value":"RIGHT"},{"name":"Bottom","value":"BOTTOM"},{"name":"Top","value":"TOP"}]},"aws-native:quicksight:DashboardLineChartAggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The category field wells of a line chart. Values are grouped by category fields."},"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The color field wells of a line chart. Values are grouped by category fields."},"smallMultiples":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The small multiples field well of a line chart."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The value field wells of a line chart. Values are aggregated based on categories."}},"type":"object"},"aws-native:quicksight:DashboardLineChartConfiguration":{"properties":{"contributionAnalysisDefaults":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardContributionAnalysisDefault"},"description":"The default configuration of a line chart's contribution analysis."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOptions","description":"The data label configuration of a line chart."},"defaultSeriesSettings":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartDefaultSeriesSettings","description":"The options that determine the default presentation of all line series in `LineChartVisual` ."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartFieldWells","description":"The field well configuration of a line chart."},"forecastConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardForecastConfiguration"},"description":"The forecast configuration of a line chart."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions","description":"The legend configuration of a line chart."},"primaryYAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardLineSeriesAxisDisplayOptions","description":"The series axis configuration of a line chart."},"primaryYAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The options that determine the presentation of the y-axis label."},"referenceLines":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLine"},"description":"The reference lines configuration of a line chart."},"secondaryYAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardLineSeriesAxisDisplayOptions","description":"The series axis configuration of a line chart."},"secondaryYAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The options that determine the presentation of the secondary y-axis label."},"series":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardSeriesItem"},"description":"The series item configuration of a line chart."},"singleAxisOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSingleAxisOptions"},"smallMultiplesOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSmallMultiplesOptions","description":"The small multiples setup for the visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartSortConfiguration","description":"The sort configuration of a line chart."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The tooltip configuration of a line chart."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartType","description":"Determines the type of the line chart."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPalette","description":"The visual palette configuration of a line chart."},"xAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The options that determine the presentation of the x-axis."},"xAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The options that determine the presentation of the x-axis label."}},"type":"object"},"aws-native:quicksight:DashboardLineChartDefaultSeriesSettings":{"properties":{"axisBinding":{"$ref":"#/types/aws-native:quicksight:DashboardAxisBinding","description":"The axis to which you are binding all line series to."},"lineStyleSettings":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartLineStyleSettings","description":"Line styles options for all line series in the visual."},"markerStyleSettings":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartMarkerStyleSettings","description":"Marker styles options for all line series in the visual."}},"type":"object"},"aws-native:quicksight:DashboardLineChartFieldWells":{"properties":{"lineChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartAggregatedFieldWells","description":"The field well configuration of a line chart."}},"type":"object"},"aws-native:quicksight:DashboardLineChartLineStyle":{"type":"string","enum":[{"name":"Solid","value":"SOLID"},{"name":"Dotted","value":"DOTTED"},{"name":"Dashed","value":"DASHED"}]},"aws-native:quicksight:DashboardLineChartLineStyleSettings":{"properties":{"lineInterpolation":{"$ref":"#/types/aws-native:quicksight:DashboardLineInterpolation","description":"Interpolation style for line series.\n\n- `LINEAR` : Show as default, linear style.\n- `SMOOTH` : Show as a smooth curve.\n- `STEPPED` : Show steps in line."},"lineStyle":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartLineStyle","description":"Line style for line series.\n\n- `SOLID` : Show as a solid line.\n- `DOTTED` : Show as a dotted line.\n- `DASHED` : Show as a dashed line."},"lineVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Configuration option that determines whether to show the line for the series."},"lineWidth":{"type":"string","description":"String based length that is composed of value and unit in px"}},"type":"object"},"aws-native:quicksight:DashboardLineChartMarkerShape":{"type":"string","enum":[{"name":"Circle","value":"CIRCLE"},{"name":"Triangle","value":"TRIANGLE"},{"name":"Square","value":"SQUARE"},{"name":"Diamond","value":"DIAMOND"},{"name":"RoundedSquare","value":"ROUNDED_SQUARE"}]},"aws-native:quicksight:DashboardLineChartMarkerStyleSettings":{"properties":{"markerColor":{"type":"string","description":"Color of marker in the series."},"markerShape":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartMarkerShape","description":"Shape option for markers in the series.\n\n- `CIRCLE` : Show marker as a circle.\n- `TRIANGLE` : Show marker as a triangle.\n- `SQUARE` : Show marker as a square.\n- `DIAMOND` : Show marker as a diamond.\n- `ROUNDED_SQUARE` : Show marker as a rounded square."},"markerSize":{"type":"string","description":"String based length that is composed of value and unit in px"},"markerVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Configuration option that determines whether to show the markers in the series."}},"type":"object"},"aws-native:quicksight:DashboardLineChartSeriesSettings":{"properties":{"lineStyleSettings":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartLineStyleSettings","description":"Line styles options for a line series in `LineChartVisual` ."},"markerStyleSettings":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartMarkerStyleSettings","description":"Marker styles options for a line series in `LineChartVisual` ."}},"type":"object"},"aws-native:quicksight:DashboardLineChartSortConfiguration":{"properties":{"categoryItemsLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of categories that are displayed in a line chart."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of the category fields."},"colorItemsLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of lines that are displayed in a line chart."},"smallMultiplesLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of small multiples panels that are displayed."},"smallMultiplesSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of the small multiples field."}},"type":"object"},"aws-native:quicksight:DashboardLineChartType":{"type":"string","enum":[{"name":"Line","value":"LINE"},{"name":"Area","value":"AREA"},{"name":"StackedArea","value":"STACKED_AREA"}]},"aws-native:quicksight:DashboardLineChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartConfiguration","description":"The configuration of a line chart."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardLineInterpolation":{"type":"string","enum":[{"name":"Linear","value":"LINEAR"},{"name":"Smooth","value":"SMOOTH"},{"name":"Stepped","value":"STEPPED"}]},"aws-native:quicksight:DashboardLineSeriesAxisDisplayOptions":{"properties":{"axisOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The options that determine the presentation of the line series axis."},"missingDataConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMissingDataConfiguration"},"description":"The configuration options that determine how missing data is treated during the rendering of a line chart."}},"type":"object"},"aws-native:quicksight:DashboardLinkSharingConfiguration":{"properties":{"permissions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardResourcePermission"},"description":"A structure that contains the permissions of a shareable link."}},"type":"object"},"aws-native:quicksight:DashboardListControlDisplayOptions":{"properties":{"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"searchOptions":{"$ref":"#/types/aws-native:quicksight:DashboardListControlSearchOptions","description":"The configuration of the search options in a list control."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:DashboardListControlSelectAllOptions","description":"The configuration of the `Select all` options in a list control."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:DashboardLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:DashboardListControlSearchOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility configuration of the search options in a list control."}},"type":"object"},"aws-native:quicksight:DashboardListControlSelectAllOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility configuration of the `Select all` options in a list control."}},"type":"object"},"aws-native:quicksight:DashboardLoadingAnimation":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility configuration of `LoadingAnimation` ."}},"type":"object"},"aws-native:quicksight:DashboardLocalNavigationConfiguration":{"properties":{"targetSheetId":{"type":"string","description":"The sheet that is targeted for navigation in the same analysis."}},"type":"object","required":["targetSheetId"]},"aws-native:quicksight:DashboardLongFormatText":{"properties":{"plainText":{"type":"string","description":"Plain text format."},"richText":{"type":"string","description":"Rich text. Examples of rich text include bold, underline, and italics."}},"type":"object"},"aws-native:quicksight:DashboardMapZoomMode":{"type":"string","enum":[{"name":"Auto","value":"AUTO"},{"name":"Manual","value":"MANUAL"}]},"aws-native:quicksight:DashboardMappedDataSetParameter":{"properties":{"dataSetIdentifier":{"type":"string","description":"A unique name that identifies a dataset within the analysis or dashboard."},"dataSetParameterName":{"type":"string","description":"The name of the dataset parameter."}},"type":"object","required":["dataSetIdentifier","dataSetParameterName"]},"aws-native:quicksight:DashboardMaximumLabelType":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the maximum label."}},"type":"object"},"aws-native:quicksight:DashboardMaximumMinimumComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."},"time":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField","description":"The time field that is used in a computation."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardMaximumMinimumComputationType","description":"The type of computation. Choose one of the following options:\n\n- MAXIMUM: A maximum computation.\n- MINIMUM: A minimum computation."},"value":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId","type"]},"aws-native:quicksight:DashboardMaximumMinimumComputationType":{"type":"string","enum":[{"name":"Maximum","value":"MAXIMUM"},{"name":"Minimum","value":"MINIMUM"}]},"aws-native:quicksight:DashboardMeasureField":{"properties":{"calculatedMeasureField":{"$ref":"#/types/aws-native:quicksight:DashboardCalculatedMeasureField","description":"The calculated measure field only used in pivot tables."},"categoricalMeasureField":{"$ref":"#/types/aws-native:quicksight:DashboardCategoricalMeasureField","description":"The measure type field with categorical type columns."},"dateMeasureField":{"$ref":"#/types/aws-native:quicksight:DashboardDateMeasureField","description":"The measure type field with date type columns."},"numericalMeasureField":{"$ref":"#/types/aws-native:quicksight:DashboardNumericalMeasureField","description":"The measure type field with numerical type columns."}},"type":"object"},"aws-native:quicksight:DashboardMetricComparisonComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"fromValue":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField","description":"The field that is used in a metric comparison from value setup."},"name":{"type":"string","description":"The name of a computation."},"targetValue":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField","description":"The field that is used in a metric comparison to value setup."},"time":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField","description":"The time field that is used in a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:DashboardMinimumLabelType":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the minimum label."}},"type":"object"},"aws-native:quicksight:DashboardMissingDataConfiguration":{"properties":{"treatmentOption":{"$ref":"#/types/aws-native:quicksight:DashboardMissingDataTreatmentOption","description":"The treatment option that determines how missing data should be rendered. Choose from the following options:\n\n- `INTERPOLATE` : Interpolate missing values between the prior and the next known value.\n- `SHOW_AS_ZERO` : Show missing values as the value `0` .\n- `SHOW_AS_BLANK` : Display a blank space when rendering missing data."}},"type":"object"},"aws-native:quicksight:DashboardMissingDataTreatmentOption":{"type":"string","enum":[{"name":"Interpolate","value":"INTERPOLATE"},{"name":"ShowAsZero","value":"SHOW_AS_ZERO"},{"name":"ShowAsBlank","value":"SHOW_AS_BLANK"}]},"aws-native:quicksight:DashboardNegativeValueConfiguration":{"properties":{"displayMode":{"$ref":"#/types/aws-native:quicksight:DashboardNegativeValueDisplayMode","description":"Determines the display mode of the negative value configuration."}},"type":"object","required":["displayMode"]},"aws-native:quicksight:DashboardNegativeValueDisplayMode":{"type":"string","enum":[{"name":"Positive","value":"POSITIVE"},{"name":"Negative","value":"NEGATIVE"}]},"aws-native:quicksight:DashboardNestedFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the filter is applied to."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"includeInnerSet":{"type":"boolean","description":"A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter."},"innerFilter":{"$ref":"#/types/aws-native:quicksight:DashboardInnerFilter","description":"The `InnerFilter` defines the subset of data to be used with the `NestedFilter` ."}},"type":"object","required":["column","filterId","includeInnerSet","innerFilter"]},"aws-native:quicksight:DashboardNullValueFormatConfiguration":{"properties":{"nullString":{"type":"string","description":"Determines the null string of null values."}},"type":"object","required":["nullString"]},"aws-native:quicksight:DashboardNumberDisplayFormatConfiguration":{"properties":{"decimalPlacesConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDecimalPlacesConfiguration","description":"The option that determines the decimal places configuration."},"negativeValueConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNegativeValueConfiguration","description":"The options that determine the negative value configuration."},"nullValueFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNullValueFormatConfiguration","description":"The options that determine the null value format configuration."},"numberScale":{"$ref":"#/types/aws-native:quicksight:DashboardNumberScale","description":"Determines the number scale value of the number format."},"prefix":{"type":"string","description":"Determines the prefix value of the number format."},"separatorConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNumericSeparatorConfiguration","description":"The options that determine the numeric separator configuration."},"suffix":{"type":"string","description":"Determines the suffix value of the number format."}},"type":"object"},"aws-native:quicksight:DashboardNumberFormatConfiguration":{"properties":{"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNumericFormatConfiguration","description":"The options that determine the numeric format configuration."}},"type":"object"},"aws-native:quicksight:DashboardNumberScale":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Auto","value":"AUTO"},{"name":"Thousands","value":"THOUSANDS"},{"name":"Millions","value":"MILLIONS"},{"name":"Billions","value":"BILLIONS"},{"name":"Trillions","value":"TRILLIONS"},{"name":"Lakhs","value":"LAKHS"},{"name":"Crores","value":"CRORES"}]},"aws-native:quicksight:DashboardNumericAxisOptions":{"properties":{"range":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayRange","description":"The range setup of a numeric axis."},"scale":{"$ref":"#/types/aws-native:quicksight:DashboardAxisScale","description":"The scale setup of a numeric axis."}},"type":"object"},"aws-native:quicksight:DashboardNumericEqualityDrillDownFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the filter is applied to."},"value":{"type":"number","description":"The value of the double input numeric drill down filter."}},"type":"object","required":["column","value"]},"aws-native:quicksight:DashboardNumericEqualityFilter":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardAggregationFunction","description":"The aggregation function of the filter."},"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the filter is applied to."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"matchOperator":{"$ref":"#/types/aws-native:quicksight:DashboardNumericEqualityMatchOperator","description":"The match operator that is used to determine if a filter should be applied."},"nullOption":{"$ref":"#/types/aws-native:quicksight:DashboardFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"parameterName":{"type":"string","description":"The parameter whose value should be used for the filter value."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:DashboardNumericFilterSelectAllOptions","description":"Select all of the values. Null is not the assigned value of select all.\n\n- `FILTER_ALL_VALUES`"},"value":{"type":"number","description":"The input value."}},"type":"object","required":["column","filterId","matchOperator","nullOption"]},"aws-native:quicksight:DashboardNumericEqualityMatchOperator":{"type":"string","enum":[{"name":"Equals","value":"EQUALS"},{"name":"DoesNotEqual","value":"DOES_NOT_EQUAL"}]},"aws-native:quicksight:DashboardNumericFilterSelectAllOptions":{"type":"string","enum":[{"name":"FilterAllValues","value":"FILTER_ALL_VALUES"}]},"aws-native:quicksight:DashboardNumericFormatConfiguration":{"properties":{"currencyDisplayFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardCurrencyDisplayFormatConfiguration","description":"The options that determine the currency display format configuration."},"numberDisplayFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNumberDisplayFormatConfiguration","description":"The options that determine the number display format configuration."},"percentageDisplayFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardPercentageDisplayFormatConfiguration","description":"The options that determine the percentage display format configuration."}},"type":"object"},"aws-native:quicksight:DashboardNumericRangeFilter":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardAggregationFunction","description":"The aggregation function of the filter."},"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the filter is applied to."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"includeMaximum":{"type":"boolean","description":"Determines whether the maximum value in the filter value range should be included in the filtered results."},"includeMinimum":{"type":"boolean","description":"Determines whether the minimum value in the filter value range should be included in the filtered results."},"nullOption":{"$ref":"#/types/aws-native:quicksight:DashboardFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"rangeMaximum":{"$ref":"#/types/aws-native:quicksight:DashboardNumericRangeFilterValue","description":"The maximum value for the filter value range."},"rangeMinimum":{"$ref":"#/types/aws-native:quicksight:DashboardNumericRangeFilterValue","description":"The minimum value for the filter value range."},"selectAllOptions":{"$ref":"#/types/aws-native:quicksight:DashboardNumericFilterSelectAllOptions","description":"Select all of the values. Null is not the assigned value of select all.\n\n- `FILTER_ALL_VALUES`"}},"type":"object","required":["column","filterId","nullOption"]},"aws-native:quicksight:DashboardNumericRangeFilterValue":{"properties":{"parameter":{"type":"string","description":"The parameter that is used in the numeric range."},"staticValue":{"type":"number","description":"The static value of the numeric range filter."}},"type":"object"},"aws-native:quicksight:DashboardNumericSeparatorConfiguration":{"properties":{"decimalSeparator":{"$ref":"#/types/aws-native:quicksight:DashboardNumericSeparatorSymbol","description":"Determines the decimal separator."},"thousandsSeparator":{"$ref":"#/types/aws-native:quicksight:DashboardThousandSeparatorOptions","description":"The options that determine the thousands separator configuration."}},"type":"object"},"aws-native:quicksight:DashboardNumericSeparatorSymbol":{"type":"string","enum":[{"name":"Comma","value":"COMMA"},{"name":"Dot","value":"DOT"},{"name":"Space","value":"SPACE"}]},"aws-native:quicksight:DashboardNumericalAggregationFunction":{"properties":{"percentileAggregation":{"$ref":"#/types/aws-native:quicksight:DashboardPercentileAggregation","description":"An aggregation based on the percentile of values in a dimension or measure."},"simpleNumericalAggregation":{"$ref":"#/types/aws-native:quicksight:DashboardSimpleNumericalAggregationFunction","description":"Built-in aggregation functions for numerical values.\n\n- `SUM` : The sum of a dimension or measure.\n- `AVERAGE` : The average of a dimension or measure.\n- `MIN` : The minimum value of a dimension or measure.\n- `MAX` : The maximum value of a dimension or measure.\n- `COUNT` : The count of a dimension or measure.\n- `DISTINCT_COUNT` : The count of distinct values in a dimension or measure.\n- `VAR` : The variance of a dimension or measure.\n- `VARP` : The partitioned variance of a dimension or measure.\n- `STDEV` : The standard deviation of a dimension or measure.\n- `STDEVP` : The partitioned standard deviation of a dimension or measure.\n- `MEDIAN` : The median value of a dimension or measure."}},"type":"object"},"aws-native:quicksight:DashboardNumericalDimensionField":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that is used in the `NumericalDimensionField` ."},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNumberFormatConfiguration","description":"The format configuration of the field."},"hierarchyId":{"type":"string","description":"The custom hierarchy ID."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:DashboardNumericalMeasureField":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardNumericalAggregationFunction","description":"The aggregation function of the measure field."},"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that is used in the `NumericalMeasureField` ."},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNumberFormatConfiguration","description":"The format configuration of the field."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:DashboardOtherCategories":{"type":"string","enum":[{"name":"Include","value":"INCLUDE"},{"name":"Exclude","value":"EXCLUDE"}]},"aws-native:quicksight:DashboardPaginationConfiguration":{"properties":{"pageNumber":{"type":"number","description":"Indicates the page number."},"pageSize":{"type":"number","description":"Indicates how many items render in one page."}},"type":"object","required":["pageNumber","pageSize"]},"aws-native:quicksight:DashboardPanelBorderStyle":{"type":"string","enum":[{"name":"Solid","value":"SOLID"},{"name":"Dashed","value":"DASHED"},{"name":"Dotted","value":"DOTTED"}]},"aws-native:quicksight:DashboardPanelConfiguration":{"properties":{"backgroundColor":{"type":"string","description":"Sets the background color for each panel."},"backgroundVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines whether or not a background for each small multiples panel is rendered."},"borderColor":{"type":"string","description":"Sets the line color of panel borders."},"borderStyle":{"$ref":"#/types/aws-native:quicksight:DashboardPanelBorderStyle","description":"Sets the line style of panel borders."},"borderThickness":{"type":"string","description":"String based length that is composed of value and unit in px"},"borderVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines whether or not each panel displays a border."},"gutterSpacing":{"type":"string","description":"String based length that is composed of value and unit in px"},"gutterVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines whether or not negative space between sibling panels is rendered."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardPanelTitleOptions","description":"Configures the title display within each small multiples panel."}},"type":"object"},"aws-native:quicksight:DashboardPanelTitleOptions":{"properties":{"fontConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFontConfiguration"},"horizontalTextAlignment":{"$ref":"#/types/aws-native:quicksight:DashboardHorizontalTextAlignment","description":"Sets the horizontal text alignment of the title within each panel."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines whether or not panel titles are displayed."}},"type":"object"},"aws-native:quicksight:DashboardPaperOrientation":{"type":"string","enum":[{"name":"Portrait","value":"PORTRAIT"},{"name":"Landscape","value":"LANDSCAPE"}]},"aws-native:quicksight:DashboardPaperSize":{"type":"string","enum":[{"name":"UsLetter","value":"US_LETTER"},{"name":"UsLegal","value":"US_LEGAL"},{"name":"UsTabloidLedger","value":"US_TABLOID_LEDGER"},{"name":"A0","value":"A0"},{"name":"A1","value":"A1"},{"name":"A2","value":"A2"},{"name":"A3","value":"A3"},{"name":"A4","value":"A4"},{"name":"A5","value":"A5"},{"name":"JisB4","value":"JIS_B4"},{"name":"JisB5","value":"JIS_B5"}]},"aws-native:quicksight:DashboardParameterControl":{"properties":{"dateTimePicker":{"$ref":"#/types/aws-native:quicksight:DashboardParameterDateTimePickerControl","description":"A control from a date parameter that specifies date and time."},"dropdown":{"$ref":"#/types/aws-native:quicksight:DashboardParameterDropDownControl","description":"A control to display a dropdown list with buttons that are used to select a single value."},"list":{"$ref":"#/types/aws-native:quicksight:DashboardParameterListControl","description":"A control to display a list with buttons or boxes that are used to select either a single value or multiple values."},"slider":{"$ref":"#/types/aws-native:quicksight:DashboardParameterSliderControl","description":"A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle."},"textArea":{"$ref":"#/types/aws-native:quicksight:DashboardParameterTextAreaControl","description":"A control to display a text box that is used to enter multiple entries."},"textField":{"$ref":"#/types/aws-native:quicksight:DashboardParameterTextFieldControl","description":"A control to display a text box that is used to enter a single entry."}},"type":"object"},"aws-native:quicksight:DashboardParameterDateTimePickerControl":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDateTimePickerControlDisplayOptions","description":"The display options of a control."},"parameterControlId":{"type":"string","description":"The ID of the `ParameterDateTimePickerControl` ."},"sourceParameterName":{"type":"string","description":"The name of the `ParameterDateTimePickerControl` ."},"title":{"type":"string","description":"The title of the `ParameterDateTimePickerControl` ."}},"type":"object","required":["parameterControlId","sourceParameterName","title"]},"aws-native:quicksight:DashboardParameterDeclaration":{"properties":{"dateTimeParameterDeclaration":{"$ref":"#/types/aws-native:quicksight:DashboardDateTimeParameterDeclaration","description":"A parameter declaration for the `DateTime` data type."},"decimalParameterDeclaration":{"$ref":"#/types/aws-native:quicksight:DashboardDecimalParameterDeclaration","description":"A parameter declaration for the `Decimal` data type."},"integerParameterDeclaration":{"$ref":"#/types/aws-native:quicksight:DashboardIntegerParameterDeclaration","description":"A parameter declaration for the `Integer` data type."},"stringParameterDeclaration":{"$ref":"#/types/aws-native:quicksight:DashboardStringParameterDeclaration","description":"A parameter declaration for the `String` data type."}},"type":"object"},"aws-native:quicksight:DashboardParameterDropDownControl":{"properties":{"cascadingControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardCascadingControlConfiguration","description":"The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls."},"commitMode":{"$ref":"#/types/aws-native:quicksight:DashboardCommitMode","description":"The visibility configuration of the Apply button on a `ParameterDropDownControl` ."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDropDownControlDisplayOptions","description":"The display options of a control."},"parameterControlId":{"type":"string","description":"The ID of the `ParameterDropDownControl` ."},"selectableValues":{"$ref":"#/types/aws-native:quicksight:DashboardParameterSelectableValues","description":"A list of selectable values that are used in a control."},"sourceParameterName":{"type":"string","description":"The source parameter name of the `ParameterDropDownControl` ."},"title":{"type":"string","description":"The title of the `ParameterDropDownControl` ."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlListType","description":"The type parameter name of the `ParameterDropDownControl` ."}},"type":"object","required":["parameterControlId","sourceParameterName","title"]},"aws-native:quicksight:DashboardParameterListControl":{"properties":{"cascadingControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardCascadingControlConfiguration","description":"The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardListControlDisplayOptions","description":"The display options of a control."},"parameterControlId":{"type":"string","description":"The ID of the `ParameterListControl` ."},"selectableValues":{"$ref":"#/types/aws-native:quicksight:DashboardParameterSelectableValues","description":"A list of selectable values that are used in a control."},"sourceParameterName":{"type":"string","description":"The source parameter name of the `ParameterListControl` ."},"title":{"type":"string","description":"The title of the `ParameterListControl` ."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlListType","description":"The type of `ParameterListControl` ."}},"type":"object","required":["parameterControlId","sourceParameterName","title"]},"aws-native:quicksight:DashboardParameterSelectableValues":{"properties":{"linkToDataSetColumn":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column identifier that fetches values from the data set."},"values":{"type":"array","items":{"type":"string"},"description":"The values that are used in `ParameterSelectableValues` ."}},"type":"object"},"aws-native:quicksight:DashboardParameterSliderControl":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSliderControlDisplayOptions","description":"The display options of a control."},"maximumValue":{"type":"number","description":"The larger value that is displayed at the right of the slider."},"minimumValue":{"type":"number","description":"The smaller value that is displayed at the left of the slider."},"parameterControlId":{"type":"string","description":"The ID of the `ParameterSliderControl` ."},"sourceParameterName":{"type":"string","description":"The source parameter name of the `ParameterSliderControl` ."},"stepSize":{"type":"number","description":"The number of increments that the slider bar is divided into."},"title":{"type":"string","description":"The title of the `ParameterSliderControl` ."}},"type":"object","required":["maximumValue","minimumValue","parameterControlId","sourceParameterName","stepSize","title"]},"aws-native:quicksight:DashboardParameterTextAreaControl":{"properties":{"delimiter":{"type":"string","description":"The delimiter that is used to separate the lines in text."},"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTextAreaControlDisplayOptions","description":"The display options of a control."},"parameterControlId":{"type":"string","description":"The ID of the `ParameterTextAreaControl` ."},"sourceParameterName":{"type":"string","description":"The source parameter name of the `ParameterTextAreaControl` ."},"title":{"type":"string","description":"The title of the `ParameterTextAreaControl` ."}},"type":"object","required":["parameterControlId","sourceParameterName","title"]},"aws-native:quicksight:DashboardParameterTextFieldControl":{"properties":{"displayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTextFieldControlDisplayOptions","description":"The display options of a control."},"parameterControlId":{"type":"string","description":"The ID of the `ParameterTextFieldControl` ."},"sourceParameterName":{"type":"string","description":"The source parameter name of the `ParameterTextFieldControl` ."},"title":{"type":"string","description":"The title of the `ParameterTextFieldControl` ."}},"type":"object","required":["parameterControlId","sourceParameterName","title"]},"aws-native:quicksight:DashboardParameterValueType":{"type":"string","enum":[{"name":"MultiValued","value":"MULTI_VALUED"},{"name":"SingleValued","value":"SINGLE_VALUED"}]},"aws-native:quicksight:DashboardParameters":{"description":"\u003cp\u003eA list of Amazon QuickSight parameters and the list's override values.\u003c/p\u003e","properties":{"dateTimeParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDateTimeParameter"},"description":"\u003cp\u003eThe parameters that have a data type of date-time.\u003c/p\u003e"},"decimalParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDecimalParameter"},"description":"\u003cp\u003eThe parameters that have a data type of decimal.\u003c/p\u003e"},"integerParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardIntegerParameter"},"description":"\u003cp\u003eThe parameters that have a data type of integer.\u003c/p\u003e"},"stringParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardStringParameter"},"description":"\u003cp\u003eThe parameters that have a data type of string.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DashboardPercentVisibleRange":{"properties":{"from":{"type":"number","description":"The lower bound of the range."},"to":{"type":"number","description":"The top bound of the range."}},"type":"object"},"aws-native:quicksight:DashboardPercentageDisplayFormatConfiguration":{"properties":{"decimalPlacesConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDecimalPlacesConfiguration","description":"The option that determines the decimal places configuration."},"negativeValueConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNegativeValueConfiguration","description":"The options that determine the negative value configuration."},"nullValueFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNullValueFormatConfiguration","description":"The options that determine the null value format configuration."},"prefix":{"type":"string","description":"Determines the prefix value of the percentage format."},"separatorConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNumericSeparatorConfiguration","description":"The options that determine the numeric separator configuration."},"suffix":{"type":"string","description":"Determines the suffix value of the percentage format."}},"type":"object"},"aws-native:quicksight:DashboardPercentileAggregation":{"properties":{"percentileValue":{"type":"number","description":"The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure."}},"type":"object"},"aws-native:quicksight:DashboardPeriodOverPeriodComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."},"time":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField","description":"The time field that is used in a computation."},"value":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:DashboardPeriodToDateComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."},"periodTimeGranularity":{"$ref":"#/types/aws-native:quicksight:DashboardTimeGranularity","description":"The time granularity setup of period to date computation. Choose from the following options:\n\n- YEAR: Year to date.\n- MONTH: Month to date."},"time":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField","description":"The time field that is used in a computation."},"value":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:DashboardPieChartAggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The category (group/color) field wells of a pie chart."},"smallMultiples":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The small multiples field well of a pie chart."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The value field wells of a pie chart. Values are aggregated based on categories."}},"type":"object"},"aws-native:quicksight:DashboardPieChartConfiguration":{"properties":{"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options of the group/color that is displayed in a pie chart."},"contributionAnalysisDefaults":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardContributionAnalysisDefault"},"description":"The contribution analysis (anomaly configuration) setup of the visual."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOptions","description":"The options that determine if visual data labels are displayed."},"donutOptions":{"$ref":"#/types/aws-native:quicksight:DashboardDonutOptions","description":"The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardPieChartFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions","description":"The legend display setup of the visual."},"smallMultiplesOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSmallMultiplesOptions","description":"The small multiples setup for the visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardPieChartSortConfiguration","description":"The sort configuration of a pie chart."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The tooltip display setup of the visual."},"valueLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options for the value that is displayed in a pie chart."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPalette","description":"The palette (chart color) display setup of the visual."}},"type":"object"},"aws-native:quicksight:DashboardPieChartFieldWells":{"properties":{"pieChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardPieChartAggregatedFieldWells","description":"The field well configuration of a pie chart."}},"type":"object"},"aws-native:quicksight:DashboardPieChartSortConfiguration":{"properties":{"categoryItemsLimit":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of categories that are displayed in a pie chart."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of the category fields."},"smallMultiplesLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of small multiples panels that are displayed."},"smallMultiplesSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of the small multiples field."}},"type":"object"},"aws-native:quicksight:DashboardPieChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardPieChartConfiguration","description":"The configuration of a pie chart."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardPivotFieldSortOptions":{"properties":{"fieldId":{"type":"string","description":"The field ID for the field sort options."},"sortBy":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableSortBy","description":"The sort by field for the field sort options."}},"type":"object","required":["fieldId","sortBy"]},"aws-native:quicksight:DashboardPivotTableAggregatedFieldWells":{"properties":{"columns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The columns field well for a pivot table. Values are grouped by columns fields."},"rows":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The rows field well for a pivot table. Values are grouped by rows fields."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The values field well for a pivot table. Values are aggregated based on rows and columns fields."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableCellConditionalFormatting":{"properties":{"fieldId":{"type":"string","description":"The field ID of the cell for conditional formatting."},"scope":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableConditionalFormattingScope","description":"The scope of the cell for conditional formatting."},"scopes":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableConditionalFormattingScope"},"description":"A list of cell scopes for conditional formatting."},"textFormat":{"$ref":"#/types/aws-native:quicksight:DashboardTextConditionalFormat","description":"The text format of the cell for conditional formatting."}},"type":"object","required":["fieldId"]},"aws-native:quicksight:DashboardPivotTableConditionalFormatting":{"properties":{"conditionalFormattingOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableConditionalFormattingOption"},"description":"Conditional formatting options for a `PivotTableVisual` ."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableConditionalFormattingOption":{"properties":{"cell":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableCellConditionalFormatting","description":"The cell conditional formatting option for a pivot table."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableConditionalFormattingScope":{"properties":{"role":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableConditionalFormattingScopeRole","description":"The role (field, field total, grand total) of the cell for conditional formatting."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableConditionalFormattingScopeRole":{"type":"string","enum":[{"name":"Field","value":"FIELD"},{"name":"FieldTotal","value":"FIELD_TOTAL"},{"name":"GrandTotal","value":"GRAND_TOTAL"}]},"aws-native:quicksight:DashboardPivotTableConfiguration":{"properties":{"fieldOptions":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableFieldOptions","description":"The field options for a pivot table visual."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"paginatedReportOptions":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTablePaginatedReportOptions","description":"The paginated report options for a pivot table visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableSortConfiguration","description":"The sort configuration for a `PivotTableVisual` ."},"tableOptions":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableOptions","description":"The table options for a pivot table visual."},"totalOptions":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableTotalOptions","description":"The total options for a pivot table visual."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableDataPathOption":{"properties":{"dataPathList":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDataPathValue"},"description":"The list of data path values for the data path options."},"width":{"type":"string","description":"String based length that is composed of value and unit in px"}},"type":"object","required":["dataPathList"]},"aws-native:quicksight:DashboardPivotTableDataPathType":{"type":"string","enum":[{"name":"HierarchyRowsLayoutColumn","value":"HIERARCHY_ROWS_LAYOUT_COLUMN"},{"name":"MultipleRowMetricsColumn","value":"MULTIPLE_ROW_METRICS_COLUMN"},{"name":"EmptyColumnHeader","value":"EMPTY_COLUMN_HEADER"},{"name":"CountMetricColumn","value":"COUNT_METRIC_COLUMN"}]},"aws-native:quicksight:DashboardPivotTableFieldCollapseState":{"type":"string","enum":[{"name":"Collapsed","value":"COLLAPSED"},{"name":"Expanded","value":"EXPANDED"}]},"aws-native:quicksight:DashboardPivotTableFieldCollapseStateOption":{"properties":{"state":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableFieldCollapseState","description":"The state of the field target of a pivot table. Choose one of the following options:\n\n- `COLLAPSED`\n- `EXPANDED`"},"target":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableFieldCollapseStateTarget","description":"A tagged-union object that sets the collapse state."}},"type":"object","required":["target"]},"aws-native:quicksight:DashboardPivotTableFieldCollapseStateTarget":{"properties":{"fieldDataPathValues":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDataPathValue"},"description":"The data path of the pivot table's header. Used to set the collapse state."},"fieldId":{"type":"string","description":"The field ID of the pivot table that the collapse state needs to be set to."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableFieldOption":{"properties":{"customLabel":{"type":"string","description":"The custom label of the pivot table field."},"fieldId":{"type":"string","description":"The field ID of the pivot table field."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the pivot table field."}},"type":"object","required":["fieldId"]},"aws-native:quicksight:DashboardPivotTableFieldOptions":{"properties":{"collapseStateOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableFieldCollapseStateOption"},"description":"The collapse state options for the pivot table field options."},"dataPathOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableDataPathOption"},"description":"The data path options for the pivot table field options."},"selectedFieldOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableFieldOption"},"description":"The selected field options for the pivot table field options."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableFieldSubtotalOptions":{"properties":{"fieldId":{"type":"string","description":"The field ID of the subtotal options."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableFieldWells":{"properties":{"pivotTableAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableAggregatedFieldWells","description":"The aggregated field well for the pivot table."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableMetricPlacement":{"type":"string","enum":[{"name":"Row","value":"ROW"},{"name":"Column","value":"COLUMN"}]},"aws-native:quicksight:DashboardPivotTableOptions":{"properties":{"cellStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"The table cell style of cells."},"collapsedRowDimensionsVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is `HIDDEN` , all collapsed columns in a pivot table are automatically hidden. The default value is `VISIBLE` ."},"columnHeaderStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"The table cell style of the column header."},"columnNamesVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the column names."},"defaultCellWidth":{"type":"string","description":"String based length that is composed of value and unit in px"},"metricPlacement":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableMetricPlacement","description":"The metric placement (row, column) options."},"rowAlternateColorOptions":{"$ref":"#/types/aws-native:quicksight:DashboardRowAlternateColorOptions","description":"The row alternate color options (widget status, row alternate colors)."},"rowFieldNamesStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"The table cell style of row field names."},"rowHeaderStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"The table cell style of the row headers."},"rowsLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableRowsLabelOptions","description":"The options for the label that is located above the row headers. This option is only applicable when `RowsLayout` is set to `HIERARCHY` ."},"rowsLayout":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableRowsLayout","description":"The layout for the row dimension headers of a pivot table. Choose one of the following options.\n\n- `TABULAR` : (Default) Each row field is displayed in a separate column.\n- `HIERARCHY` : All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields."},"singleMetricVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the single metric options."},"toggleButtonsVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines the visibility of the pivot table."}},"type":"object"},"aws-native:quicksight:DashboardPivotTablePaginatedReportOptions":{"properties":{"overflowColumnHeaderVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the repeating header rows on each page."},"verticalOverflowVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the printing table overflow across pages."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableRowsLabelOptions":{"properties":{"customLabel":{"type":"string","description":"The custom label string for the rows label."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the rows label."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableRowsLayout":{"type":"string","enum":[{"name":"Tabular","value":"TABULAR"},{"name":"Hierarchy","value":"HIERARCHY"}]},"aws-native:quicksight:DashboardPivotTableSortBy":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnSort","description":"The column sort (field id, direction) for the pivot table sort by options."},"dataPath":{"$ref":"#/types/aws-native:quicksight:DashboardDataPathSort","description":"The data path sort (data path value, direction) for the pivot table sort by options."},"field":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSort","description":"The field sort (field id, direction) for the pivot table sort by options."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableSortConfiguration":{"properties":{"fieldSortOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardPivotFieldSortOptions"},"description":"The field sort options for a pivot table sort configuration."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableSubtotalLevel":{"type":"string","enum":[{"name":"All","value":"ALL"},{"name":"Custom","value":"CUSTOM"},{"name":"Last","value":"LAST"}]},"aws-native:quicksight:DashboardPivotTableTotalOptions":{"properties":{"columnSubtotalOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSubtotalOptions","description":"The column subtotal options."},"columnTotalOptions":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTotalOptions","description":"The column total options."},"rowSubtotalOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSubtotalOptions","description":"The row subtotal options."},"rowTotalOptions":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTotalOptions","description":"The row total options."}},"type":"object"},"aws-native:quicksight:DashboardPivotTableVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableConfiguration","description":"The configuration settings of the visual."},"conditionalFormatting":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableConditionalFormatting","description":"The conditional formatting for a `PivotTableVisual` ."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardPivotTotalOptions":{"properties":{"customLabel":{"type":"string","description":"The custom label string for the total cells."},"metricHeaderCellStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"The cell styling options for the total of header cells."},"placement":{"$ref":"#/types/aws-native:quicksight:DashboardTableTotalsPlacement","description":"The placement (start, end) for the total cells."},"scrollStatus":{"$ref":"#/types/aws-native:quicksight:DashboardTableTotalsScrollStatus","description":"The scroll status (pinned, scrolled) for the total cells."},"totalAggregationOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardTotalAggregationOption"},"description":"The total aggregation options for each value field."},"totalCellStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"The cell styling options for the total cells."},"totalsVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility configuration for the total cells."},"valueCellStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"The cell styling options for the totals of value cells."}},"type":"object"},"aws-native:quicksight:DashboardPluginVisual":{"properties":{"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardPluginVisualConfiguration","description":"A description of the plugin field wells and their persisted properties."},"pluginArn":{"type":"string","description":"The Amazon Resource Name (ARN) that reflects the plugin and version."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions"},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions"},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The ID of the visual that you want to use."}},"type":"object","required":["pluginArn","visualId"]},"aws-native:quicksight:DashboardPluginVisualAxisName":{"type":"string","enum":[{"name":"GroupBy","value":"GROUP_BY"},{"name":"Value","value":"VALUE"}]},"aws-native:quicksight:DashboardPluginVisualConfiguration":{"properties":{"fieldWells":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardPluginVisualFieldWell"},"description":"The field wells configuration of the plugin visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardPluginVisualSortConfiguration","description":"The sort configuration of the plugin visual."},"visualOptions":{"$ref":"#/types/aws-native:quicksight:DashboardPluginVisualOptions","description":"The persisted properties of the plugin visual."}},"type":"object"},"aws-native:quicksight:DashboardPluginVisualFieldWell":{"properties":{"axisName":{"$ref":"#/types/aws-native:quicksight:DashboardPluginVisualAxisName","description":"The semantic axis name for the field well."},"dimensions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"A list of dimensions for the field well."},"measures":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"A list of measures that exist in the field well."},"unaggregated":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardUnaggregatedField"},"description":"A list of unaggregated fields that exist in the field well."}},"type":"object"},"aws-native:quicksight:DashboardPluginVisualItemsLimitConfiguration":{"properties":{"itemsLimit":{"type":"number","description":"Determines how many values are be fetched at once."}},"type":"object"},"aws-native:quicksight:DashboardPluginVisualOptions":{"properties":{"visualProperties":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardPluginVisualProperty"},"description":"The persisted properties and their values."}},"type":"object"},"aws-native:quicksight:DashboardPluginVisualProperty":{"properties":{"name":{"type":"string","description":"The name of the plugin visual property."},"value":{"type":"string","description":"The value of the plugin visual property."}},"type":"object"},"aws-native:quicksight:DashboardPluginVisualSortConfiguration":{"properties":{"pluginVisualTableQuerySort":{"$ref":"#/types/aws-native:quicksight:DashboardPluginVisualTableQuerySort","description":"The table query sorting options for the plugin visual."}},"type":"object"},"aws-native:quicksight:DashboardPluginVisualTableQuerySort":{"properties":{"itemsLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardPluginVisualItemsLimitConfiguration","description":"The maximum amount of data to be returned by a query."},"rowSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"Determines how data is sorted in the response."}},"type":"object"},"aws-native:quicksight:DashboardPredefinedHierarchy":{"properties":{"columns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier"},"description":"The list of columns that define the predefined hierarchy."},"drillDownFilters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDrillDownFilter"},"description":"The option that determines the drill down filters for the predefined hierarchy."},"hierarchyId":{"type":"string","description":"The hierarchy ID of the predefined hierarchy."}},"type":"object","required":["columns","hierarchyId"]},"aws-native:quicksight:DashboardPrimaryValueDisplayType":{"type":"string","enum":[{"name":"Hidden","value":"HIDDEN"},{"name":"Comparison","value":"COMPARISON"},{"name":"Actual","value":"ACTUAL"}]},"aws-native:quicksight:DashboardProgressBarOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the progress bar."}},"type":"object"},"aws-native:quicksight:DashboardPublishOptions":{"description":"\u003cp\u003eDashboard publish options.\u003c/p\u003e","properties":{"adHocFilteringOption":{"$ref":"#/types/aws-native:quicksight:DashboardAdHocFilteringOption","description":"Ad hoc (one-time) filtering option."},"dataPointDrillUpDownOption":{"$ref":"#/types/aws-native:quicksight:DashboardDataPointDrillUpDownOption","description":"The drill-down options of data points in a dashboard."},"dataPointMenuLabelOption":{"$ref":"#/types/aws-native:quicksight:DashboardDataPointMenuLabelOption","description":"The data point menu label options of a dashboard."},"dataPointTooltipOption":{"$ref":"#/types/aws-native:quicksight:DashboardDataPointTooltipOption","description":"The data point tool tip options of a dashboard."},"dataQaEnabledOption":{"$ref":"#/types/aws-native:quicksight:DashboardDataQaEnabledOption","description":"Adds Q\u0026A capabilities to an Quick Sight dashboard. If no topic is linked, Dashboard Q\u0026A uses the data values that are rendered on the dashboard. End users can use Dashboard Q\u0026A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q\u0026A is used."},"dataStoriesSharingOption":{"$ref":"#/types/aws-native:quicksight:DashboardDataStoriesSharingOption","description":"Data stories sharing option."},"executiveSummaryOption":{"$ref":"#/types/aws-native:quicksight:DashboardExecutiveSummaryOption","description":"Executive summary option."},"exportToCsvOption":{"$ref":"#/types/aws-native:quicksight:DashboardExportToCsvOption","description":"Export to .csv option."},"exportWithHiddenFieldsOption":{"$ref":"#/types/aws-native:quicksight:DashboardExportWithHiddenFieldsOption","description":"Determines if hidden fields are exported with a dashboard."},"quickSuiteActionsOption":{"$ref":"#/types/aws-native:quicksight:DashboardQuickSuiteActionsOption","description":"Determines if Actions in Amazon Quick Suite are enabled in a dashboard."},"sheetControlsOption":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlsOption","description":"Sheet controls option."},"sheetLayoutElementMaximizationOption":{"$ref":"#/types/aws-native:quicksight:DashboardSheetLayoutElementMaximizationOption","description":"The sheet layout maximization options of a dashbaord."},"visualAxisSortOption":{"$ref":"#/types/aws-native:quicksight:DashboardVisualAxisSortOption","description":"The axis sort options of a dashboard."},"visualMenuOption":{"$ref":"#/types/aws-native:quicksight:DashboardVisualMenuOption","description":"The menu options of a visual in a dashboard."},"visualPublishOptions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPublishOptions","description":"The visual publish options of a visual in a dashboard."}},"type":"object"},"aws-native:quicksight:DashboardQBusinessInsightsStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:DashboardQuickSuiteActionsOption":{"properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"Availability status."}},"type":"object"},"aws-native:quicksight:DashboardRadarChartAggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The aggregated field well categories of a radar chart."},"color":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The color that are assigned to the aggregated field wells of a radar chart."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The values that are assigned to the aggregated field wells of a radar chart."}},"type":"object"},"aws-native:quicksight:DashboardRadarChartAreaStyleSettings":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility settings of a radar chart."}},"type":"object"},"aws-native:quicksight:DashboardRadarChartAxesRangeScale":{"type":"string","enum":[{"name":"Auto","value":"AUTO"},{"name":"Independent","value":"INDEPENDENT"},{"name":"Shared","value":"SHARED"}]},"aws-native:quicksight:DashboardRadarChartConfiguration":{"properties":{"alternateBandColorsVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines the visibility of the colors of alternatign bands in a radar chart."},"alternateBandEvenColor":{"type":"string","description":"The color of the even-numbered alternate bands of a radar chart."},"alternateBandOddColor":{"type":"string","description":"The color of the odd-numbered alternate bands of a radar chart."},"axesRangeScale":{"$ref":"#/types/aws-native:quicksight:DashboardRadarChartAxesRangeScale","description":"The axis behavior options of a radar chart."},"baseSeriesSettings":{"$ref":"#/types/aws-native:quicksight:DashboardRadarChartSeriesSettings","description":"The base sreies settings of a radar chart."},"categoryAxis":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The category axis of a radar chart."},"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The category label options of a radar chart."},"colorAxis":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The color axis of a radar chart."},"colorLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The color label options of a radar chart."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardRadarChartFieldWells","description":"The field well configuration of a `RadarChartVisual` ."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions","description":"The legend display setup of the visual."},"shape":{"$ref":"#/types/aws-native:quicksight:DashboardRadarChartShape","description":"The shape of the radar chart."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardRadarChartSortConfiguration","description":"The sort configuration of a `RadarChartVisual` ."},"startAngle":{"type":"number","description":"The start angle of a radar chart's axis."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPalette","description":"The palette (chart color) display setup of the visual."}},"type":"object"},"aws-native:quicksight:DashboardRadarChartFieldWells":{"properties":{"radarChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardRadarChartAggregatedFieldWells","description":"The aggregated field wells of a radar chart visual."}},"type":"object"},"aws-native:quicksight:DashboardRadarChartSeriesSettings":{"properties":{"areaStyleSettings":{"$ref":"#/types/aws-native:quicksight:DashboardRadarChartAreaStyleSettings","description":"The area style settings of a radar chart."}},"type":"object"},"aws-native:quicksight:DashboardRadarChartShape":{"type":"string","enum":[{"name":"Circle","value":"CIRCLE"},{"name":"Polygon","value":"POLYGON"}]},"aws-native:quicksight:DashboardRadarChartSortConfiguration":{"properties":{"categoryItemsLimit":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The category items limit for a radar chart."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The category sort options of a radar chart."},"colorItemsLimit":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The color items limit of a radar chart."},"colorSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The color sort configuration of a radar chart."}},"type":"object"},"aws-native:quicksight:DashboardRadarChartVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardRadarChartConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardRangeEndsLabelType":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the range ends label."}},"type":"object"},"aws-native:quicksight:DashboardReferenceLine":{"properties":{"dataConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLineDataConfiguration","description":"The data configuration of the reference line."},"labelConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLineLabelConfiguration","description":"The label configuration of the reference line."},"status":{"$ref":"#/types/aws-native:quicksight:DashboardWidgetStatus","description":"The status of the reference line. Choose one of the following options:\n\n- `ENABLE`\n- `DISABLE`"},"styleConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLineStyleConfiguration","description":"The style configuration of the reference line."}},"type":"object","required":["dataConfiguration"]},"aws-native:quicksight:DashboardReferenceLineCustomLabelConfiguration":{"properties":{"customLabel":{"type":"string","description":"The string text of the custom label."}},"type":"object","required":["customLabel"]},"aws-native:quicksight:DashboardReferenceLineDataConfiguration":{"properties":{"axisBinding":{"$ref":"#/types/aws-native:quicksight:DashboardAxisBinding","description":"The axis binding type of the reference line. Choose one of the following options:\n\n- `PrimaryY`\n- `SecondaryY`"},"dynamicConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLineDynamicDataConfiguration","description":"The dynamic configuration of the reference line data configuration."},"seriesType":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLineSeriesType","description":"The series type of the reference line data configuration. Choose one of the following options:\n\n- `BAR`\n- `LINE`"},"staticConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLineStaticDataConfiguration","description":"The static data configuration of the reference line data configuration."}},"type":"object"},"aws-native:quicksight:DashboardReferenceLineDynamicDataConfiguration":{"properties":{"calculation":{"$ref":"#/types/aws-native:quicksight:DashboardNumericalAggregationFunction","description":"The calculation that is used in the dynamic data."},"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the dynamic data targets."},"measureAggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardAggregationFunction","description":"The aggregation function that is used in the dynamic data."}},"type":"object","required":["calculation","column"]},"aws-native:quicksight:DashboardReferenceLineLabelConfiguration":{"properties":{"customLabelConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLineCustomLabelConfiguration","description":"The custom label configuration of the label in a reference line."},"fontColor":{"type":"string","description":"The font color configuration of the label in a reference line."},"fontConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFontConfiguration","description":"The font configuration of the label in a reference line."},"horizontalPosition":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLineLabelHorizontalPosition","description":"The horizontal position configuration of the label in a reference line. Choose one of the following options:\n\n- `LEFT`\n- `CENTER`\n- `RIGHT`"},"valueLabelConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLineValueLabelConfiguration","description":"The value label configuration of the label in a reference line."},"verticalPosition":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLineLabelVerticalPosition","description":"The vertical position configuration of the label in a reference line. Choose one of the following options:\n\n- `ABOVE`\n- `BELOW`"}},"type":"object"},"aws-native:quicksight:DashboardReferenceLineLabelHorizontalPosition":{"type":"string","enum":[{"name":"Left","value":"LEFT"},{"name":"Center","value":"CENTER"},{"name":"Right","value":"RIGHT"}]},"aws-native:quicksight:DashboardReferenceLineLabelVerticalPosition":{"type":"string","enum":[{"name":"Above","value":"ABOVE"},{"name":"Below","value":"BELOW"}]},"aws-native:quicksight:DashboardReferenceLinePatternType":{"type":"string","enum":[{"name":"Solid","value":"SOLID"},{"name":"Dashed","value":"DASHED"},{"name":"Dotted","value":"DOTTED"}]},"aws-native:quicksight:DashboardReferenceLineSeriesType":{"type":"string","enum":[{"name":"Bar","value":"BAR"},{"name":"Line","value":"LINE"}]},"aws-native:quicksight:DashboardReferenceLineStaticDataConfiguration":{"properties":{"value":{"type":"number","description":"The double input of the static data."}},"type":"object","required":["value"]},"aws-native:quicksight:DashboardReferenceLineStyleConfiguration":{"properties":{"color":{"type":"string","description":"The hex color of the reference line."},"pattern":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLinePatternType","description":"The pattern type of the line style. Choose one of the following options:\n\n- `SOLID`\n- `DASHED`\n- `DOTTED`"}},"type":"object"},"aws-native:quicksight:DashboardReferenceLineValueLabelConfiguration":{"properties":{"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNumericFormatConfiguration","description":"The format configuration of the value label."},"relativePosition":{"$ref":"#/types/aws-native:quicksight:DashboardReferenceLineValueLabelRelativePosition","description":"The relative position of the value label. Choose one of the following options:\n\n- `BEFORE_CUSTOM_LABEL`\n- `AFTER_CUSTOM_LABEL`"}},"type":"object"},"aws-native:quicksight:DashboardReferenceLineValueLabelRelativePosition":{"type":"string","enum":[{"name":"BeforeCustomLabel","value":"BEFORE_CUSTOM_LABEL"},{"name":"AfterCustomLabel","value":"AFTER_CUSTOM_LABEL"}]},"aws-native:quicksight:DashboardRelativeDateTimeControlDisplayOptions":{"properties":{"dateTimeFormat":{"type":"string","description":"Customize how dates are formatted in controls."},"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:DashboardLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:DashboardRelativeDateType":{"type":"string","enum":[{"name":"Previous","value":"PREVIOUS"},{"name":"This","value":"THIS"},{"name":"Last","value":"LAST"},{"name":"Now","value":"NOW"},{"name":"Next","value":"NEXT"}]},"aws-native:quicksight:DashboardRelativeDatesFilter":{"properties":{"anchorDateConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardAnchorDateConfiguration","description":"The date configuration of the filter."},"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the filter is applied to."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"excludePeriodConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardExcludePeriodConfiguration","description":"The configuration for the exclude period of the filter."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"minimumGranularity":{"$ref":"#/types/aws-native:quicksight:DashboardTimeGranularity","description":"The minimum granularity (period granularity) of the relative dates filter."},"nullOption":{"$ref":"#/types/aws-native:quicksight:DashboardFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"parameterName":{"type":"string","description":"The parameter whose value should be used for the filter value."},"relativeDateType":{"$ref":"#/types/aws-native:quicksight:DashboardRelativeDateType","description":"The range date type of the filter. Choose one of the options below:\n\n- `PREVIOUS`\n- `THIS`\n- `LAST`\n- `NOW`\n- `NEXT`"},"relativeDateValue":{"type":"number","description":"The date value of the filter."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:DashboardTimeGranularity","description":"The level of time precision that is used to aggregate `DateTime` values."}},"type":"object","required":["anchorDateConfiguration","column","filterId","nullOption","relativeDateType","timeGranularity"]},"aws-native:quicksight:DashboardRelativeFontSize":{"type":"string","enum":[{"name":"ExtraSmall","value":"EXTRA_SMALL"},{"name":"Small","value":"SMALL"},{"name":"Medium","value":"MEDIUM"},{"name":"Large","value":"LARGE"},{"name":"ExtraLarge","value":"EXTRA_LARGE"}]},"aws-native:quicksight:DashboardResizeOption":{"type":"string","enum":[{"name":"Fixed","value":"FIXED"},{"name":"Responsive","value":"RESPONSIVE"}]},"aws-native:quicksight:DashboardResourcePermission":{"description":"\u003cp\u003ePermission for the resource.\u003c/p\u003e","properties":{"actions":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eThe IAM action to grant or revoke permissions on.\u003c/p\u003e"},"principal":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) of the principal. This can be one of the\n            following:\u003c/p\u003e\n         \u003cul\u003e\n            \u003cli\u003e\n               \u003cp\u003eThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)\u003c/p\u003e\n            \u003c/li\u003e\n            \u003cli\u003e\n               \u003cp\u003eThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)\u003c/p\u003e\n            \u003c/li\u003e\n            \u003cli\u003e\n               \u003cp\u003eThe ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n                    ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n                    (This is less common.) \u003c/p\u003e\n            \u003c/li\u003e\n         \u003c/ul\u003e"}},"type":"object","required":["actions","principal"]},"aws-native:quicksight:DashboardResourceStatus":{"type":"string","enum":[{"name":"CreationInProgress","value":"CREATION_IN_PROGRESS"},{"name":"CreationSuccessful","value":"CREATION_SUCCESSFUL"},{"name":"CreationFailed","value":"CREATION_FAILED"},{"name":"UpdateInProgress","value":"UPDATE_IN_PROGRESS"},{"name":"UpdateSuccessful","value":"UPDATE_SUCCESSFUL"},{"name":"UpdateFailed","value":"UPDATE_FAILED"},{"name":"PendingUpdate","value":"PENDING_UPDATE"},{"name":"Deleted","value":"DELETED"}]},"aws-native:quicksight:DashboardRollingDateConfiguration":{"properties":{"dataSetIdentifier":{"type":"string","description":"The data set that is used in the rolling date configuration."},"expression":{"type":"string","description":"The expression of the rolling date configuration."}},"type":"object","required":["expression"]},"aws-native:quicksight:DashboardRowAlternateColorOptions":{"properties":{"rowAlternateColors":{"type":"array","items":{"type":"string"},"description":"Determines the list of row alternate colors."},"status":{"$ref":"#/types/aws-native:quicksight:DashboardWidgetStatus","description":"Determines the widget status."},"usePrimaryBackgroundColor":{"$ref":"#/types/aws-native:quicksight:DashboardWidgetStatus","description":"The primary background color options for alternate rows."}},"type":"object"},"aws-native:quicksight:DashboardSameSheetTargetVisualConfiguration":{"properties":{"targetVisualOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTargetVisualOptions","description":"The options that choose the target visual in the same sheet.\n\nValid values are defined as follows:\n\n- `ALL_VISUALS` : Applies the filter operation to all visuals in the same sheet."},"targetVisuals":{"type":"array","items":{"type":"string"},"description":"A list of the target visual IDs that are located in the same sheet of the analysis."}},"type":"object"},"aws-native:quicksight:DashboardSankeyDiagramAggregatedFieldWells":{"properties":{"destination":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The destination field wells of a sankey diagram."},"source":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The source field wells of a sankey diagram."},"weight":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The weight field wells of a sankey diagram."}},"type":"object"},"aws-native:quicksight:DashboardSankeyDiagramChartConfiguration":{"properties":{"dataLabels":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOptions","description":"The data label configuration of a sankey diagram."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardSankeyDiagramFieldWells","description":"The field well configuration of a sankey diagram."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardSankeyDiagramSortConfiguration","description":"The sort configuration of a sankey diagram."}},"type":"object"},"aws-native:quicksight:DashboardSankeyDiagramFieldWells":{"properties":{"sankeyDiagramAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardSankeyDiagramAggregatedFieldWells","description":"The field well configuration of a sankey diagram."}},"type":"object"},"aws-native:quicksight:DashboardSankeyDiagramSortConfiguration":{"properties":{"destinationItemsLimit":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of destination nodes that are displayed in a sankey diagram."},"sourceItemsLimit":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of source nodes that are displayed in a sankey diagram."},"weightSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of the weight fields."}},"type":"object"},"aws-native:quicksight:DashboardSankeyDiagramVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardSankeyDiagramChartConfiguration","description":"The configuration of a sankey diagram."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardScatterPlotCategoricallyAggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The category field well of a scatter plot."},"label":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The label field well of a scatter plot."},"size":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The size field well of a scatter plot."},"xAxis":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The x-axis field well of a scatter plot.\n\nThe x-axis is aggregated by category."},"yAxis":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The y-axis field well of a scatter plot.\n\nThe y-axis is aggregated by category."}},"type":"object"},"aws-native:quicksight:DashboardScatterPlotConfiguration":{"properties":{"dataLabels":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOptions","description":"The options that determine if visual data labels are displayed."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardScatterPlotFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions","description":"The legend display setup of the visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardScatterPlotSortConfiguration","description":"The sort configuration of a scatter plot."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The legend display setup of the visual."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPalette","description":"The palette (chart color) display setup of the visual."},"xAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis."},"xAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis."},"yAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis."},"yAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis."}},"type":"object"},"aws-native:quicksight:DashboardScatterPlotFieldWells":{"properties":{"scatterPlotCategoricallyAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardScatterPlotCategoricallyAggregatedFieldWells","description":"The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both."},"scatterPlotUnaggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardScatterPlotUnaggregatedFieldWells","description":"The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are unaggregated."}},"type":"object"},"aws-native:quicksight:DashboardScatterPlotSortConfiguration":{"properties":{"scatterPlotLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration"}},"type":"object"},"aws-native:quicksight:DashboardScatterPlotUnaggregatedFieldWells":{"properties":{"category":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The category field well of a scatter plot."},"label":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The label field well of a scatter plot."},"size":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The size field well of a scatter plot."},"xAxis":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The x-axis field well of a scatter plot.\n\nThe x-axis is a dimension field and cannot be aggregated."},"yAxis":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The y-axis field well of a scatter plot.\n\nThe y-axis is a dimension field and cannot be aggregated."}},"type":"object"},"aws-native:quicksight:DashboardScatterPlotVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardScatterPlotConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardScrollBarOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the data zoom scroll bar."},"visibleRange":{"$ref":"#/types/aws-native:quicksight:DashboardVisibleRangeOptions","description":"The visibility range for the data zoom scroll bar."}},"type":"object"},"aws-native:quicksight:DashboardSecondaryValueOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines the visibility of the secondary value."}},"type":"object"},"aws-native:quicksight:DashboardSectionAfterPageBreak":{"properties":{"status":{"$ref":"#/types/aws-native:quicksight:DashboardSectionPageBreakStatus","description":"The option that enables or disables a page break at the end of a section."}},"type":"object"},"aws-native:quicksight:DashboardSectionBasedLayoutCanvasSizeOptions":{"properties":{"paperCanvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSectionBasedLayoutPaperCanvasSizeOptions","description":"The options for a paper canvas of a section-based layout."}},"type":"object"},"aws-native:quicksight:DashboardSectionBasedLayoutConfiguration":{"properties":{"bodySections":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardBodySectionConfiguration"},"description":"A list of body section configurations."},"canvasSizeOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSectionBasedLayoutCanvasSizeOptions","description":"The options for the canvas of a section-based layout."},"footerSections":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardHeaderFooterSectionConfiguration"},"description":"A list of footer section configurations."},"headerSections":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardHeaderFooterSectionConfiguration"},"description":"A list of header section configurations."}},"type":"object","required":["bodySections","canvasSizeOptions","footerSections","headerSections"]},"aws-native:quicksight:DashboardSectionBasedLayoutPaperCanvasSizeOptions":{"properties":{"paperMargin":{"$ref":"#/types/aws-native:quicksight:DashboardSpacing","description":"Defines the spacing between the canvas content and the top, bottom, left, and right edges."},"paperOrientation":{"$ref":"#/types/aws-native:quicksight:DashboardPaperOrientation","description":"The paper orientation that is used to define canvas dimensions. Choose one of the following options:\n\n- PORTRAIT\n- LANDSCAPE"},"paperSize":{"$ref":"#/types/aws-native:quicksight:DashboardPaperSize","description":"The paper size that is used to define canvas dimensions."}},"type":"object"},"aws-native:quicksight:DashboardSectionLayoutConfiguration":{"properties":{"freeFormLayout":{"$ref":"#/types/aws-native:quicksight:DashboardFreeFormSectionLayoutConfiguration","description":"The free-form layout configuration of a section."}},"type":"object","required":["freeFormLayout"]},"aws-native:quicksight:DashboardSectionPageBreakConfiguration":{"properties":{"after":{"$ref":"#/types/aws-native:quicksight:DashboardSectionAfterPageBreak","description":"The configuration of a page break after a section."}},"type":"object"},"aws-native:quicksight:DashboardSectionPageBreakStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:DashboardSectionStyle":{"properties":{"height":{"type":"string","description":"String based length that is composed of value and unit in px"},"padding":{"$ref":"#/types/aws-native:quicksight:DashboardSpacing","description":"The spacing between section content and its top, bottom, left, and right edges.\n\nThere is no padding by default."}},"type":"object"},"aws-native:quicksight:DashboardSelectAllValueOptions":{"type":"string","enum":[{"name":"AllValues","value":"ALL_VALUES"}]},"aws-native:quicksight:DashboardSelectedFieldOptions":{"type":"string","enum":[{"name":"AllFields","value":"ALL_FIELDS"}]},"aws-native:quicksight:DashboardSelectedSheetsFilterScopeConfiguration":{"properties":{"sheetVisualScopingConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardSheetVisualScopingConfiguration"},"description":"The sheet ID and visual IDs of the sheet and visuals that the filter is applied to."}},"type":"object"},"aws-native:quicksight:DashboardSelectedTooltipType":{"type":"string","enum":[{"name":"Basic","value":"BASIC"},{"name":"Detailed","value":"DETAILED"}]},"aws-native:quicksight:DashboardSeriesItem":{"properties":{"dataFieldSeriesItem":{"$ref":"#/types/aws-native:quicksight:DashboardDataFieldSeriesItem","description":"The data field series item configuration of a line chart."},"fieldSeriesItem":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSeriesItem","description":"The field series item configuration of a line chart."}},"type":"object"},"aws-native:quicksight:DashboardSetParameterValueConfiguration":{"properties":{"destinationParameterName":{"type":"string","description":"The destination parameter name of the `SetParameterValueConfiguration` ."},"value":{"$ref":"#/types/aws-native:quicksight:DashboardDestinationParameterValueConfiguration"}},"type":"object","required":["destinationParameterName","value"]},"aws-native:quicksight:DashboardShapeConditionalFormat":{"properties":{"backgroundColor":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingColor","description":"The conditional formatting for the shape background color of a filled map visual."}},"type":"object","required":["backgroundColor"]},"aws-native:quicksight:DashboardSheet":{"description":"\u003cp\u003eA \u003ci\u003esheet\u003c/i\u003e, which is an object that contains a set of visuals that\n            are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n            contains at least one sheet. Each sheet contains at least one visualization widget, for\n            example a chart, pivot table, or narrative insight. Sheets can be associated with other\n            components, such as controls, filters, and so on.\u003c/p\u003e","properties":{"name":{"type":"string","description":"\u003cp\u003eThe name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n            console.\u003c/p\u003e"},"sheetId":{"type":"string","description":"\u003cp\u003eThe unique identifier associated with a sheet.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DashboardSheetContentType":{"type":"string","enum":[{"name":"Paginated","value":"PAGINATED"},{"name":"Interactive","value":"INTERACTIVE"}]},"aws-native:quicksight:DashboardSheetControlDateTimePickerType":{"type":"string","enum":[{"name":"SingleValued","value":"SINGLE_VALUED"},{"name":"DateRange","value":"DATE_RANGE"}]},"aws-native:quicksight:DashboardSheetControlInfoIconLabelOptions":{"properties":{"infoIconText":{"type":"string","description":"The text content of info icon."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility configuration of info icon label options."}},"type":"object"},"aws-native:quicksight:DashboardSheetControlLayout":{"properties":{"configuration":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlLayoutConfiguration","description":"The configuration that determines the elements and canvas size options of sheet control."}},"type":"object","required":["configuration"]},"aws-native:quicksight:DashboardSheetControlLayoutConfiguration":{"properties":{"gridLayout":{"$ref":"#/types/aws-native:quicksight:DashboardGridLayoutConfiguration","description":"The configuration that determines the elements and canvas size options of sheet control."}},"type":"object"},"aws-native:quicksight:DashboardSheetControlListType":{"type":"string","enum":[{"name":"MultiSelect","value":"MULTI_SELECT"},{"name":"SingleSelect","value":"SINGLE_SELECT"}]},"aws-native:quicksight:DashboardSheetControlSliderType":{"type":"string","enum":[{"name":"SinglePoint","value":"SINGLE_POINT"},{"name":"Range","value":"RANGE"}]},"aws-native:quicksight:DashboardSheetControlsOption":{"description":"\u003cp\u003eSheet controls option.\u003c/p\u003e","properties":{"visibilityState":{"$ref":"#/types/aws-native:quicksight:DashboardUiState","description":"Visibility state."}},"type":"object"},"aws-native:quicksight:DashboardSheetDefinition":{"properties":{"contentType":{"$ref":"#/types/aws-native:quicksight:DashboardSheetContentType","description":"The layout content type of the sheet. Choose one of the following options:\n\n- `PAGINATED` : Creates a sheet for a paginated report.\n- `INTERACTIVE` : Creates a sheet for an interactive dashboard."},"description":{"type":"string","description":"A description of the sheet."},"filterControls":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFilterControl"},"description":"The list of filter controls that are on a sheet.\n\nFor more information, see [Adding filter controls to analysis sheets](https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html) in the *Amazon Quick Suite User Guide* ."},"images":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardSheetImage"},"description":"A list of images on a sheet."},"layouts":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardLayout"},"description":"Layouts define how the components of a sheet are arranged.\n\nFor more information, see [Types of layout](https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html) in the *Amazon Quick Suite User Guide* ."},"name":{"type":"string","description":"The name of the sheet. This name is displayed on the sheet's tab in the Quick Suite console."},"parameterControls":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardParameterControl"},"description":"The list of parameter controls that are on a sheet.\n\nFor more information, see [Using a Control with a Parameter in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html) in the *Amazon Quick Suite User Guide* ."},"sheetControlLayouts":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlLayout"},"description":"The control layouts of the sheet."},"sheetId":{"type":"string","description":"The unique identifier of a sheet."},"textBoxes":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardSheetTextBox"},"description":"The text boxes that are on a sheet."},"title":{"type":"string","description":"The title of the sheet."},"visuals":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisual"},"description":"A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet."}},"type":"object","required":["sheetId"]},"aws-native:quicksight:DashboardSheetElementConfigurationOverrides":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines whether or not the overrides are visible. Choose one of the following options:\n\n- `VISIBLE`\n- `HIDDEN`"}},"type":"object"},"aws-native:quicksight:DashboardSheetElementRenderingRule":{"properties":{"configurationOverrides":{"$ref":"#/types/aws-native:quicksight:DashboardSheetElementConfigurationOverrides","description":"The override configuration of the rendering rules of a sheet."},"expression":{"type":"string","description":"The expression of the rendering rules of a sheet."}},"type":"object","required":["configurationOverrides","expression"]},"aws-native:quicksight:DashboardSheetImage":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardImageCustomAction"},"description":"A list of custom actions that are configured for an image."},"imageContentAltText":{"type":"string","description":"The alt text for the image."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardImageInteractionOptions","description":"The general image interactions setup for an image."},"scaling":{"$ref":"#/types/aws-native:quicksight:DashboardSheetImageScalingConfiguration","description":"Determines how the image is scaled."},"sheetImageId":{"type":"string","description":"The ID of the sheet image."},"source":{"$ref":"#/types/aws-native:quicksight:DashboardSheetImageSource","description":"The source of the image."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardSheetImageTooltipConfiguration","description":"The tooltip to be shown when hovering over the image."}},"type":"object","required":["sheetImageId","source"]},"aws-native:quicksight:DashboardSheetImageScalingConfiguration":{"properties":{"scalingType":{"$ref":"#/types/aws-native:quicksight:DashboardSheetImageScalingType","description":"The scaling option to use when fitting the image inside the container.\n\nValid values are defined as follows:\n\n- `SCALE_TO_WIDTH` : The image takes up the entire width of the container. The image aspect ratio is preserved.\n- `SCALE_TO_HEIGHT` : The image takes up the entire height of the container. The image aspect ratio is preserved.\n- `SCALE_TO_CONTAINER` : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.\n- `SCALE_NONE` : The image is displayed in its original size and is not scaled to the container."}},"type":"object"},"aws-native:quicksight:DashboardSheetImageScalingType":{"type":"string","enum":[{"name":"ScaleToWidth","value":"SCALE_TO_WIDTH"},{"name":"ScaleToHeight","value":"SCALE_TO_HEIGHT"},{"name":"ScaleToContainer","value":"SCALE_TO_CONTAINER"},{"name":"ScaleNone","value":"SCALE_NONE"}]},"aws-native:quicksight:DashboardSheetImageSource":{"properties":{"sheetImageStaticFileSource":{"$ref":"#/types/aws-native:quicksight:DashboardSheetImageStaticFileSource","description":"The source of the static file that contains the image."}},"type":"object"},"aws-native:quicksight:DashboardSheetImageStaticFileSource":{"properties":{"staticFileId":{"type":"string","description":"The ID of the static file that contains the image."}},"type":"object","required":["staticFileId"]},"aws-native:quicksight:DashboardSheetImageTooltipConfiguration":{"properties":{"tooltipText":{"$ref":"#/types/aws-native:quicksight:DashboardSheetImageTooltipText","description":"The text that appears in the tooltip."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the tooltip."}},"type":"object"},"aws-native:quicksight:DashboardSheetImageTooltipText":{"properties":{"plainText":{"type":"string","description":"The plain text format."}},"type":"object"},"aws-native:quicksight:DashboardSheetLayoutElementMaximizationOption":{"description":"\u003cp\u003eThe sheet layout maximization options of a dashbaord.\u003c/p\u003e","properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"The status of the sheet layout maximization options of a dashbaord."}},"type":"object"},"aws-native:quicksight:DashboardSheetTextBox":{"properties":{"content":{"type":"string","description":"The content that is displayed in the text box."},"sheetTextBoxId":{"type":"string","description":"The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers."}},"type":"object","required":["sheetTextBoxId"]},"aws-native:quicksight:DashboardSheetVisualScopingConfiguration":{"properties":{"scope":{"$ref":"#/types/aws-native:quicksight:DashboardFilterVisualScope","description":"The scope of the applied entities. Choose one of the following options:\n\n- `ALL_VISUALS`\n- `SELECTED_VISUALS`"},"sheetId":{"type":"string","description":"The selected sheet that the filter is applied to."},"visualIds":{"type":"array","items":{"type":"string"},"description":"The selected visuals that the filter is applied to."}},"type":"object","required":["scope","sheetId"]},"aws-native:quicksight:DashboardShortFormatText":{"properties":{"plainText":{"type":"string","description":"Plain text format."},"richText":{"type":"string","description":"Rich text. Examples of rich text include bold, underline, and italics."}},"type":"object"},"aws-native:quicksight:DashboardSimpleAttributeAggregationFunction":{"type":"string","enum":[{"name":"UniqueValue","value":"UNIQUE_VALUE"}]},"aws-native:quicksight:DashboardSimpleClusterMarker":{"properties":{"color":{"type":"string","description":"The color of the simple cluster marker."}},"type":"object"},"aws-native:quicksight:DashboardSimpleNumericalAggregationFunction":{"type":"string","enum":[{"name":"Sum","value":"SUM"},{"name":"Average","value":"AVERAGE"},{"name":"Min","value":"MIN"},{"name":"Max","value":"MAX"},{"name":"Count","value":"COUNT"},{"name":"DistinctCount","value":"DISTINCT_COUNT"},{"name":"Var","value":"VAR"},{"name":"Varp","value":"VARP"},{"name":"Stdev","value":"STDEV"},{"name":"Stdevp","value":"STDEVP"},{"name":"Median","value":"MEDIAN"}]},"aws-native:quicksight:DashboardSimpleTotalAggregationFunction":{"type":"string","enum":[{"name":"Default","value":"DEFAULT"},{"name":"Sum","value":"SUM"},{"name":"Average","value":"AVERAGE"},{"name":"Min","value":"MIN"},{"name":"Max","value":"MAX"},{"name":"None","value":"NONE"}]},"aws-native:quicksight:DashboardSingleAxisOptions":{"properties":{"yAxisOptions":{"$ref":"#/types/aws-native:quicksight:DashboardYAxisOptions","description":"The Y axis options of a single axis configuration."}},"type":"object"},"aws-native:quicksight:DashboardSingleYAxisOption":{"type":"string","enum":[{"name":"PrimaryYAxis","value":"PRIMARY_Y_AXIS"}]},"aws-native:quicksight:DashboardSliderControlDisplayOptions":{"properties":{"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:DashboardLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:DashboardSmallMultiplesAxisPlacement":{"type":"string","enum":[{"name":"Outside","value":"OUTSIDE"},{"name":"Inside","value":"INSIDE"}]},"aws-native:quicksight:DashboardSmallMultiplesAxisProperties":{"properties":{"placement":{"$ref":"#/types/aws-native:quicksight:DashboardSmallMultiplesAxisPlacement","description":"Defines the placement of the axis. By default, axes are rendered `OUTSIDE` of the panels. Axes with `INDEPENDENT` scale are rendered `INSIDE` the panels."},"scale":{"$ref":"#/types/aws-native:quicksight:DashboardSmallMultiplesAxisScale","description":"Determines whether scale of the axes are shared or independent. The default value is `SHARED` ."}},"type":"object"},"aws-native:quicksight:DashboardSmallMultiplesAxisScale":{"type":"string","enum":[{"name":"Shared","value":"SHARED"},{"name":"Independent","value":"INDEPENDENT"}]},"aws-native:quicksight:DashboardSmallMultiplesOptions":{"properties":{"maxVisibleColumns":{"type":"number","description":"Sets the maximum number of visible columns to display in the grid of small multiples panels.\n\nThe default is `Auto` , which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart."},"maxVisibleRows":{"type":"number","description":"Sets the maximum number of visible rows to display in the grid of small multiples panels.\n\nThe default value is `Auto` , which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart."},"panelConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardPanelConfiguration","description":"Configures the display options for each small multiples panel."},"xAxis":{"$ref":"#/types/aws-native:quicksight:DashboardSmallMultiplesAxisProperties","description":"The properties of a small multiples X axis."},"yAxis":{"$ref":"#/types/aws-native:quicksight:DashboardSmallMultiplesAxisProperties","description":"The properties of a small multiples Y axis."}},"type":"object"},"aws-native:quicksight:DashboardSortDirection":{"type":"string","enum":[{"name":"Asc","value":"ASC"},{"name":"Desc","value":"DESC"}]},"aws-native:quicksight:DashboardSourceEntity":{"description":"\u003cp\u003eDashboard source entity.\u003c/p\u003e","properties":{"sourceTemplate":{"$ref":"#/types/aws-native:quicksight:DashboardSourceTemplate","description":"Source template."}},"type":"object"},"aws-native:quicksight:DashboardSourceTemplate":{"description":"\u003cp\u003eDashboard source template.\u003c/p\u003e","properties":{"arn":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) of the resource.\u003c/p\u003e"},"dataSetReferences":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDataSetReference"},"description":"\u003cp\u003eDataset references.\u003c/p\u003e"}},"type":"object","required":["arn","dataSetReferences"]},"aws-native:quicksight:DashboardSpacing":{"properties":{"bottom":{"type":"string","description":"String based length that is composed of value and unit"},"left":{"type":"string","description":"String based length that is composed of value and unit"},"right":{"type":"string","description":"String based length that is composed of value and unit"},"top":{"type":"string","description":"String based length that is composed of value and unit"}},"type":"object"},"aws-native:quicksight:DashboardSpatialStaticFile":{"properties":{"source":{"$ref":"#/types/aws-native:quicksight:DashboardStaticFileSource","description":"The source of the spatial static file."},"staticFileId":{"type":"string","description":"The ID of the spatial static file."}},"type":"object","required":["staticFileId"]},"aws-native:quicksight:DashboardSpecialValue":{"type":"string","enum":[{"name":"Empty","value":"EMPTY"},{"name":"Null","value":"NULL"},{"name":"Other","value":"OTHER"}]},"aws-native:quicksight:DashboardStaticFile":{"properties":{"imageStaticFile":{"$ref":"#/types/aws-native:quicksight:DashboardImageStaticFile","description":"The image static file."},"spatialStaticFile":{"$ref":"#/types/aws-native:quicksight:DashboardSpatialStaticFile","description":"The spacial static file."}},"type":"object"},"aws-native:quicksight:DashboardStaticFileS3SourceOptions":{"properties":{"bucketName":{"type":"string","description":"The name of the Amazon S3 bucket."},"objectKey":{"type":"string","description":"The identifier of the static file in the Amazon S3 bucket."},"region":{"type":"string","description":"The Region of the Amazon S3 account that contains the bucket."}},"type":"object","required":["bucketName","objectKey","region"]},"aws-native:quicksight:DashboardStaticFileSource":{"properties":{"s3Options":{"$ref":"#/types/aws-native:quicksight:DashboardStaticFileS3SourceOptions","description":"The structure that contains the Amazon S3 location to download the static file from."},"urlOptions":{"$ref":"#/types/aws-native:quicksight:DashboardStaticFileUrlSourceOptions","description":"The structure that contains the URL to download the static file from."}},"type":"object"},"aws-native:quicksight:DashboardStaticFileUrlSourceOptions":{"properties":{"url":{"type":"string","description":"The URL to download the static file from."}},"type":"object","required":["url"]},"aws-native:quicksight:DashboardStringDefaultValues":{"properties":{"dynamicValue":{"$ref":"#/types/aws-native:quicksight:DashboardDynamicDefaultValue","description":"The dynamic value of the `StringDefaultValues` . Different defaults displayed according to users, groups, and values mapping."},"staticValues":{"type":"array","items":{"type":"string"},"description":"The static values of the `DecimalDefaultValues` ."}},"type":"object"},"aws-native:quicksight:DashboardStringFormatConfiguration":{"properties":{"nullValueFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNullValueFormatConfiguration","description":"The options that determine the null value format configuration."},"numericFormatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardNumericFormatConfiguration","description":"The formatting configuration for numeric strings."}},"type":"object"},"aws-native:quicksight:DashboardStringParameter":{"description":"\u003cp\u003eA string parameter.\u003c/p\u003e","properties":{"name":{"type":"string","description":"\u003cp\u003eA display name for a string parameter.\u003c/p\u003e"},"values":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eThe values of a string parameter.\u003c/p\u003e"}},"type":"object","required":["name","values"]},"aws-native:quicksight:DashboardStringParameterDeclaration":{"properties":{"defaultValues":{"$ref":"#/types/aws-native:quicksight:DashboardStringDefaultValues","description":"The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided."},"mappedDataSetParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMappedDataSetParameter"}},"name":{"type":"string","description":"The name of the parameter that is being declared."},"parameterValueType":{"$ref":"#/types/aws-native:quicksight:DashboardParameterValueType","description":"The value type determines whether the parameter is a single-value or multi-value parameter."},"valueWhenUnset":{"$ref":"#/types/aws-native:quicksight:DashboardStringValueWhenUnsetConfiguration","description":"The configuration that defines the default value of a `String` parameter when a value has not been set."}},"type":"object","required":["name","parameterValueType"]},"aws-native:quicksight:DashboardStringValueWhenUnsetConfiguration":{"properties":{"customValue":{"type":"string","description":"A custom value that's used when the value of a parameter isn't set."},"valueWhenUnsetOption":{"$ref":"#/types/aws-native:quicksight:DashboardValueWhenUnsetOption","description":"The built-in options for default values. The value can be one of the following:\n\n- `RECOMMENDED` : The recommended value.\n- `NULL` : The `NULL` value."}},"type":"object"},"aws-native:quicksight:DashboardStyledCellType":{"type":"string","enum":[{"name":"Total","value":"TOTAL"},{"name":"MetricHeader","value":"METRIC_HEADER"},{"name":"Value","value":"VALUE"}]},"aws-native:quicksight:DashboardSubtotalOptions":{"properties":{"customLabel":{"type":"string","description":"The custom label string for the subtotal cells."},"fieldLevel":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableSubtotalLevel","description":"The field level (all, custom, last) for the subtotal cells."},"fieldLevelOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableFieldSubtotalOptions"},"description":"The optional configuration of subtotal cells."},"metricHeaderCellStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"The cell styling options for the subtotals of header cells."},"styleTargets":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardTableStyleTarget"},"description":"The style targets options for subtotals."},"totalCellStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"The cell styling options for the subtotal cells."},"totalsVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility configuration for the subtotal cells."},"valueCellStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"The cell styling options for the subtotals of value cells."}},"type":"object"},"aws-native:quicksight:DashboardTableAggregatedFieldWells":{"properties":{"groupBy":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The group by field well for a pivot table. Values are grouped by group by fields."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The values field well for a pivot table. Values are aggregated based on group by fields."}},"type":"object"},"aws-native:quicksight:DashboardTableBorderOptions":{"properties":{"color":{"type":"string","description":"The color of a table border."},"style":{"$ref":"#/types/aws-native:quicksight:DashboardTableBorderStyle","description":"The style (none, solid) of a table border."},"thickness":{"type":"number","description":"The thickness of a table border."}},"type":"object"},"aws-native:quicksight:DashboardTableBorderStyle":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Solid","value":"SOLID"}]},"aws-native:quicksight:DashboardTableCellConditionalFormatting":{"properties":{"fieldId":{"type":"string","description":"The field ID of the cell for conditional formatting."},"textFormat":{"$ref":"#/types/aws-native:quicksight:DashboardTextConditionalFormat","description":"The text format of the cell for conditional formatting."}},"type":"object","required":["fieldId"]},"aws-native:quicksight:DashboardTableCellImageScalingConfiguration":{"type":"string","enum":[{"name":"FitToCellHeight","value":"FIT_TO_CELL_HEIGHT"},{"name":"FitToCellWidth","value":"FIT_TO_CELL_WIDTH"},{"name":"DoNotScale","value":"DO_NOT_SCALE"}]},"aws-native:quicksight:DashboardTableCellImageSizingConfiguration":{"properties":{"tableCellImageScalingConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellImageScalingConfiguration","description":"The cell scaling configuration of the sizing options for the table image configuration."}},"type":"object"},"aws-native:quicksight:DashboardTableCellStyle":{"properties":{"backgroundColor":{"type":"string","description":"The background color for the table cells."},"border":{"$ref":"#/types/aws-native:quicksight:DashboardGlobalTableBorderOptions","description":"The borders for the table cells."},"fontConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFontConfiguration","description":"The font configuration of the table cells."},"height":{"type":"number","description":"The height color for the table cells."},"horizontalTextAlignment":{"$ref":"#/types/aws-native:quicksight:DashboardHorizontalTextAlignment","description":"The horizontal text alignment (left, center, right, auto) for the table cells."},"textWrap":{"$ref":"#/types/aws-native:quicksight:DashboardTextWrap","description":"The text wrap (none, wrap) for the table cells."},"verticalTextAlignment":{"$ref":"#/types/aws-native:quicksight:DashboardVerticalTextAlignment","description":"The vertical text alignment (top, middle, bottom) for the table cells."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the table cells."}},"type":"object"},"aws-native:quicksight:DashboardTableConditionalFormatting":{"properties":{"conditionalFormattingOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardTableConditionalFormattingOption"},"description":"Conditional formatting options for a `PivotTableVisual` ."}},"type":"object"},"aws-native:quicksight:DashboardTableConditionalFormattingOption":{"properties":{"cell":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellConditionalFormatting","description":"The cell conditional formatting option for a table."},"row":{"$ref":"#/types/aws-native:quicksight:DashboardTableRowConditionalFormatting","description":"The row conditional formatting option for a table."}},"type":"object"},"aws-native:quicksight:DashboardTableConfiguration":{"properties":{"fieldOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTableFieldOptions","description":"The field options for a table visual."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardTableFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"paginatedReportOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTablePaginatedReportOptions","description":"The paginated report options for a table visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardTableSortConfiguration","description":"The sort configuration for a `TableVisual` ."},"tableInlineVisualizations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardTableInlineVisualization"},"description":"A collection of inline visualizations to display within a chart."},"tableOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTableOptions","description":"The table options for a table visual."},"totalOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTotalOptions","description":"The total options for a table visual."}},"type":"object"},"aws-native:quicksight:DashboardTableFieldCustomIconContent":{"properties":{"icon":{"$ref":"#/types/aws-native:quicksight:DashboardTableFieldIconSetType","description":"The icon set type (link) of the custom icon content for table URL link content."}},"type":"object"},"aws-native:quicksight:DashboardTableFieldCustomTextContent":{"properties":{"fontConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFontConfiguration","description":"The font configuration of the custom text content for the table URL link content."},"value":{"type":"string","description":"The string value of the custom text content for the table URL link content."}},"type":"object","required":["fontConfiguration"]},"aws-native:quicksight:DashboardTableFieldIconSetType":{"type":"string","enum":[{"name":"Link","value":"LINK"}]},"aws-native:quicksight:DashboardTableFieldImageConfiguration":{"properties":{"sizingOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellImageSizingConfiguration","description":"The sizing options for the table image configuration."}},"type":"object"},"aws-native:quicksight:DashboardTableFieldLinkConfiguration":{"properties":{"content":{"$ref":"#/types/aws-native:quicksight:DashboardTableFieldLinkContentConfiguration","description":"The URL content (text, icon) for the table link configuration."},"target":{"$ref":"#/types/aws-native:quicksight:DashboardUrlTargetConfiguration","description":"The URL target (new tab, new window, same tab) for the table link configuration."}},"type":"object","required":["content","target"]},"aws-native:quicksight:DashboardTableFieldLinkContentConfiguration":{"properties":{"customIconContent":{"$ref":"#/types/aws-native:quicksight:DashboardTableFieldCustomIconContent","description":"The custom icon content for the table link content configuration."},"customTextContent":{"$ref":"#/types/aws-native:quicksight:DashboardTableFieldCustomTextContent","description":"The custom text content (value, font configuration) for the table link content configuration."}},"type":"object"},"aws-native:quicksight:DashboardTableFieldOption":{"properties":{"customLabel":{"type":"string","description":"The custom label for a table field."},"fieldId":{"type":"string","description":"The field ID for a table field."},"urlStyling":{"$ref":"#/types/aws-native:quicksight:DashboardTableFieldUrlConfiguration","description":"The URL configuration for a table field."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of a table field."},"width":{"type":"string","description":"String based length that is composed of value and unit in px"}},"type":"object","required":["fieldId"]},"aws-native:quicksight:DashboardTableFieldOptions":{"properties":{"order":{"type":"array","items":{"type":"string"},"description":"The order of the field IDs that are configured as field options for a table visual."},"pinnedFieldOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTablePinnedFieldOptions","description":"The settings for the pinned columns of a table visual."},"selectedFieldOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardTableFieldOption"},"description":"The field options to be configured to a table."},"transposedTableOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardTransposedTableOption"},"description":"The `TableOptions` of a transposed table."}},"type":"object"},"aws-native:quicksight:DashboardTableFieldUrlConfiguration":{"properties":{"imageConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardTableFieldImageConfiguration","description":"The image configuration of a table field URL."},"linkConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardTableFieldLinkConfiguration","description":"The link configuration of a table field URL."}},"type":"object"},"aws-native:quicksight:DashboardTableFieldWells":{"properties":{"tableAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardTableAggregatedFieldWells","description":"The aggregated field well for the table."},"tableUnaggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardTableUnaggregatedFieldWells","description":"The unaggregated field well for the table."}},"type":"object"},"aws-native:quicksight:DashboardTableInlineVisualization":{"properties":{"dataBars":{"$ref":"#/types/aws-native:quicksight:DashboardDataBarsOptions","description":"The configuration of the inline visualization of the data bars within a chart."}},"type":"object"},"aws-native:quicksight:DashboardTableOptions":{"properties":{"cellStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"The table cell style of table cells."},"headerStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"The table cell style of a table header."},"orientation":{"$ref":"#/types/aws-native:quicksight:DashboardTableOrientation","description":"The orientation (vertical, horizontal) for a table."},"rowAlternateColorOptions":{"$ref":"#/types/aws-native:quicksight:DashboardRowAlternateColorOptions","description":"The row alternate color options (widget status, row alternate colors) for a table."}},"type":"object"},"aws-native:quicksight:DashboardTableOrientation":{"type":"string","enum":[{"name":"Vertical","value":"VERTICAL"},{"name":"Horizontal","value":"HORIZONTAL"}]},"aws-native:quicksight:DashboardTablePaginatedReportOptions":{"properties":{"overflowColumnHeaderVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of repeating header rows on each page."},"verticalOverflowVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of printing table overflow across pages."}},"type":"object"},"aws-native:quicksight:DashboardTablePinnedFieldOptions":{"properties":{"pinnedLeftFields":{"type":"array","items":{"type":"string"},"description":"A list of columns to be pinned to the left of a table visual."}},"type":"object"},"aws-native:quicksight:DashboardTableRowConditionalFormatting":{"properties":{"backgroundColor":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingColor","description":"The conditional formatting color (solid, gradient) of the background for a table row."},"textColor":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingColor","description":"The conditional formatting color (solid, gradient) of the text for a table row."}},"type":"object"},"aws-native:quicksight:DashboardTableSideBorderOptions":{"properties":{"bottom":{"$ref":"#/types/aws-native:quicksight:DashboardTableBorderOptions","description":"The table border options of the bottom border."},"innerHorizontal":{"$ref":"#/types/aws-native:quicksight:DashboardTableBorderOptions","description":"The table border options of the inner horizontal border."},"innerVertical":{"$ref":"#/types/aws-native:quicksight:DashboardTableBorderOptions","description":"The table border options of the inner vertical border."},"left":{"$ref":"#/types/aws-native:quicksight:DashboardTableBorderOptions","description":"The table border options of the left border."},"right":{"$ref":"#/types/aws-native:quicksight:DashboardTableBorderOptions","description":"The table border options of the right border."},"top":{"$ref":"#/types/aws-native:quicksight:DashboardTableBorderOptions","description":"The table border options of the top border."}},"type":"object"},"aws-native:quicksight:DashboardTableSortConfiguration":{"properties":{"paginationConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardPaginationConfiguration","description":"The pagination configuration (page size, page number) for the table."},"rowSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The field sort options for rows in the table."}},"type":"object"},"aws-native:quicksight:DashboardTableStyleTarget":{"properties":{"cellType":{"$ref":"#/types/aws-native:quicksight:DashboardStyledCellType","description":"The cell type of the table style target."}},"type":"object","required":["cellType"]},"aws-native:quicksight:DashboardTableTotalsPlacement":{"type":"string","enum":[{"name":"Start","value":"START"},{"name":"End","value":"END"},{"name":"Auto","value":"AUTO"}]},"aws-native:quicksight:DashboardTableTotalsScrollStatus":{"type":"string","enum":[{"name":"Pinned","value":"PINNED"},{"name":"Scrolled","value":"SCROLLED"}]},"aws-native:quicksight:DashboardTableUnaggregatedFieldWells":{"properties":{"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardUnaggregatedField"},"description":"The values field well for a pivot table. Values are unaggregated for an unaggregated table."}},"type":"object"},"aws-native:quicksight:DashboardTableVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardTableConfiguration","description":"The configuration settings of the visual."},"conditionalFormatting":{"$ref":"#/types/aws-native:quicksight:DashboardTableConditionalFormatting","description":"The conditional formatting for a `PivotTableVisual` ."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardTag":{"description":"\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n            resource.\u003c/p\u003e","properties":{"key":{"type":"string","description":"\u003cp\u003eTag key.\u003c/p\u003e"},"value":{"type":"string","description":"\u003cp\u003eTag value.\u003c/p\u003e"}},"type":"object","required":["key","value"]},"aws-native:quicksight:DashboardTargetVisualOptions":{"type":"string","enum":[{"name":"AllVisuals","value":"ALL_VISUALS"}]},"aws-native:quicksight:DashboardTextAreaControlDisplayOptions":{"properties":{"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"placeholderOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTextControlPlaceholderOptions","description":"The configuration of the placeholder options in a text area control."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:DashboardLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:DashboardTextConditionalFormat":{"properties":{"backgroundColor":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingColor","description":"The conditional formatting for the text background color."},"icon":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingIcon","description":"The conditional formatting for the icon."},"textColor":{"$ref":"#/types/aws-native:quicksight:DashboardConditionalFormattingColor","description":"The conditional formatting for the text color."}},"type":"object"},"aws-native:quicksight:DashboardTextControlPlaceholderOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility configuration of the placeholder options in a text control."}},"type":"object"},"aws-native:quicksight:DashboardTextFieldControlDisplayOptions":{"properties":{"infoIconLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardSheetControlInfoIconLabelOptions","description":"The configuration of info icon label options."},"placeholderOptions":{"$ref":"#/types/aws-native:quicksight:DashboardTextControlPlaceholderOptions","description":"The configuration of the placeholder options in a text field control."},"titleOptions":{"$ref":"#/types/aws-native:quicksight:DashboardLabelOptions","description":"The options to configure the title visibility, name, and font size."}},"type":"object"},"aws-native:quicksight:DashboardTextWrap":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Wrap","value":"WRAP"}]},"aws-native:quicksight:DashboardThousandSeparatorOptions":{"properties":{"groupingStyle":{"$ref":"#/types/aws-native:quicksight:DashboardDigitGroupingStyle","description":"Determines the way numbers are styled to accommodate different readability standards. The `DEFAULT` value uses the standard international grouping system and groups numbers by the thousands. The `LAKHS` value uses the Indian numbering system and groups numbers by lakhs and crores."},"symbol":{"$ref":"#/types/aws-native:quicksight:DashboardNumericSeparatorSymbol","description":"Determines the thousands separator symbol."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines the visibility of the thousands separator."}},"type":"object"},"aws-native:quicksight:DashboardTimeBasedForecastProperties":{"properties":{"lowerBoundary":{"type":"number","description":"The lower boundary setup of a forecast computation."},"periodsBackward":{"type":"number","description":"The periods backward setup of a forecast computation."},"periodsForward":{"type":"number","description":"The periods forward setup of a forecast computation."},"predictionInterval":{"type":"number","description":"The prediction interval setup of a forecast computation."},"seasonality":{"type":"number","description":"The seasonality setup of a forecast computation. Choose one of the following options:\n\n- `NULL` : The input is set to `NULL` .\n- `NON_NULL` : The input is set to a custom value."},"upperBoundary":{"type":"number","description":"The upper boundary setup of a forecast computation."}},"type":"object"},"aws-native:quicksight:DashboardTimeEqualityFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the filter is applied to."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"parameterName":{"type":"string","description":"The parameter whose value should be used for the filter value.\n\nThis field is mutually exclusive to `Value` and `RollingDate` ."},"rollingDate":{"$ref":"#/types/aws-native:quicksight:DashboardRollingDateConfiguration","description":"The rolling date input for the `TimeEquality` filter.\n\nThis field is mutually exclusive to `Value` and `ParameterName` ."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:DashboardTimeGranularity","description":"The level of time precision that is used to aggregate `DateTime` values."},"value":{"type":"string","description":"The value of a `TimeEquality` filter.\n\nThis field is mutually exclusive to `RollingDate` and `ParameterName` ."}},"type":"object","required":["column","filterId"]},"aws-native:quicksight:DashboardTimeGranularity":{"type":"string","enum":[{"name":"Year","value":"YEAR"},{"name":"Quarter","value":"QUARTER"},{"name":"Month","value":"MONTH"},{"name":"Week","value":"WEEK"},{"name":"Day","value":"DAY"},{"name":"Hour","value":"HOUR"},{"name":"Minute","value":"MINUTE"},{"name":"Second","value":"SECOND"},{"name":"Millisecond","value":"MILLISECOND"}]},"aws-native:quicksight:DashboardTimeRangeDrillDownFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the filter is applied to."},"rangeMaximum":{"type":"string","description":"The maximum value for the filter value range."},"rangeMinimum":{"type":"string","description":"The minimum value for the filter value range."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:DashboardTimeGranularity","description":"The level of time precision that is used to aggregate `DateTime` values."}},"type":"object","required":["column","rangeMaximum","rangeMinimum","timeGranularity"]},"aws-native:quicksight:DashboardTimeRangeFilter":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the filter is applied to."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"excludePeriodConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardExcludePeriodConfiguration","description":"The exclude period of the time range filter."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"includeMaximum":{"type":"boolean","description":"Determines whether the maximum value in the filter value range should be included in the filtered results."},"includeMinimum":{"type":"boolean","description":"Determines whether the minimum value in the filter value range should be included in the filtered results."},"nullOption":{"$ref":"#/types/aws-native:quicksight:DashboardFilterNullOption","description":"This option determines how null values should be treated when filtering data.\n\n- `ALL_VALUES` : Include null values in filtered results.\n- `NULLS_ONLY` : Only include null values in filtered results.\n- `NON_NULLS_ONLY` : Exclude null values from filtered results."},"rangeMaximumValue":{"$ref":"#/types/aws-native:quicksight:DashboardTimeRangeFilterValue","description":"The maximum value for the filter value range."},"rangeMinimumValue":{"$ref":"#/types/aws-native:quicksight:DashboardTimeRangeFilterValue","description":"The minimum value for the filter value range."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:DashboardTimeGranularity","description":"The level of time precision that is used to aggregate `DateTime` values."}},"type":"object","required":["column","filterId","nullOption"]},"aws-native:quicksight:DashboardTimeRangeFilterValue":{"properties":{"parameter":{"type":"string","description":"The parameter type input value."},"rollingDate":{"$ref":"#/types/aws-native:quicksight:DashboardRollingDateConfiguration","description":"The rolling date input value."},"staticValue":{"type":"string","description":"The static input value."}},"type":"object"},"aws-native:quicksight:DashboardTooltipItem":{"properties":{"columnTooltipItem":{"$ref":"#/types/aws-native:quicksight:DashboardColumnTooltipItem","description":"The tooltip item for the columns that are not part of a field well."},"fieldTooltipItem":{"$ref":"#/types/aws-native:quicksight:DashboardFieldTooltipItem","description":"The tooltip item for the fields."}},"type":"object"},"aws-native:quicksight:DashboardTooltipOptions":{"properties":{"fieldBasedTooltip":{"$ref":"#/types/aws-native:quicksight:DashboardFieldBasedTooltip","description":"The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type."},"selectedTooltipType":{"$ref":"#/types/aws-native:quicksight:DashboardSelectedTooltipType","description":"The selected type for the tooltip. Choose one of the following options:\n\n- `BASIC` : A basic tooltip.\n- `DETAILED` : A detailed tooltip."},"tooltipVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"Determines whether or not the tooltip is visible."}},"type":"object"},"aws-native:quicksight:DashboardTooltipTarget":{"type":"string","enum":[{"name":"Both","value":"BOTH"},{"name":"Bar","value":"BAR"},{"name":"Line","value":"LINE"}]},"aws-native:quicksight:DashboardTooltipTitleType":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"PrimaryValue","value":"PRIMARY_VALUE"}]},"aws-native:quicksight:DashboardTopBottomComputationType":{"type":"string","enum":[{"name":"Top","value":"TOP"},{"name":"Bottom","value":"BOTTOM"}]},"aws-native:quicksight:DashboardTopBottomFilter":{"properties":{"aggregationSortConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardAggregationSortConfiguration"},"description":"The aggregation and sort configuration of the top bottom filter."},"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that the filter is applied to."},"defaultFilterControlConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardDefaultFilterControlConfiguration","description":"The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets."},"filterId":{"type":"string","description":"An identifier that uniquely identifies a filter within a dashboard, analysis, or template."},"limit":{"type":"number","description":"The number of items to include in the top bottom filter results."},"parameterName":{"type":"string","description":"The parameter whose value should be used for the filter value."},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:DashboardTimeGranularity","description":"The level of time precision that is used to aggregate `DateTime` values."}},"type":"object","required":["aggregationSortConfigurations","column","filterId"]},"aws-native:quicksight:DashboardTopBottomMoversComputation":{"properties":{"category":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField","description":"The category field that is used in a computation."},"computationId":{"type":"string","description":"The ID for a computation."},"moverSize":{"type":"number","description":"The mover size setup of the top and bottom movers computation."},"name":{"type":"string","description":"The name of a computation."},"sortOrder":{"$ref":"#/types/aws-native:quicksight:DashboardTopBottomSortOrder","description":"The sort order setup of the top and bottom movers computation."},"time":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField","description":"The time field that is used in a computation."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardTopBottomComputationType","description":"The computation type. Choose from the following options:\n\n- TOP: Top movers computation.\n- BOTTOM: Bottom movers computation."},"value":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId","type"]},"aws-native:quicksight:DashboardTopBottomRankedComputation":{"properties":{"category":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField","description":"The category field that is used in a computation."},"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."},"resultSize":{"type":"number","description":"The result size of a top and bottom ranked computation."},"type":{"$ref":"#/types/aws-native:quicksight:DashboardTopBottomComputationType","description":"The computation type. Choose one of the following options:\n\n- TOP: A top ranked computation.\n- BOTTOM: A bottom ranked computation."},"value":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId","type"]},"aws-native:quicksight:DashboardTopBottomSortOrder":{"type":"string","enum":[{"name":"PercentDifference","value":"PERCENT_DIFFERENCE"},{"name":"AbsoluteDifference","value":"ABSOLUTE_DIFFERENCE"}]},"aws-native:quicksight:DashboardTotalAggregationComputation":{"properties":{"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."},"value":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField","description":"The value field that is used in a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:DashboardTotalAggregationFunction":{"properties":{"simpleTotalAggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardSimpleTotalAggregationFunction","description":"A built in aggregation function for total values."}},"type":"object"},"aws-native:quicksight:DashboardTotalAggregationOption":{"properties":{"fieldId":{"type":"string","description":"The field id that's associated with the total aggregation option."},"totalAggregationFunction":{"$ref":"#/types/aws-native:quicksight:DashboardTotalAggregationFunction","description":"The total aggregation function that you want to set for a specified field id."}},"type":"object","required":["fieldId","totalAggregationFunction"]},"aws-native:quicksight:DashboardTotalOptions":{"properties":{"customLabel":{"type":"string","description":"The custom label string for the total cells."},"placement":{"$ref":"#/types/aws-native:quicksight:DashboardTableTotalsPlacement","description":"The placement (start, end) for the total cells."},"scrollStatus":{"$ref":"#/types/aws-native:quicksight:DashboardTableTotalsScrollStatus","description":"The scroll status (pinned, scrolled) for the total cells."},"totalAggregationOptions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardTotalAggregationOption"},"description":"The total aggregation settings for each value field."},"totalCellStyle":{"$ref":"#/types/aws-native:quicksight:DashboardTableCellStyle","description":"Cell styling options for the total cells."},"totalsVisibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility configuration for the total cells."}},"type":"object"},"aws-native:quicksight:DashboardTransposedColumnType":{"type":"string","enum":[{"name":"RowHeaderColumn","value":"ROW_HEADER_COLUMN"},{"name":"ValueColumn","value":"VALUE_COLUMN"}]},"aws-native:quicksight:DashboardTransposedTableOption":{"properties":{"columnIndex":{"type":"number","description":"The index of a columns in a transposed table. The index range is 0-9999."},"columnType":{"$ref":"#/types/aws-native:quicksight:DashboardTransposedColumnType","description":"The column type of the column in a transposed table. Choose one of the following options:\n\n- `ROW_HEADER_COLUMN` : Refers to the leftmost column of the row header in the transposed table.\n- `VALUE_COLUMN` : Refers to all value columns in the transposed table."},"columnWidth":{"type":"string","description":"String based length that is composed of value and unit in px"}},"type":"object","required":["columnType"]},"aws-native:quicksight:DashboardTreeMapAggregatedFieldWells":{"properties":{"colors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The color field well of a tree map. Values are grouped by aggregations based on group by fields."},"groups":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The group by field well of a tree map. Values are grouped based on group by fields."},"sizes":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The size field well of a tree map. Values are aggregated based on group by fields."}},"type":"object"},"aws-native:quicksight:DashboardTreeMapConfiguration":{"properties":{"colorLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility) for the colors displayed in a tree map."},"colorScale":{"$ref":"#/types/aws-native:quicksight:DashboardColorScale","description":"The color options (gradient color, point of divergence) of a tree map."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOptions","description":"The options that determine if visual data labels are displayed."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardTreeMapFieldWells","description":"The field wells of the visual."},"groupLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility) of the groups that are displayed in a tree map."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions","description":"The legend display setup of the visual."},"sizeLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility) of the sizes that are displayed in a tree map."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardTreeMapSortConfiguration","description":"The sort configuration of a tree map."},"tooltip":{"$ref":"#/types/aws-native:quicksight:DashboardTooltipOptions","description":"The tooltip display setup of the visual."}},"type":"object"},"aws-native:quicksight:DashboardTreeMapFieldWells":{"properties":{"treeMapAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardTreeMapAggregatedFieldWells","description":"The aggregated field wells of a tree map."}},"type":"object"},"aws-native:quicksight:DashboardTreeMapSortConfiguration":{"properties":{"treeMapGroupItemsLimitConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of groups that are displayed."},"treeMapSort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of group by fields."}},"type":"object"},"aws-native:quicksight:DashboardTreeMapVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardTreeMapConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardTrendArrowOptions":{"properties":{"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the trend arrows."}},"type":"object"},"aws-native:quicksight:DashboardUiState":{"type":"string","enum":[{"name":"Expanded","value":"EXPANDED"},{"name":"Collapsed","value":"COLLAPSED"}]},"aws-native:quicksight:DashboardUnaggregatedField":{"properties":{"column":{"$ref":"#/types/aws-native:quicksight:DashboardColumnIdentifier","description":"The column that is used in the `UnaggregatedField` ."},"fieldId":{"type":"string","description":"The custom field ID."},"formatConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardFormatConfiguration","description":"The format configuration of the field."}},"type":"object","required":["column","fieldId"]},"aws-native:quicksight:DashboardUniqueValuesComputation":{"properties":{"category":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField","description":"The category field that is used in a computation."},"computationId":{"type":"string","description":"The ID for a computation."},"name":{"type":"string","description":"The name of a computation."}},"type":"object","required":["computationId"]},"aws-native:quicksight:DashboardUrlTargetConfiguration":{"type":"string","enum":[{"name":"NewTab","value":"NEW_TAB"},{"name":"NewWindow","value":"NEW_WINDOW"},{"name":"SameTab","value":"SAME_TAB"}]},"aws-native:quicksight:DashboardValidationStrategy":{"description":"\u003cp\u003eThe option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to \u003ccode\u003eLENIENT\u003c/code\u003e, validation is skipped for specific errors.\u003c/p\u003e","properties":{"mode":{"$ref":"#/types/aws-native:quicksight:DashboardValidationStrategyMode","description":"The mode of validation for the asset to be created or updated. When you set this value to `STRICT` , strict validation for every error is enforced. When you set this value to `LENIENT` , validation is skipped for specific UI errors."}},"type":"object","required":["mode"]},"aws-native:quicksight:DashboardValidationStrategyMode":{"type":"string","enum":[{"name":"Strict","value":"STRICT"},{"name":"Lenient","value":"LENIENT"}]},"aws-native:quicksight:DashboardValueWhenUnsetOption":{"type":"string","enum":[{"name":"RecommendedValue","value":"RECOMMENDED_VALUE"},{"name":"Null","value":"NULL"}]},"aws-native:quicksight:DashboardVersion":{"description":"\u003cp\u003eDashboard version.\u003c/p\u003e","properties":{"arn":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) of the resource.\u003c/p\u003e"},"createdTime":{"type":"string","description":"\u003cp\u003eThe time that this dashboard version was created.\u003c/p\u003e"},"dataSetArns":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eThe Amazon Resource Numbers (ARNs) for the datasets that are associated with this\n            version of the dashboard.\u003c/p\u003e"},"description":{"type":"string","description":"\u003cp\u003eDescription.\u003c/p\u003e"},"errors":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardError"},"description":"\u003cp\u003eErrors associated with this dashboard version.\u003c/p\u003e"},"sheets":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardSheet"},"description":"\u003cp\u003eA list of the associated sheets with the unique identifier and name of each sheet.\u003c/p\u003e"},"sourceEntityArn":{"type":"string","description":"\u003cp\u003eSource entity ARN.\u003c/p\u003e"},"status":{"$ref":"#/types/aws-native:quicksight:DashboardResourceStatus","description":"The HTTP status of the request."},"themeArn":{"type":"string","description":"\u003cp\u003eThe ARN of the theme associated with a version of the dashboard.\u003c/p\u003e"},"versionNumber":{"type":"number","description":"\u003cp\u003eVersion number for this version of the dashboard.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DashboardVersionDefinition":{"properties":{"analysisDefaults":{"$ref":"#/types/aws-native:quicksight:DashboardAnalysisDefaults"},"calculatedFields":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardCalculatedField"},"description":"An array of calculated field definitions for the dashboard."},"columnConfigurations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnConfiguration"},"description":"An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard."},"dataSetIdentifierDeclarations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDataSetIdentifierDeclaration"},"description":"An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures."},"filterGroups":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFilterGroup"},"description":"The filter definitions for a dashboard.\n\nFor more information, see [Filtering Data in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html) in the *Amazon Quick Suite User Guide* ."},"options":{"$ref":"#/types/aws-native:quicksight:DashboardAssetOptions","description":"An array of option definitions for a dashboard."},"parameterDeclarations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardParameterDeclaration"},"description":"The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.\n\nFor more information, see [Parameters in Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) in the *Amazon Quick Suite User Guide* ."},"sheets":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardSheetDefinition"},"description":"An array of sheet definitions for a dashboard."},"staticFiles":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardStaticFile"},"description":"The static files for the definition."}},"type":"object","required":["dataSetIdentifierDeclarations"]},"aws-native:quicksight:DashboardVerticalTextAlignment":{"type":"string","enum":[{"name":"Top","value":"TOP"},{"name":"Middle","value":"MIDDLE"},{"name":"Bottom","value":"BOTTOM"},{"name":"Auto","value":"AUTO"}]},"aws-native:quicksight:DashboardVisibility":{"type":"string","enum":[{"name":"Hidden","value":"HIDDEN"},{"name":"Visible","value":"VISIBLE"}]},"aws-native:quicksight:DashboardVisibleRangeOptions":{"properties":{"percentRange":{"$ref":"#/types/aws-native:quicksight:DashboardPercentVisibleRange","description":"The percent range in the visible range."}},"type":"object"},"aws-native:quicksight:DashboardVisual":{"properties":{"barChartVisual":{"$ref":"#/types/aws-native:quicksight:DashboardBarChartVisual","description":"A bar chart.\n\nFor more information, see [Using bar charts](https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html) in the *Amazon Quick Suite User Guide* ."},"boxPlotVisual":{"$ref":"#/types/aws-native:quicksight:DashboardBoxPlotVisual","description":"A box plot.\n\nFor more information, see [Using box plots](https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html) in the *Amazon Quick Suite User Guide* ."},"comboChartVisual":{"$ref":"#/types/aws-native:quicksight:DashboardComboChartVisual","description":"A combo chart.\n\nFor more information, see [Using combo charts](https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html) in the *Amazon Quick Suite User Guide* ."},"customContentVisual":{"$ref":"#/types/aws-native:quicksight:DashboardCustomContentVisual","description":"A visual that contains custom content.\n\nFor more information, see [Using custom visual content](https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html) in the *Amazon Quick Suite User Guide* ."},"emptyVisual":{"$ref":"#/types/aws-native:quicksight:DashboardEmptyVisual","description":"An empty visual."},"filledMapVisual":{"$ref":"#/types/aws-native:quicksight:DashboardFilledMapVisual","description":"A filled map.\n\nFor more information, see [Creating filled maps](https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html) in the *Amazon Quick Suite User Guide* ."},"funnelChartVisual":{"$ref":"#/types/aws-native:quicksight:DashboardFunnelChartVisual","description":"A funnel chart.\n\nFor more information, see [Using funnel charts](https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html) in the *Amazon Quick Suite User Guide* ."},"gaugeChartVisual":{"$ref":"#/types/aws-native:quicksight:DashboardGaugeChartVisual","description":"A gauge chart.\n\nFor more information, see [Using gauge charts](https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html) in the *Amazon Quick Suite User Guide* ."},"geospatialMapVisual":{"$ref":"#/types/aws-native:quicksight:DashboardGeospatialMapVisual","description":"A geospatial map or a points on map visual.\n\nFor more information, see [Creating point maps](https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html) in the *Amazon Quick Suite User Guide* ."},"heatMapVisual":{"$ref":"#/types/aws-native:quicksight:DashboardHeatMapVisual","description":"A heat map.\n\nFor more information, see [Using heat maps](https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html) in the *Amazon Quick Suite User Guide* ."},"histogramVisual":{"$ref":"#/types/aws-native:quicksight:DashboardHistogramVisual","description":"A histogram.\n\nFor more information, see [Using histograms](https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html) in the *Amazon Quick Suite User Guide* ."},"insightVisual":{"$ref":"#/types/aws-native:quicksight:DashboardInsightVisual","description":"An insight visual.\n\nFor more information, see [Working with insights](https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html) in the *Amazon Quick Suite User Guide* ."},"kpiVisual":{"$ref":"#/types/aws-native:quicksight:DashboardKpiVisual","description":"A key performance indicator (KPI).\n\nFor more information, see [Using KPIs](https://docs.aws.amazon.com/quicksight/latest/user/kpi.html) in the *Amazon Quick Suite User Guide* ."},"layerMapVisual":{"$ref":"#/types/aws-native:quicksight:DashboardLayerMapVisual","description":"The properties for a layer map visual"},"lineChartVisual":{"$ref":"#/types/aws-native:quicksight:DashboardLineChartVisual","description":"A line chart.\n\nFor more information, see [Using line charts](https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html) in the *Amazon Quick Suite User Guide* ."},"pieChartVisual":{"$ref":"#/types/aws-native:quicksight:DashboardPieChartVisual","description":"A pie or donut chart.\n\nFor more information, see [Using pie charts](https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html) in the *Amazon Quick Suite User Guide* ."},"pivotTableVisual":{"$ref":"#/types/aws-native:quicksight:DashboardPivotTableVisual","description":"A pivot table.\n\nFor more information, see [Using pivot tables](https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html) in the *Amazon Quick Suite User Guide* ."},"pluginVisual":{"$ref":"#/types/aws-native:quicksight:DashboardPluginVisual","description":"The custom plugin visual type."},"radarChartVisual":{"$ref":"#/types/aws-native:quicksight:DashboardRadarChartVisual","description":"A radar chart visual.\n\nFor more information, see [Using radar charts](https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html) in the *Amazon Quick Suite User Guide* ."},"sankeyDiagramVisual":{"$ref":"#/types/aws-native:quicksight:DashboardSankeyDiagramVisual","description":"A sankey diagram.\n\nFor more information, see [Using Sankey diagrams](https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html) in the *Amazon Quick Suite User Guide* ."},"scatterPlotVisual":{"$ref":"#/types/aws-native:quicksight:DashboardScatterPlotVisual","description":"A scatter plot.\n\nFor more information, see [Using scatter plots](https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html) in the *Amazon Quick Suite User Guide* ."},"tableVisual":{"$ref":"#/types/aws-native:quicksight:DashboardTableVisual","description":"A table visual.\n\nFor more information, see [Using tables as visuals](https://docs.aws.amazon.com/quicksight/latest/user/tabular.html) in the *Amazon Quick Suite User Guide* ."},"treeMapVisual":{"$ref":"#/types/aws-native:quicksight:DashboardTreeMapVisual","description":"A tree map.\n\nFor more information, see [Using tree maps](https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html) in the *Amazon Quick Suite User Guide* ."},"waterfallVisual":{"$ref":"#/types/aws-native:quicksight:DashboardWaterfallVisual","description":"A waterfall chart.\n\nFor more information, see [Using waterfall charts](https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html) in the *Amazon Quick Suite User Guide* ."},"wordCloudVisual":{"$ref":"#/types/aws-native:quicksight:DashboardWordCloudVisual","description":"A word cloud.\n\nFor more information, see [Using word clouds](https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html) in the *Amazon Quick Suite User Guide* ."}},"type":"object"},"aws-native:quicksight:DashboardVisualAxisSortOption":{"properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"The availaiblity status of a visual's axis sort options."}},"type":"object"},"aws-native:quicksight:DashboardVisualCustomAction":{"properties":{"actionOperations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomActionOperation"},"description":"A list of `VisualCustomActionOperations` .\n\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined."},"customActionId":{"type":"string","description":"The ID of the `VisualCustomAction` ."},"name":{"type":"string","description":"The name of the `VisualCustomAction` ."},"status":{"$ref":"#/types/aws-native:quicksight:DashboardWidgetStatus","description":"The status of the `VisualCustomAction` ."},"trigger":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomActionTrigger","description":"The trigger of the `VisualCustomAction` .\n\nValid values are defined as follows:\n\n- `DATA_POINT_CLICK` : Initiates a custom action by a left pointer click on a data point.\n- `DATA_POINT_MENU` : Initiates a custom action by right pointer click from the menu."}},"type":"object","required":["actionOperations","customActionId","name","trigger"]},"aws-native:quicksight:DashboardVisualCustomActionOperation":{"properties":{"filterOperation":{"$ref":"#/types/aws-native:quicksight:DashboardCustomActionFilterOperation","description":"The filter operation that filters data included in a visual or in an entire sheet."},"navigationOperation":{"$ref":"#/types/aws-native:quicksight:DashboardCustomActionNavigationOperation","description":"The navigation operation that navigates between different sheets in the same analysis."},"setParametersOperation":{"$ref":"#/types/aws-native:quicksight:DashboardCustomActionSetParametersOperation","description":"The set parameter operation that sets parameters in custom action."},"urlOperation":{"$ref":"#/types/aws-native:quicksight:DashboardCustomActionUrlOperation","description":"The URL operation that opens a link to another webpage."}},"type":"object"},"aws-native:quicksight:DashboardVisualCustomActionTrigger":{"type":"string","enum":[{"name":"DataPointClick","value":"DATA_POINT_CLICK"},{"name":"DataPointMenu","value":"DATA_POINT_MENU"}]},"aws-native:quicksight:DashboardVisualInteractionOptions":{"properties":{"contextMenuOption":{"$ref":"#/types/aws-native:quicksight:DashboardContextMenuOption","description":"The context menu options for a visual."},"visualMenuOption":{"$ref":"#/types/aws-native:quicksight:DashboardVisualMenuOption","description":"The on-visual menu options for a visual."}},"type":"object"},"aws-native:quicksight:DashboardVisualMenuOption":{"properties":{"availabilityStatus":{"$ref":"#/types/aws-native:quicksight:DashboardBehavior","description":"The availaiblity status of a visual's menu options."}},"type":"object"},"aws-native:quicksight:DashboardVisualPalette":{"properties":{"chartColor":{"type":"string","description":"The chart color options for the visual palette."},"colorMap":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDataPathColor"},"description":"The color map options for the visual palette."}},"type":"object"},"aws-native:quicksight:DashboardVisualPublishOptions":{"description":"\u003cp\u003eThe visual publish options of a visual in a dashboard\u003c/p\u003e","properties":{"exportHiddenFieldsOption":{"$ref":"#/types/aws-native:quicksight:DashboardExportHiddenFieldsOption","description":"Determines if hidden fields are included in an exported dashboard."}},"type":"object"},"aws-native:quicksight:DashboardVisualSubtitleLabelOptions":{"properties":{"formatText":{"$ref":"#/types/aws-native:quicksight:DashboardLongFormatText","description":"The long text format of the subtitle label, such as plain text or rich text."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the subtitle label."}},"type":"object"},"aws-native:quicksight:DashboardVisualTitleLabelOptions":{"properties":{"formatText":{"$ref":"#/types/aws-native:quicksight:DashboardShortFormatText","description":"The short text format of the title label, such as plain text or rich text."},"visibility":{"$ref":"#/types/aws-native:quicksight:DashboardVisibility","description":"The visibility of the title label."}},"type":"object"},"aws-native:quicksight:DashboardWaterfallChartAggregatedFieldWells":{"properties":{"breakdowns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The breakdown field wells of a waterfall visual."},"categories":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The category field wells of a waterfall visual."},"values":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The value field wells of a waterfall visual."}},"type":"object"},"aws-native:quicksight:DashboardWaterfallChartColorConfiguration":{"properties":{"groupColorConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardWaterfallChartGroupColorConfiguration","description":"The color configuration for individual groups within a waterfall visual."}},"type":"object"},"aws-native:quicksight:DashboardWaterfallChartConfiguration":{"properties":{"categoryAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The options that determine the presentation of the category axis."},"categoryAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The options that determine the presentation of the category axis label."},"colorConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardWaterfallChartColorConfiguration","description":"The color configuration of a waterfall visual."},"dataLabels":{"$ref":"#/types/aws-native:quicksight:DashboardDataLabelOptions","description":"The data label configuration of a waterfall visual."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardWaterfallChartFieldWells","description":"The field well configuration of a waterfall visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"legend":{"$ref":"#/types/aws-native:quicksight:DashboardLegendOptions","description":"The legend configuration of a waterfall visual."},"primaryYAxisDisplayOptions":{"$ref":"#/types/aws-native:quicksight:DashboardAxisDisplayOptions","description":"The options that determine the presentation of the y-axis."},"primaryYAxisLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The options that determine the presentation of the y-axis label."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardWaterfallChartSortConfiguration","description":"The sort configuration of a waterfall visual."},"visualPalette":{"$ref":"#/types/aws-native:quicksight:DashboardVisualPalette","description":"The visual palette configuration of a waterfall visual."},"waterfallChartOptions":{"$ref":"#/types/aws-native:quicksight:DashboardWaterfallChartOptions","description":"The options that determine the presentation of a waterfall visual."}},"type":"object"},"aws-native:quicksight:DashboardWaterfallChartFieldWells":{"properties":{"waterfallChartAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardWaterfallChartAggregatedFieldWells","description":"The field well configuration of a waterfall visual."}},"type":"object"},"aws-native:quicksight:DashboardWaterfallChartGroupColorConfiguration":{"properties":{"negativeBarColor":{"type":"string","description":"Defines the color for the negative bars of a waterfall chart."},"positiveBarColor":{"type":"string","description":"Defines the color for the positive bars of a waterfall chart."},"totalBarColor":{"type":"string","description":"Defines the color for the total bars of a waterfall chart."}},"type":"object"},"aws-native:quicksight:DashboardWaterfallChartOptions":{"properties":{"totalBarLabel":{"type":"string","description":"This option determines the total bar label of a waterfall visual."}},"type":"object"},"aws-native:quicksight:DashboardWaterfallChartSortConfiguration":{"properties":{"breakdownItemsLimit":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of bar groups that are displayed."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of the category fields."}},"type":"object"},"aws-native:quicksight:DashboardWaterfallVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardWaterfallChartConfiguration","description":"The configuration for a waterfall visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardWhatIfPointScenario":{"properties":{"date":{"type":"string","description":"The date that you need the forecast results for."},"value":{"type":"number","description":"The target value that you want to meet for the provided date."}},"type":"object","required":["date","value"]},"aws-native:quicksight:DashboardWhatIfRangeScenario":{"properties":{"endDate":{"type":"string","description":"The end date in the date range that you need the forecast results for."},"startDate":{"type":"string","description":"The start date in the date range that you need the forecast results for."},"value":{"type":"number","description":"The target value that you want to meet for the provided date range."}},"type":"object","required":["endDate","startDate","value"]},"aws-native:quicksight:DashboardWidgetStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:DashboardWordCloudAggregatedFieldWells":{"properties":{"groupBy":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardDimensionField"},"description":"The group by field well of a word cloud. Values are grouped by group by fields."},"size":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardMeasureField"},"description":"The size field well of a word cloud. Values are aggregated based on group by fields."}},"type":"object"},"aws-native:quicksight:DashboardWordCloudChartConfiguration":{"properties":{"categoryLabelOptions":{"$ref":"#/types/aws-native:quicksight:DashboardChartAxisLabelOptions","description":"The label options (label text, label visibility, and sort icon visibility) for the word cloud category."},"fieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardWordCloudFieldWells","description":"The field wells of the visual."},"interactions":{"$ref":"#/types/aws-native:quicksight:DashboardVisualInteractionOptions","description":"The general visual interactions setup for a visual."},"sortConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardWordCloudSortConfiguration","description":"The sort configuration of a word cloud visual."},"wordCloudOptions":{"$ref":"#/types/aws-native:quicksight:DashboardWordCloudOptions","description":"The options for a word cloud visual."}},"type":"object"},"aws-native:quicksight:DashboardWordCloudCloudLayout":{"type":"string","enum":[{"name":"Fluid","value":"FLUID"},{"name":"Normal","value":"NORMAL"}]},"aws-native:quicksight:DashboardWordCloudFieldWells":{"properties":{"wordCloudAggregatedFieldWells":{"$ref":"#/types/aws-native:quicksight:DashboardWordCloudAggregatedFieldWells","description":"The aggregated field wells of a word cloud."}},"type":"object"},"aws-native:quicksight:DashboardWordCloudOptions":{"properties":{"cloudLayout":{"$ref":"#/types/aws-native:quicksight:DashboardWordCloudCloudLayout","description":"The cloud layout options (fluid, normal) of a word cloud."},"maximumStringLength":{"type":"number","description":"The length limit of each word from 1-100."},"wordCasing":{"$ref":"#/types/aws-native:quicksight:DashboardWordCloudWordCasing","description":"The word casing options (lower_case, existing_case) for the words in a word cloud."},"wordOrientation":{"$ref":"#/types/aws-native:quicksight:DashboardWordCloudWordOrientation","description":"The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud."},"wordPadding":{"$ref":"#/types/aws-native:quicksight:DashboardWordCloudWordPadding","description":"The word padding options (none, small, medium, large) for the words in a word cloud."},"wordScaling":{"$ref":"#/types/aws-native:quicksight:DashboardWordCloudWordScaling","description":"The word scaling options (emphasize, normal) for the words in a word cloud."}},"type":"object"},"aws-native:quicksight:DashboardWordCloudSortConfiguration":{"properties":{"categoryItemsLimit":{"$ref":"#/types/aws-native:quicksight:DashboardItemsLimitConfiguration","description":"The limit on the number of groups that are displayed in a word cloud."},"categorySort":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardFieldSortOptions"},"description":"The sort configuration of group by fields."}},"type":"object"},"aws-native:quicksight:DashboardWordCloudVisual":{"properties":{"actions":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardVisualCustomAction"},"description":"The list of custom actions that are configured for a visual."},"chartConfiguration":{"$ref":"#/types/aws-native:quicksight:DashboardWordCloudChartConfiguration","description":"The configuration settings of the visual."},"columnHierarchies":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DashboardColumnHierarchy"},"description":"The column hierarchy that is used during drill-downs and drill-ups."},"subtitle":{"$ref":"#/types/aws-native:quicksight:DashboardVisualSubtitleLabelOptions","description":"The subtitle that is displayed on the visual."},"title":{"$ref":"#/types/aws-native:quicksight:DashboardVisualTitleLabelOptions","description":"The title that is displayed on the visual."},"visualContentAltText":{"type":"string","description":"The alt text for the visual."},"visualId":{"type":"string","description":"The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.."}},"type":"object","required":["visualId"]},"aws-native:quicksight:DashboardWordCloudWordCasing":{"type":"string","enum":[{"name":"LowerCase","value":"LOWER_CASE"},{"name":"ExistingCase","value":"EXISTING_CASE"}]},"aws-native:quicksight:DashboardWordCloudWordOrientation":{"type":"string","enum":[{"name":"Horizontal","value":"HORIZONTAL"},{"name":"HorizontalAndVertical","value":"HORIZONTAL_AND_VERTICAL"}]},"aws-native:quicksight:DashboardWordCloudWordPadding":{"type":"string","enum":[{"name":"None","value":"NONE"},{"name":"Small","value":"SMALL"},{"name":"Medium","value":"MEDIUM"},{"name":"Large","value":"LARGE"}]},"aws-native:quicksight:DashboardWordCloudWordScaling":{"type":"string","enum":[{"name":"Emphasize","value":"EMPHASIZE"},{"name":"Normal","value":"NORMAL"}]},"aws-native:quicksight:DashboardYAxisOptions":{"properties":{"yAxis":{"$ref":"#/types/aws-native:quicksight:DashboardSingleYAxisOption","description":"The Y axis type to be used in the chart.\n\nIf you choose `PRIMARY_Y_AXIS` , the primary Y Axis is located on the leftmost vertical axis of the chart."}},"type":"object","required":["yAxis"]},"aws-native:quicksight:DataSetAggregateOperation":{"properties":{"aggregations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetAggregation"},"description":"The list of aggregation functions to apply to the grouped data, such as `SUM` , `COUNT` , or `AVERAGE` ."},"alias":{"type":"string","description":"Alias for this operation."},"groupByColumnNames":{"type":"array","items":{"type":"string"},"description":"The list of column names to group by when performing the aggregation. Rows with the same values in these columns will be grouped together."},"source":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperationSource","description":"The source transform operation that provides input data for the aggregation."}},"type":"object","required":["aggregations","alias","source"]},"aws-native:quicksight:DataSetAggregation":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:DataSetDataPrepAggregationFunction","description":"The aggregation function to apply, such as `SUM` , `COUNT` , `AVERAGE` , `MIN` , `MAX`"},"newColumnId":{"type":"string","description":"A unique identifier for the new column that will contain the aggregated values."},"newColumnName":{"type":"string","description":"The name for the new column that will contain the aggregated values."}},"type":"object","required":["aggregationFunction","newColumnId","newColumnName"]},"aws-native:quicksight:DataSetAppendOperation":{"properties":{"alias":{"type":"string","description":"Alias for this operation."},"appendedColumns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetAppendedColumn"},"description":"The list of columns to include in the appended result, mapping columns from both sources."},"firstSource":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperationSource","description":"The first data source to be included in the append operation."},"secondSource":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperationSource","description":"The second data source to be appended to the first source."}},"type":"object","required":["alias","appendedColumns"]},"aws-native:quicksight:DataSetAppendedColumn":{"properties":{"columnName":{"type":"string","description":"The name of the column to include in the appended result."},"newColumnId":{"type":"string","description":"A unique identifier for the column in the appended result."}},"type":"object","required":["columnName","newColumnId"]},"aws-native:quicksight:DataSetCalculatedColumn":{"description":"\u003cp\u003eA calculated column for a dataset.\u003c/p\u003e","properties":{"columnId":{"type":"string","description":"\u003cp\u003eA unique ID to identify a calculated column. During a dataset update, if the column ID\n            of a calculated column matches that of an existing calculated column, Amazon Quick Suite\n            preserves the existing calculated column.\u003c/p\u003e"},"columnName":{"type":"string","description":"\u003cp\u003eColumn name.\u003c/p\u003e"},"expression":{"type":"string","description":"\u003cp\u003eAn expression that defines the calculated column.\u003c/p\u003e"}},"type":"object","required":["columnId","columnName","expression"]},"aws-native:quicksight:DataSetCastColumnTypeOperation":{"description":"\u003cp\u003eA transform operation that casts a column to a different type.\u003c/p\u003e","properties":{"columnName":{"type":"string","description":"\u003cp\u003eColumn name.\u003c/p\u003e"},"format":{"type":"string","description":"\u003cp\u003eWhen casting a column from string to datetime type, you can supply a string in a\n            format supported by Amazon Quick Suite to denote the source data format.\u003c/p\u003e"},"newColumnType":{"$ref":"#/types/aws-native:quicksight:DataSetColumnDataType","description":"New column data type."},"subType":{"$ref":"#/types/aws-native:quicksight:DataSetColumnDataSubType","description":"The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset."}},"type":"object","required":["columnName","newColumnType"]},"aws-native:quicksight:DataSetCastColumnTypesOperation":{"properties":{"alias":{"type":"string","description":"Alias for this operation."},"castColumnTypeOperations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetCastColumnTypeOperation"},"description":"The list of column type casting operations to perform."},"source":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperationSource","description":"The source transform operation that provides input data for the type casting."}},"type":"object","required":["alias","castColumnTypeOperations","source"]},"aws-native:quicksight:DataSetColumnDataSubType":{"type":"string","enum":[{"name":"Float","value":"FLOAT"},{"name":"Fixed","value":"FIXED"}]},"aws-native:quicksight:DataSetColumnDataType":{"type":"string","enum":[{"name":"String","value":"STRING"},{"name":"Integer","value":"INTEGER"},{"name":"Decimal","value":"DECIMAL"},{"name":"Datetime","value":"DATETIME"}]},"aws-native:quicksight:DataSetColumnDescription":{"description":"\u003cp\u003eMetadata that contains a description for a column.\u003c/p\u003e","properties":{"text":{"type":"string","description":"\u003cp\u003eThe text of a description for a column.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSetColumnGroup":{"description":"\u003cp\u003eGroupings of columns that work together in certain Amazon Quick Suite features. This is\n            a variant type structure. For this structure to be valid, only one of the attributes can\n            be non-null.\u003c/p\u003e","properties":{"geoSpatialColumnGroup":{"$ref":"#/types/aws-native:quicksight:DataSetGeoSpatialColumnGroup","description":"Geospatial column group that denotes a hierarchy."}},"type":"object"},"aws-native:quicksight:DataSetColumnIdMapping":{"properties":{"sourceColumnId":{"type":"string"},"targetColumnId":{"type":"string"}},"type":"object","required":["sourceColumnId","targetColumnId"]},"aws-native:quicksight:DataSetColumnLevelPermissionRule":{"description":"\u003cp\u003eA rule defined to grant access on one or more restricted columns.\n            Each dataset can have multiple rules.\n            To create a restricted column, you add it to one or more rules.\n            Each rule must contain at least one column and at least one user or group.\n            To be able to see a restricted column, a user or group needs to be added\n            to a rule for that column.\u003c/p\u003e","properties":{"columnNames":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eAn array of column names.\u003c/p\u003e"},"principals":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eAn array of Amazon Resource Names (ARNs) for Quick Suite users or groups.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSetColumnTag":{"description":"\u003cp\u003eA tag for a column in a\n            \u003ccode\u003e\n               \u003ca href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html\"\u003eTagColumnOperation\u003c/a\u003e\n            \u003c/code\u003e\n            structure. This is a\n            variant type structure. For this structure to be valid, only one of the attributes can\n            be non-null.\u003c/p\u003e","properties":{"columnDescription":{"$ref":"#/types/aws-native:quicksight:DataSetColumnDescription","description":"A description for a column."},"columnGeographicRole":{"$ref":"#/types/aws-native:quicksight:DataSetGeoSpatialDataRole","description":"A geospatial role for a column."}},"type":"object"},"aws-native:quicksight:DataSetColumnTagName":{"type":"string","enum":[{"name":"ColumnGeographicRole","value":"COLUMN_GEOGRAPHIC_ROLE"},{"name":"ColumnDescription","value":"COLUMN_DESCRIPTION"}]},"aws-native:quicksight:DataSetColumnToUnpivot":{"properties":{"columnName":{"type":"string","description":"The name of the column to unpivot from the source data."},"newValue":{"type":"string","description":"The value to assign to this column in the unpivoted result, typically the column name or a descriptive label."}},"type":"object"},"aws-native:quicksight:DataSetCreateColumnsOperation":{"description":"\u003cp\u003eA transform operation that creates calculated columns. Columns created in one such\n            operation form a lexical closure.\u003c/p\u003e","properties":{"alias":{"type":"string","description":"Alias for this operation."},"columns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetCalculatedColumn"},"description":"\u003cp\u003eCalculated columns to create.\u003c/p\u003e"},"source":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperationSource","description":"The source transform operation that provides input data for creating new calculated columns."}},"type":"object","required":["columns"]},"aws-native:quicksight:DataSetCustomSql":{"description":"\u003cp\u003eA physical table type built from the results of the custom SQL query.\u003c/p\u003e","properties":{"columns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetInputColumn"},"description":"\u003cp\u003eThe column schema from the SQL query result set.\u003c/p\u003e"},"dataSourceArn":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) of the data source.\u003c/p\u003e"},"name":{"type":"string","description":"\u003cp\u003eA display name for the SQL query result.\u003c/p\u003e"},"sqlQuery":{"type":"string","description":"\u003cp\u003eThe SQL query.\u003c/p\u003e"}},"type":"object","required":["columns","dataSourceArn","name","sqlQuery"]},"aws-native:quicksight:DataSetDataPrepAggregationFunction":{"properties":{"listAggregation":{"$ref":"#/types/aws-native:quicksight:DataSetDataPrepListAggregationFunction","description":"A list aggregation function that concatenates values from multiple rows into a single delimited string."},"percentileAggregation":{"$ref":"#/types/aws-native:quicksight:DataSetDataPrepPercentileAggregationFunction"},"simpleAggregation":{"$ref":"#/types/aws-native:quicksight:DataSetDataPrepSimpleAggregationFunction","description":"A simple aggregation function such as `SUM` , `COUNT` , `AVERAGE` , `MIN` , `MAX` , `MEDIAN` , `VARIANCE` , or `STANDARD_DEVIATION` ."}},"type":"object"},"aws-native:quicksight:DataSetDataPrepConfiguration":{"properties":{"destinationTableMap":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:quicksight:DataSetDestinationTable"},"description":"A map of destination tables that receive the final prepared data."},"sourceTableMap":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:quicksight:DataSetSourceTable"},"description":"A map of source tables that provide information about underlying sources."},"transformStepMap":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:quicksight:DataSetTransformStep"},"description":"A map of transformation steps that process the data."}},"type":"object","required":["destinationTableMap","sourceTableMap","transformStepMap"]},"aws-native:quicksight:DataSetDataPrepListAggregationFunction":{"properties":{"distinct":{"type":"boolean","description":"Whether to include only distinct values in the concatenated result, removing duplicates."},"inputColumnName":{"type":"string","description":"The name of the column containing values to be concatenated."},"separator":{"type":"string","description":"The string used to separate values in the concatenated result."}},"type":"object","required":["distinct","separator"]},"aws-native:quicksight:DataSetDataPrepPercentileAggregationFunction":{"properties":{"inputColumnName":{"type":"string"},"percentileValue":{"type":"number"}},"type":"object","required":["percentileValue"]},"aws-native:quicksight:DataSetDataPrepSimpleAggregationFunction":{"properties":{"functionType":{"$ref":"#/types/aws-native:quicksight:DataSetDataPrepSimpleAggregationFunctionType","description":"The type of aggregation function to perform, such as `COUNT` , `SUM` , `AVERAGE` , `MIN` , `MAX` , `MEDIAN` , `VARIANCE` , or `STANDARD_DEVIATION` ."},"inputColumnName":{"type":"string","description":"The name of the column on which to perform the aggregation function."}},"type":"object","required":["functionType"]},"aws-native:quicksight:DataSetDataPrepSimpleAggregationFunctionType":{"type":"string","enum":[{"name":"Count","value":"COUNT"},{"name":"DistinctCount","value":"DISTINCT_COUNT"},{"name":"Sum","value":"SUM"},{"name":"Average","value":"AVERAGE"},{"name":"Median","value":"MEDIAN"},{"name":"Max","value":"MAX"},{"name":"Min","value":"MIN"},{"name":"Variance","value":"VARIANCE"},{"name":"StandardDeviation","value":"STANDARD_DEVIATION"}]},"aws-native:quicksight:DataSetDatasetParameter":{"description":"\u003cp\u003eA dataset parameter.\u003c/p\u003e","properties":{"dateTimeDatasetParameter":{"$ref":"#/types/aws-native:quicksight:DataSetDateTimeDatasetParameter","description":"A date time parameter that is created in the dataset."},"decimalDatasetParameter":{"$ref":"#/types/aws-native:quicksight:DataSetDecimalDatasetParameter","description":"A decimal parameter that is created in the dataset."},"integerDatasetParameter":{"$ref":"#/types/aws-native:quicksight:DataSetIntegerDatasetParameter","description":"An integer parameter that is created in the dataset."},"stringDatasetParameter":{"$ref":"#/types/aws-native:quicksight:DataSetStringDatasetParameter","description":"A string parameter that is created in the dataset."}},"type":"object"},"aws-native:quicksight:DataSetDatasetParameterValueType":{"type":"string","enum":[{"name":"MultiValued","value":"MULTI_VALUED"},{"name":"SingleValued","value":"SINGLE_VALUED"}]},"aws-native:quicksight:DataSetDateComparisonFilterCondition":{"properties":{"operator":{"$ref":"#/types/aws-native:quicksight:DataSetDateComparisonFilterOperator","description":"The comparison operator to use, such as `BEFORE` , `BEFORE_OR_EQUALS_TO` , `AFTER` , or `AFTER_OR_EQUALS_TO` ."},"value":{"$ref":"#/types/aws-native:quicksight:DataSetDateFilterValue","description":"The date value to compare against."}},"type":"object","required":["operator"]},"aws-native:quicksight:DataSetDateComparisonFilterOperator":{"type":"string","enum":[{"name":"Before","value":"BEFORE"},{"name":"BeforeOrEqualsTo","value":"BEFORE_OR_EQUALS_TO"},{"name":"After","value":"AFTER"},{"name":"AfterOrEqualsTo","value":"AFTER_OR_EQUALS_TO"}]},"aws-native:quicksight:DataSetDateFilterCondition":{"properties":{"columnName":{"type":"string","description":"The name of the date column to filter."},"comparisonFilterCondition":{"$ref":"#/types/aws-native:quicksight:DataSetDateComparisonFilterCondition","description":"A comparison-based filter condition for the date column."},"rangeFilterCondition":{"$ref":"#/types/aws-native:quicksight:DataSetDateRangeFilterCondition","description":"A range-based filter condition for the date column, filtering values between minimum and maximum dates."}},"type":"object"},"aws-native:quicksight:DataSetDateFilterValue":{"properties":{"staticValue":{"type":"string","description":"A static date value used for filtering."}},"type":"object"},"aws-native:quicksight:DataSetDateRangeFilterCondition":{"properties":{"includeMaximum":{"type":"boolean","description":"Whether to include the maximum value in the filter range."},"includeMinimum":{"type":"boolean","description":"Whether to include the minimum value in the filter range."},"rangeMaximum":{"$ref":"#/types/aws-native:quicksight:DataSetDateFilterValue","description":"The maximum date value for the range filter."},"rangeMinimum":{"$ref":"#/types/aws-native:quicksight:DataSetDateFilterValue","description":"The minimum date value for the range filter."}},"type":"object"},"aws-native:quicksight:DataSetDateTimeDatasetParameter":{"description":"\u003cp\u003eA date time parameter for a dataset.\u003c/p\u003e","properties":{"defaultValues":{"$ref":"#/types/aws-native:quicksight:DataSetDateTimeDatasetParameterDefaultValues","description":"A list of default values for a given date time parameter. This structure only accepts static values."},"id":{"type":"string","description":"\u003cp\u003eAn identifier for the parameter that is created in the dataset.\u003c/p\u003e"},"name":{"type":"string","description":"\u003cp\u003eThe name of the date time parameter that is created in the dataset.\u003c/p\u003e"},"timeGranularity":{"$ref":"#/types/aws-native:quicksight:DataSetTimeGranularity","description":"The time granularity of the date time parameter."},"valueType":{"$ref":"#/types/aws-native:quicksight:DataSetDatasetParameterValueType","description":"The value type of the dataset parameter. Valid values are `single value` or `multi value` ."}},"type":"object","required":["id","name","valueType"]},"aws-native:quicksight:DataSetDateTimeDatasetParameterDefaultValues":{"description":"\u003cp\u003eThe default values of a date time parameter.\u003c/p\u003e","properties":{"staticValues":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eA list of static default values for a given date time parameter.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSetDecimalDatasetParameter":{"description":"\u003cp\u003eA decimal parameter for a dataset.\u003c/p\u003e","properties":{"defaultValues":{"$ref":"#/types/aws-native:quicksight:DataSetDecimalDatasetParameterDefaultValues","description":"A list of default values for a given decimal parameter. This structure only accepts static values."},"id":{"type":"string","description":"\u003cp\u003eAn identifier for the decimal parameter created in the dataset.\u003c/p\u003e"},"name":{"type":"string","description":"\u003cp\u003eThe name of the decimal parameter that is created in the dataset.\u003c/p\u003e"},"valueType":{"$ref":"#/types/aws-native:quicksight:DataSetDatasetParameterValueType","description":"The value type of the dataset parameter. Valid values are `single value` or `multi value` ."}},"type":"object","required":["id","name","valueType"]},"aws-native:quicksight:DataSetDecimalDatasetParameterDefaultValues":{"description":"\u003cp\u003eThe default values of a decimal parameter.\u003c/p\u003e","properties":{"staticValues":{"type":"array","items":{"type":"number"},"description":"\u003cp\u003eA list of static default values for a given decimal parameter.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSetDestinationTable":{"properties":{"alias":{"type":"string","description":"Alias for the destination table."},"source":{"$ref":"#/types/aws-native:quicksight:DataSetDestinationTableSource","description":"The source configuration that specifies which transform operation provides data to this destination table."}},"type":"object","required":["alias","source"]},"aws-native:quicksight:DataSetDestinationTableSource":{"properties":{"transformOperationId":{"type":"string","description":"The identifier of the transform operation that provides data to the destination table."}},"type":"object","required":["transformOperationId"]},"aws-native:quicksight:DataSetFieldFolder":{"description":"\u003cp\u003eA FieldFolder element is a folder that contains fields and nested subfolders.\u003c/p\u003e","properties":{"columns":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eA folder has a list of columns. A column can only be in one folder.\u003c/p\u003e"},"description":{"type":"string","description":"\u003cp\u003eThe description for a field folder.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSetFileFormat":{"type":"string","enum":[{"name":"Csv","value":"CSV"},{"name":"Tsv","value":"TSV"},{"name":"Clf","value":"CLF"},{"name":"Elf","value":"ELF"},{"name":"Xlsx","value":"XLSX"},{"name":"Json","value":"JSON"}]},"aws-native:quicksight:DataSetFilterOperation":{"description":"\u003cp\u003eA transform operation that filters rows based on a condition.\u003c/p\u003e","properties":{"conditionExpression":{"type":"string","description":"\u003cp\u003eAn expression that must evaluate to a Boolean value. Rows for which the expression\n            evaluates to true are kept in the dataset.\u003c/p\u003e"},"dateFilterCondition":{"$ref":"#/types/aws-native:quicksight:DataSetDateFilterCondition","description":"A date-based filter condition within a filter operation."},"numericFilterCondition":{"$ref":"#/types/aws-native:quicksight:DataSetNumericFilterCondition","description":"A numeric-based filter condition within a filter operation."},"stringFilterCondition":{"$ref":"#/types/aws-native:quicksight:DataSetStringFilterCondition","description":"A string-based filter condition within a filter operation."}},"type":"object"},"aws-native:quicksight:DataSetFiltersOperation":{"properties":{"alias":{"type":"string","description":"Alias for this operation."},"filterOperations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetFilterOperation"},"description":"The list of filter operations to apply."},"source":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperationSource","description":"The source transform operation that provides input data for filtering."}},"type":"object","required":["alias","filterOperations","source"]},"aws-native:quicksight:DataSetGeoSpatialColumnGroup":{"description":"\u003cp\u003eGeospatial column group that denotes a hierarchy.\u003c/p\u003e","properties":{"columns":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eColumns in this hierarchy.\u003c/p\u003e"},"countryCode":{"$ref":"#/types/aws-native:quicksight:DataSetGeoSpatialCountryCode","description":"Country code."},"name":{"type":"string","description":"\u003cp\u003eA display name for the hierarchy.\u003c/p\u003e"}},"type":"object","required":["columns","name"]},"aws-native:quicksight:DataSetGeoSpatialCountryCode":{"type":"string","enum":[{"name":"Us","value":"US"}]},"aws-native:quicksight:DataSetGeoSpatialDataRole":{"type":"string","enum":[{"name":"Country","value":"COUNTRY"},{"name":"State","value":"STATE"},{"name":"County","value":"COUNTY"},{"name":"City","value":"CITY"},{"name":"Postcode","value":"POSTCODE"},{"name":"Longitude","value":"LONGITUDE"},{"name":"Latitude","value":"LATITUDE"},{"name":"Political1","value":"POLITICAL1"},{"name":"CensusTract","value":"CENSUS_TRACT"},{"name":"CensusBlockGroup","value":"CENSUS_BLOCK_GROUP"},{"name":"CensusBlock","value":"CENSUS_BLOCK"}]},"aws-native:quicksight:DataSetImportMode":{"type":"string","enum":[{"name":"Spice","value":"SPICE"},{"name":"DirectQuery","value":"DIRECT_QUERY"}]},"aws-native:quicksight:DataSetImportTableOperation":{"properties":{"alias":{"type":"string","description":"Alias for this operation."},"source":{"$ref":"#/types/aws-native:quicksight:DataSetImportTableOperationSource","description":"The source configuration that specifies which source table to import and any column mappings."}},"type":"object","required":["alias","source"]},"aws-native:quicksight:DataSetImportTableOperationSource":{"properties":{"columnIdMappings":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetColumnIdMapping"},"description":"The mappings between source column identifiers and target column identifiers during the import."},"sourceTableId":{"type":"string","description":"The identifier of the source table to import data from."}},"type":"object","required":["sourceTableId"]},"aws-native:quicksight:DataSetIncrementalRefresh":{"description":"\u003cp\u003eThe incremental refresh configuration for a dataset.\u003c/p\u003e","properties":{"lookbackWindow":{"$ref":"#/types/aws-native:quicksight:DataSetLookbackWindow","description":"The lookback window setup for an incremental refresh configuration."}},"type":"object","required":["lookbackWindow"]},"aws-native:quicksight:DataSetIngestionWaitPolicy":{"description":"\u003cp\u003eWait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.\u003c/p\u003e","properties":{"ingestionWaitTimeInHours":{"type":"number","description":"\u003cp\u003eThe maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours.\n Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.\u003c/p\u003e"},"waitForSpiceIngestion":{"type":"boolean","description":"\u003cp\u003eWait for SPICE ingestion to finish to mark dataset creation/update successful. Default (true).\n  Applicable only when DataSetImportMode mode is set to SPICE.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSetInputColumn":{"description":"\u003cp\u003eMetadata for a column that is used as the input of a transform operation.\u003c/p\u003e","properties":{"id":{"type":"string","description":"A unique identifier for the input column."},"name":{"type":"string","description":"\u003cp\u003eThe name of this column in the underlying data source.\u003c/p\u003e"},"subType":{"$ref":"#/types/aws-native:quicksight:DataSetColumnDataSubType","description":"The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset."},"type":{"$ref":"#/types/aws-native:quicksight:DataSetInputColumnDataType","description":"The data type of the column."}},"type":"object","required":["name","type"]},"aws-native:quicksight:DataSetInputColumnDataType":{"type":"string","enum":[{"name":"String","value":"STRING"},{"name":"Integer","value":"INTEGER"},{"name":"Decimal","value":"DECIMAL"},{"name":"Datetime","value":"DATETIME"},{"name":"Bit","value":"BIT"},{"name":"Boolean","value":"BOOLEAN"},{"name":"Json","value":"JSON"},{"name":"Semistruct","value":"SEMISTRUCT"}]},"aws-native:quicksight:DataSetIntegerDatasetParameter":{"description":"\u003cp\u003eAn integer parameter for a dataset.\u003c/p\u003e","properties":{"defaultValues":{"$ref":"#/types/aws-native:quicksight:DataSetIntegerDatasetParameterDefaultValues","description":"A list of default values for a given integer parameter. This structure only accepts static values."},"id":{"type":"string","description":"\u003cp\u003eAn identifier for the integer parameter created in the dataset.\u003c/p\u003e"},"name":{"type":"string","description":"\u003cp\u003eThe name of the integer parameter that is created in the dataset.\u003c/p\u003e"},"valueType":{"$ref":"#/types/aws-native:quicksight:DataSetDatasetParameterValueType","description":"The value type of the dataset parameter. Valid values are `single value` or `multi value` ."}},"type":"object","required":["id","name","valueType"]},"aws-native:quicksight:DataSetIntegerDatasetParameterDefaultValues":{"description":"\u003cp\u003eThe default values of an integer parameter.\u003c/p\u003e","properties":{"staticValues":{"type":"array","items":{"type":"integer"},"description":"\u003cp\u003eA list of static default values for a given integer parameter.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSetJoinInstruction":{"description":"\u003cp\u003eThe instructions associated with a join. \u003c/p\u003e","properties":{"leftJoinKeyProperties":{"$ref":"#/types/aws-native:quicksight:DataSetJoinKeyProperties","description":"Join key properties of the left operand."},"leftOperand":{"type":"string","description":"\u003cp\u003eThe operand on the left side of a join.\u003c/p\u003e"},"onClause":{"type":"string","description":"\u003cp\u003eThe join instructions provided in the \u003ccode\u003eON\u003c/code\u003e clause of a join.\u003c/p\u003e"},"rightJoinKeyProperties":{"$ref":"#/types/aws-native:quicksight:DataSetJoinKeyProperties","description":"Join key properties of the right operand."},"rightOperand":{"type":"string","description":"\u003cp\u003eThe operand on the right side of a join.\u003c/p\u003e"},"type":{"$ref":"#/types/aws-native:quicksight:DataSetJoinType","description":"The type of join that it is."}},"type":"object","required":["leftOperand","onClause","rightOperand","type"]},"aws-native:quicksight:DataSetJoinKeyProperties":{"description":"\u003cp\u003eProperties associated with the columns participating in a join.\u003c/p\u003e","properties":{"uniqueKey":{"type":"boolean","description":"\u003cp\u003eA value that indicates that a row in a table is uniquely identified by the columns in\n            a join key. This is used by Quick Suite to optimize query performance.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSetJoinOperandProperties":{"properties":{"outputColumnNameOverrides":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetOutputColumnNameOverride"},"description":"A list of column name overrides to apply to the join operand's output columns."}},"type":"object","required":["outputColumnNameOverrides"]},"aws-native:quicksight:DataSetJoinOperation":{"properties":{"alias":{"type":"string","description":"Alias for this operation."},"leftOperand":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperationSource","description":"The left operand for the join operation."},"leftOperandProperties":{"$ref":"#/types/aws-native:quicksight:DataSetJoinOperandProperties","description":"Properties that control how the left operand's columns are handled in the join result."},"onClause":{"type":"string","description":"The join condition that specifies how to match rows between the left and right operands."},"rightOperand":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperationSource","description":"The right operand for the join operation."},"rightOperandProperties":{"$ref":"#/types/aws-native:quicksight:DataSetJoinOperandProperties","description":"Properties that control how the right operand's columns are handled in the join result."},"type":{"$ref":"#/types/aws-native:quicksight:DataSetJoinOperationType","description":"The type of join to perform, such as `INNER` , `LEFT` , `RIGHT` , or `OUTER` ."}},"type":"object","required":["alias","leftOperand","onClause","rightOperand","type"]},"aws-native:quicksight:DataSetJoinOperationType":{"type":"string","enum":[{"name":"Inner","value":"INNER"},{"name":"Outer","value":"OUTER"},{"name":"Left","value":"LEFT"},{"name":"Right","value":"RIGHT"}]},"aws-native:quicksight:DataSetJoinType":{"type":"string","enum":[{"name":"Inner","value":"INNER"},{"name":"Outer","value":"OUTER"},{"name":"Left","value":"LEFT"},{"name":"Right","value":"RIGHT"}]},"aws-native:quicksight:DataSetLogicalTable":{"description":"\u003cp\u003eA \u003ci\u003elogical table\u003c/i\u003e is a unit that joins and that data\n            transformations operate on. A logical table has a source, which can be either a physical\n            table or result of a join. When a logical table points to a physical table, the logical\n            table acts as a mutable copy of that physical table through transform operations.\u003c/p\u003e","properties":{"alias":{"type":"string","description":"\u003cp\u003eA display name for the logical table.\u003c/p\u003e"},"dataTransforms":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperation"},"description":"\u003cp\u003eTransform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. \u003c/p\u003e"},"source":{"$ref":"#/types/aws-native:quicksight:DataSetLogicalTableSource"}},"type":"object","required":["alias","source"]},"aws-native:quicksight:DataSetLogicalTableSource":{"description":"\u003cp\u003eInformation about the source of a logical table. This is a variant type structure. For\n            this structure to be valid, only one of the attributes can be non-null.\u003c/p\u003e","properties":{"dataSetArn":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Number (ARN) of the parent dataset.\u003c/p\u003e"},"joinInstruction":{"$ref":"#/types/aws-native:quicksight:DataSetJoinInstruction","description":"Specifies the result of a join of two logical tables."},"physicalTableId":{"type":"string","description":"\u003cp\u003ePhysical table ID.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSetLookbackWindow":{"description":"\u003cp\u003eThe lookback window setup of an incremental refresh configuration.\u003c/p\u003e","properties":{"columnName":{"type":"string","description":"\u003cp\u003eThe name of the lookback window column.\u003c/p\u003e"},"size":{"type":"number","description":"\u003cp\u003eThe lookback window column size.\u003c/p\u003e"},"sizeUnit":{"$ref":"#/types/aws-native:quicksight:DataSetLookbackWindowSizeUnit","description":"The size unit that is used for the lookback window column. Valid values for this structure are `HOUR` , `DAY` , and `WEEK` ."}},"type":"object","required":["columnName","size","sizeUnit"]},"aws-native:quicksight:DataSetLookbackWindowSizeUnit":{"type":"string","enum":[{"name":"Hour","value":"HOUR"},{"name":"Day","value":"DAY"},{"name":"Week","value":"WEEK"}]},"aws-native:quicksight:DataSetNewDefaultValues":{"description":"\u003cp\u003eThe configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.\u003c/p\u003e","properties":{"dateTimeStaticValues":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eA list of static default values for a given date time parameter.\u003c/p\u003e"},"decimalStaticValues":{"type":"array","items":{"type":"number"},"description":"\u003cp\u003eA list of static default values for a given decimal parameter.\u003c/p\u003e"},"integerStaticValues":{"type":"array","items":{"type":"integer"},"description":"\u003cp\u003eA list of static default values for a given integer parameter.\u003c/p\u003e"},"stringStaticValues":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eA list of static default values for a given string parameter.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSetNumericComparisonFilterCondition":{"properties":{"operator":{"$ref":"#/types/aws-native:quicksight:DataSetNumericComparisonFilterOperator","description":"The comparison operator to use, such as `EQUALS` , `GREATER_THAN` , `LESS_THAN` , or their variants."},"value":{"$ref":"#/types/aws-native:quicksight:DataSetNumericFilterValue","description":"The numeric value to compare against."}},"type":"object","required":["operator"]},"aws-native:quicksight:DataSetNumericComparisonFilterOperator":{"type":"string","enum":[{"name":"Equals","value":"EQUALS"},{"name":"DoesNotEqual","value":"DOES_NOT_EQUAL"},{"name":"GreaterThan","value":"GREATER_THAN"},{"name":"GreaterThanOrEqualsTo","value":"GREATER_THAN_OR_EQUALS_TO"},{"name":"LessThan","value":"LESS_THAN"},{"name":"LessThanOrEqualsTo","value":"LESS_THAN_OR_EQUALS_TO"}]},"aws-native:quicksight:DataSetNumericFilterCondition":{"properties":{"columnName":{"type":"string","description":"The name of the numeric column to filter."},"comparisonFilterCondition":{"$ref":"#/types/aws-native:quicksight:DataSetNumericComparisonFilterCondition","description":"A comparison-based filter condition for the numeric column."},"rangeFilterCondition":{"$ref":"#/types/aws-native:quicksight:DataSetNumericRangeFilterCondition","description":"A range-based filter condition for the numeric column, filtering values between minimum and maximum numbers."}},"type":"object"},"aws-native:quicksight:DataSetNumericFilterValue":{"properties":{"staticValue":{"type":"number","description":"A static numeric value used for filtering."}},"type":"object"},"aws-native:quicksight:DataSetNumericRangeFilterCondition":{"properties":{"includeMaximum":{"type":"boolean","description":"Whether to include the maximum value in the filter range."},"includeMinimum":{"type":"boolean","description":"Whether to include the minimum value in the filter range."},"rangeMaximum":{"$ref":"#/types/aws-native:quicksight:DataSetNumericFilterValue","description":"The maximum numeric value for the range filter."},"rangeMinimum":{"$ref":"#/types/aws-native:quicksight:DataSetNumericFilterValue","description":"The minimum numeric value for the range filter."}},"type":"object"},"aws-native:quicksight:DataSetOutputColumn":{"description":"\u003cp\u003eOutput column.\u003c/p\u003e","properties":{"description":{"type":"string","description":"\u003cp\u003eA description for a column.\u003c/p\u003e"},"id":{"type":"string","description":"A unique identifier for the output column."},"name":{"type":"string","description":"\u003cp\u003eThe display name of the column..\u003c/p\u003e"},"subType":{"$ref":"#/types/aws-native:quicksight:DataSetColumnDataSubType","description":"The sub data type of the column."},"type":{"$ref":"#/types/aws-native:quicksight:DataSetColumnDataType","description":"The data type of the column."}},"type":"object"},"aws-native:quicksight:DataSetOutputColumnNameOverride":{"properties":{"outputColumnName":{"type":"string","description":"The new name to assign to the column in the output."},"sourceColumnName":{"type":"string","description":"The original name of the column from the source transform operation."}},"type":"object","required":["outputColumnName"]},"aws-native:quicksight:DataSetOverrideDatasetParameterOperation":{"description":"\u003cp\u003eA transform operation that overrides the dataset parameter values that are defined in another dataset.\u003c/p\u003e","properties":{"newDefaultValues":{"$ref":"#/types/aws-native:quicksight:DataSetNewDefaultValues","description":"The new default values for the parameter."},"newParameterName":{"type":"string","description":"\u003cp\u003eThe new name for the parameter.\u003c/p\u003e"},"parameterName":{"type":"string","description":"\u003cp\u003eThe name of the parameter to be overridden with different values.\u003c/p\u003e"}},"type":"object","required":["parameterName"]},"aws-native:quicksight:DataSetParentDataSet":{"properties":{"dataSetArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the parent dataset."},"inputColumns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetInputColumn"},"description":"The list of input columns available from the parent dataset."}},"type":"object","required":["dataSetArn","inputColumns"]},"aws-native:quicksight:DataSetPerformanceConfiguration":{"properties":{"uniqueKeys":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetUniqueKey"}}},"type":"object"},"aws-native:quicksight:DataSetPhysicalTable":{"description":"\u003cp\u003eA view of a data source that contains information about the shape of the data in the\n            underlying source. This is a variant type structure. For this structure to be valid,\n            only one of the attributes can be non-null.\u003c/p\u003e","properties":{"customSql":{"$ref":"#/types/aws-native:quicksight:DataSetCustomSql","description":"A physical table type built from the results of the custom SQL query."},"relationalTable":{"$ref":"#/types/aws-native:quicksight:DataSetRelationalTable","description":"A physical table type for relational data sources."},"s3Source":{"$ref":"#/types/aws-native:quicksight:DataSetS3Source","description":"A physical table type for as S3 data source."},"saaSTable":{"$ref":"#/types/aws-native:quicksight:DataSetSaaSTable","description":"A physical table type for Software-as-a-Service (SaaS) sources."}},"type":"object"},"aws-native:quicksight:DataSetPivotConfiguration":{"properties":{"labelColumnName":{"type":"string","description":"The name of the column that contains the labels to be pivoted into separate columns."},"pivotedLabels":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetPivotedLabel"},"description":"The list of specific label values to pivot into separate columns."}},"type":"object","required":["pivotedLabels"]},"aws-native:quicksight:DataSetPivotOperation":{"properties":{"alias":{"type":"string","description":"Alias for this operation."},"groupByColumnNames":{"type":"array","items":{"type":"string"},"description":"The list of column names to group by when performing the pivot operation."},"pivotConfiguration":{"$ref":"#/types/aws-native:quicksight:DataSetPivotConfiguration","description":"Configuration that specifies which labels to pivot and how to structure the resulting columns."},"source":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperationSource","description":"The source transform operation that provides input data for pivoting."},"valueColumnConfiguration":{"$ref":"#/types/aws-native:quicksight:DataSetValueColumnConfiguration","description":"Configuration for how to aggregate values when multiple rows map to the same pivoted column."}},"type":"object","required":["alias","pivotConfiguration","source","valueColumnConfiguration"]},"aws-native:quicksight:DataSetPivotedLabel":{"properties":{"labelName":{"type":"string","description":"The label value from the source data to be pivoted."},"newColumnId":{"type":"string","description":"A unique identifier for the new column created from this pivoted label."},"newColumnName":{"type":"string","description":"The name for the new column created from this pivoted label."}},"type":"object","required":["labelName","newColumnId","newColumnName"]},"aws-native:quicksight:DataSetProjectOperation":{"description":"\u003cp\u003eA transform operation that projects columns. Operations that come after a projection\n            can only refer to projected columns.\u003c/p\u003e","properties":{"alias":{"type":"string","description":"Alias for this operation."},"projectedColumns":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eProjected columns.\u003c/p\u003e"},"source":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperationSource","description":"The source transform operation that provides input data for column projection."}},"type":"object"},"aws-native:quicksight:DataSetRefreshConfiguration":{"description":"\u003cp\u003eThe refresh configuration of a dataset.\u003c/p\u003e","properties":{"incrementalRefresh":{"$ref":"#/types/aws-native:quicksight:DataSetIncrementalRefresh","description":"The incremental refresh for the dataset."}},"type":"object","required":["incrementalRefresh"]},"aws-native:quicksight:DataSetRefreshFailureAlertStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:DataSetRefreshFailureConfiguration":{"properties":{"emailAlert":{"$ref":"#/types/aws-native:quicksight:DataSetRefreshFailureEmailAlert","description":"The email alert configuration for a dataset refresh failure."}},"type":"object"},"aws-native:quicksight:DataSetRefreshFailureEmailAlert":{"properties":{"alertStatus":{"$ref":"#/types/aws-native:quicksight:DataSetRefreshFailureAlertStatus","description":"The status value that determines if email alerts are sent."}},"type":"object"},"aws-native:quicksight:DataSetRefreshProperties":{"description":"\u003cp\u003eThe refresh properties of a dataset.\u003c/p\u003e","properties":{"failureConfiguration":{"$ref":"#/types/aws-native:quicksight:DataSetRefreshFailureConfiguration","description":"The failure configuration for a dataset."},"refreshConfiguration":{"$ref":"#/types/aws-native:quicksight:DataSetRefreshConfiguration","description":"The refresh configuration for a dataset."}},"type":"object"},"aws-native:quicksight:DataSetRelationalTable":{"description":"\u003cp\u003eA physical table type for relational data sources.\u003c/p\u003e","properties":{"catalog":{"type":"string","description":"\u003cp\u003eThe catalog associated with a table.\u003c/p\u003e"},"dataSourceArn":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) for the data source.\u003c/p\u003e"},"inputColumns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetInputColumn"},"description":"\u003cp\u003eThe column schema of the table.\u003c/p\u003e"},"name":{"type":"string","description":"\u003cp\u003eThe name of the relational table.\u003c/p\u003e"},"schema":{"type":"string","description":"\u003cp\u003eThe schema name. This name applies to certain relational database engines.\u003c/p\u003e"}},"type":"object","required":["dataSourceArn","inputColumns","name"]},"aws-native:quicksight:DataSetRenameColumnOperation":{"description":"\u003cp\u003eA transform operation that renames a column.\u003c/p\u003e","properties":{"columnName":{"type":"string","description":"\u003cp\u003eThe name of the column to be renamed.\u003c/p\u003e"},"newColumnName":{"type":"string","description":"\u003cp\u003eThe new name for the column.\u003c/p\u003e"}},"type":"object","required":["columnName","newColumnName"]},"aws-native:quicksight:DataSetRenameColumnsOperation":{"properties":{"alias":{"type":"string","description":"Alias for this operation."},"renameColumnOperations":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetRenameColumnOperation"},"description":"The list of column rename operations to perform, specifying old and new column names."},"source":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperationSource","description":"The source transform operation that provides input data for column renaming."}},"type":"object","required":["alias","renameColumnOperations","source"]},"aws-native:quicksight:DataSetResourcePermission":{"description":"\u003cp\u003ePermission for the resource.\u003c/p\u003e","properties":{"actions":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eThe IAM action to grant or revoke permissions on.\u003c/p\u003e"},"principal":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) of the principal. This can be one of the\n            following:\u003c/p\u003e\n         \u003cul\u003e\n            \u003cli\u003e\n               \u003cp\u003eThe ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)\u003c/p\u003e\n            \u003c/li\u003e\n            \u003cli\u003e\n               \u003cp\u003eThe ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)\u003c/p\u003e\n            \u003c/li\u003e\n            \u003cli\u003e\n               \u003cp\u003eThe ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight\n                    ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.\n                    (This is less common.) \u003c/p\u003e\n            \u003c/li\u003e\n         \u003c/ul\u003e"}},"type":"object","required":["actions","principal"]},"aws-native:quicksight:DataSetRowLevelPermissionConfiguration":{"properties":{"rowLevelPermissionDataSet":{"$ref":"#/types/aws-native:quicksight:DataSetRowLevelPermissionDataSet"},"tagConfiguration":{"$ref":"#/types/aws-native:quicksight:DataSetRowLevelPermissionTagConfiguration"}},"type":"object"},"aws-native:quicksight:DataSetRowLevelPermissionDataSet":{"description":"\u003cp\u003eInformation about a dataset that contains permissions for row-level security (RLS).\n            The permissions dataset maps fields to users or groups. For more information, see\n            \u003ca href=\"https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html\"\u003eUsing Row-Level Security (RLS) to Restrict Access to a Dataset\u003c/a\u003e in the \u003ci\u003eAmazon Quick Suite User\n                Guide\u003c/i\u003e.\u003c/p\u003e\n         \u003cp\u003eThe option to deny permissions by setting \u003ccode\u003ePermissionPolicy\u003c/code\u003e to \u003ccode\u003eDENY_ACCESS\u003c/code\u003e is\n            not supported for new RLS datasets.\u003c/p\u003e","properties":{"arn":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.\u003c/p\u003e"},"formatVersion":{"$ref":"#/types/aws-native:quicksight:DataSetRowLevelPermissionFormatVersion","description":"The user or group rules associated with the dataset that contains permissions for RLS.\n\nBy default, `FormatVersion` is `VERSION_1` . When `FormatVersion` is `VERSION_1` , `UserName` and `GroupName` are required. When `FormatVersion` is `VERSION_2` , `UserARN` and `GroupARN` are required, and `Namespace` must not exist."},"namespace":{"type":"string","description":"\u003cp\u003eThe namespace associated with the dataset that contains permissions for RLS.\u003c/p\u003e"},"permissionPolicy":{"$ref":"#/types/aws-native:quicksight:DataSetRowLevelPermissionPolicy","description":"The type of permissions to use when interpreting the permissions for RLS. `DENY_ACCESS` is included for backward compatibility only."},"status":{"$ref":"#/types/aws-native:quicksight:DataSetStatus","description":"The status of the row-level security permission dataset. If enabled, the status is `ENABLED` . If disabled, the status is `DISABLED` ."}},"type":"object","required":["arn","permissionPolicy"]},"aws-native:quicksight:DataSetRowLevelPermissionFormatVersion":{"type":"string","enum":[{"name":"Version1","value":"VERSION_1"},{"name":"Version2","value":"VERSION_2"}]},"aws-native:quicksight:DataSetRowLevelPermissionPolicy":{"type":"string","enum":[{"name":"GrantAccess","value":"GRANT_ACCESS"},{"name":"DenyAccess","value":"DENY_ACCESS"}]},"aws-native:quicksight:DataSetRowLevelPermissionTagConfiguration":{"description":"\u003cp\u003eThe configuration of tags on a dataset to set row-level security. \u003c/p\u003e","properties":{"status":{"$ref":"#/types/aws-native:quicksight:DataSetStatus","description":"The status of row-level security tags. If enabled, the status is `ENABLED` . If disabled, the status is `DISABLED` ."},"tagRuleConfigurations":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"\u003cp\u003eA list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.\u003c/p\u003e"},"tagRules":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetRowLevelPermissionTagRule"},"description":"\u003cp\u003eA set of rules associated with row-level security, such as the tag names and columns that they are assigned to.\u003c/p\u003e"}},"type":"object","required":["tagRules"]},"aws-native:quicksight:DataSetRowLevelPermissionTagRule":{"description":"\u003cp\u003eA set of rules associated with a tag.\u003c/p\u003e","properties":{"columnName":{"type":"string","description":"\u003cp\u003eThe column name that a tag key is assigned to.\u003c/p\u003e"},"matchAllValue":{"type":"string","description":"\u003cp\u003eA string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.\u003c/p\u003e"},"tagKey":{"type":"string","description":"\u003cp\u003eThe unique key for a tag.\u003c/p\u003e"},"tagMultiValueDelimiter":{"type":"string","description":"\u003cp\u003eA string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.\u003c/p\u003e"}},"type":"object","required":["columnName","tagKey"]},"aws-native:quicksight:DataSetS3Source":{"description":"\u003cp\u003eA physical table type for an S3 data source.\u003c/p\u003e","properties":{"dataSourceArn":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) for the data source.\u003c/p\u003e"},"inputColumns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetInputColumn"},"description":"\u003cp\u003eA physical table type for an S3 data source.\u003c/p\u003e\n         \u003cnote\u003e\n            \u003cp\u003eFor files that aren't JSON, only \u003ccode\u003eSTRING\u003c/code\u003e data types are supported in input columns.\u003c/p\u003e\n         \u003c/note\u003e"},"uploadSettings":{"$ref":"#/types/aws-native:quicksight:DataSetUploadSettings","description":"Information about the format for the S3 source file or files."}},"type":"object","required":["dataSourceArn","inputColumns"]},"aws-native:quicksight:DataSetSaaSTable":{"properties":{"dataSourceArn":{"type":"string","description":"The Amazon Resource Name (ARN) of the SaaS data source."},"inputColumns":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetInputColumn"},"description":"The list of input columns available from the SaaS table."},"tablePath":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetTablePathElement"},"description":"The hierarchical path to the table within the SaaS data source."}},"type":"object","required":["dataSourceArn","inputColumns","tablePath"]},"aws-native:quicksight:DataSetSemanticModelConfiguration":{"properties":{"tableMap":{"type":"object","additionalProperties":{"$ref":"#/types/aws-native:quicksight:DataSetSemanticTable"},"description":"A map of semantic tables that define the analytical structure."}},"type":"object"},"aws-native:quicksight:DataSetSemanticTable":{"properties":{"alias":{"type":"string","description":"Alias for the semantic table."},"destinationTableId":{"type":"string","description":"The identifier of the destination table from data preparation that provides data to this semantic table."},"rowLevelPermissionConfiguration":{"$ref":"#/types/aws-native:quicksight:DataSetRowLevelPermissionConfiguration","description":"Configuration for row level security that control data access for this semantic table."}},"type":"object","required":["alias","destinationTableId"]},"aws-native:quicksight:DataSetSourceTable":{"properties":{"dataSet":{"$ref":"#/types/aws-native:quicksight:DataSetParentDataSet","description":"A parent dataset that serves as the data source instead of a physical table."},"physicalTableId":{"type":"string","description":"The identifier of the physical table that serves as the data source."}},"type":"object"},"aws-native:quicksight:DataSetStatus":{"type":"string","enum":[{"name":"Enabled","value":"ENABLED"},{"name":"Disabled","value":"DISABLED"}]},"aws-native:quicksight:DataSetStringComparisonFilterCondition":{"properties":{"operator":{"$ref":"#/types/aws-native:quicksight:DataSetStringComparisonFilterOperator","description":"The comparison operator to use, such as `EQUALS` , `CONTAINS` , `STARTS_WITH` , `ENDS_WITH` , or their negations."},"value":{"$ref":"#/types/aws-native:quicksight:DataSetStringFilterValue","description":"The string value to compare against."}},"type":"object","required":["operator"]},"aws-native:quicksight:DataSetStringComparisonFilterOperator":{"type":"string","enum":[{"name":"Equals","value":"EQUALS"},{"name":"DoesNotEqual","value":"DOES_NOT_EQUAL"},{"name":"Contains","value":"CONTAINS"},{"name":"DoesNotContain","value":"DOES_NOT_CONTAIN"},{"name":"StartsWith","value":"STARTS_WITH"},{"name":"EndsWith","value":"ENDS_WITH"}]},"aws-native:quicksight:DataSetStringDatasetParameter":{"description":"\u003cp\u003eA string parameter for a dataset.\u003c/p\u003e","properties":{"defaultValues":{"$ref":"#/types/aws-native:quicksight:DataSetStringDatasetParameterDefaultValues","description":"A list of default values for a given string dataset parameter type. This structure only accepts static values."},"id":{"type":"string","description":"\u003cp\u003eAn identifier for the string parameter that is created in the dataset.\u003c/p\u003e"},"name":{"type":"string","description":"\u003cp\u003eThe name of the string parameter that is created in the dataset.\u003c/p\u003e"},"valueType":{"$ref":"#/types/aws-native:quicksight:DataSetDatasetParameterValueType","description":"The value type of the dataset parameter. Valid values are `single value` or `multi value` ."}},"type":"object","required":["id","name","valueType"]},"aws-native:quicksight:DataSetStringDatasetParameterDefaultValues":{"description":"\u003cp\u003eThe default values of a string parameter.\u003c/p\u003e","properties":{"staticValues":{"type":"array","items":{"type":"string"},"description":"\u003cp\u003eA list of static default values for a given string parameter.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSetStringFilterCondition":{"properties":{"columnName":{"type":"string","description":"The name of the string column to filter."},"comparisonFilterCondition":{"$ref":"#/types/aws-native:quicksight:DataSetStringComparisonFilterCondition","description":"A comparison-based filter condition for the string column."},"listFilterCondition":{"$ref":"#/types/aws-native:quicksight:DataSetStringListFilterCondition","description":"A list-based filter condition that includes or excludes values from a specified list."}},"type":"object"},"aws-native:quicksight:DataSetStringFilterValue":{"properties":{"staticValue":{"type":"string","description":"A static string value used for filtering."}},"type":"object"},"aws-native:quicksight:DataSetStringListFilterCondition":{"properties":{"operator":{"$ref":"#/types/aws-native:quicksight:DataSetStringListFilterOperator","description":"The list operator to use, either `INCLUDE` to match values in the list or `EXCLUDE` to filter out values in the list."},"values":{"$ref":"#/types/aws-native:quicksight:DataSetStringListFilterValue","description":"The list of string values to include or exclude in the filter."}},"type":"object","required":["operator"]},"aws-native:quicksight:DataSetStringListFilterOperator":{"type":"string","enum":[{"name":"Include","value":"INCLUDE"},{"name":"Exclude","value":"EXCLUDE"}]},"aws-native:quicksight:DataSetStringListFilterValue":{"properties":{"staticValues":{"type":"array","items":{"type":"string"},"description":"A list of static string values used for filtering."}},"type":"object"},"aws-native:quicksight:DataSetTablePathElement":{"properties":{"id":{"type":"string","description":"The unique identifier of the path element."},"name":{"type":"string","description":"The name of the path element."}},"type":"object"},"aws-native:quicksight:DataSetTag":{"description":"\u003cp\u003eThe key or keys of the key-value pairs for the resource tag or tags assigned to the\n            resource.\u003c/p\u003e","properties":{"key":{"type":"string","description":"\u003cp\u003eTag key.\u003c/p\u003e"},"value":{"type":"string","description":"\u003cp\u003eTag value.\u003c/p\u003e"}},"type":"object","required":["key","value"]},"aws-native:quicksight:DataSetTagColumnOperation":{"description":"\u003cp\u003eA transform operation that tags a column with additional information.\u003c/p\u003e","properties":{"columnName":{"type":"string","description":"\u003cp\u003eThe column that this operation acts on.\u003c/p\u003e"},"tags":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetColumnTag"},"description":"\u003cp\u003eThe dataset column tag, currently only used for geospatial type tagging.\u003c/p\u003e\n         \u003cnote\u003e\n            \u003cp\u003eThis is not tags for the Amazon Web Services tagging feature.\u003c/p\u003e\n         \u003c/note\u003e"}},"type":"object","required":["columnName","tags"]},"aws-native:quicksight:DataSetTextQualifier":{"type":"string","enum":[{"name":"DoubleQuote","value":"DOUBLE_QUOTE"},{"name":"SingleQuote","value":"SINGLE_QUOTE"}]},"aws-native:quicksight:DataSetTimeGranularity":{"type":"string","enum":[{"name":"Year","value":"YEAR"},{"name":"Quarter","value":"QUARTER"},{"name":"Month","value":"MONTH"},{"name":"Week","value":"WEEK"},{"name":"Day","value":"DAY"},{"name":"Hour","value":"HOUR"},{"name":"Minute","value":"MINUTE"},{"name":"Second","value":"SECOND"},{"name":"Millisecond","value":"MILLISECOND"}]},"aws-native:quicksight:DataSetTransformOperation":{"description":"\u003cp\u003eA data transformation on a logical table. This is a variant type structure. For this\n            structure to be valid, only one of the attributes can be non-null.\u003c/p\u003e","properties":{"castColumnTypeOperation":{"$ref":"#/types/aws-native:quicksight:DataSetCastColumnTypeOperation","description":"A transform operation that casts a column to a different type."},"createColumnsOperation":{"$ref":"#/types/aws-native:quicksight:DataSetCreateColumnsOperation","description":"An operation that creates calculated columns. Columns created in one such operation form a lexical closure."},"filterOperation":{"$ref":"#/types/aws-native:quicksight:DataSetFilterOperation","description":"An operation that filters rows based on some condition."},"overrideDatasetParameterOperation":{"$ref":"#/types/aws-native:quicksight:DataSetOverrideDatasetParameterOperation","description":"A transform operation that overrides the dataset parameter values that are defined in another dataset."},"projectOperation":{"$ref":"#/types/aws-native:quicksight:DataSetProjectOperation","description":"An operation that projects columns. Operations that come after a projection can only refer to projected columns."},"renameColumnOperation":{"$ref":"#/types/aws-native:quicksight:DataSetRenameColumnOperation","description":"An operation that renames a column."},"tagColumnOperation":{"$ref":"#/types/aws-native:quicksight:DataSetTagColumnOperation","description":"An operation that tags a column with additional information."},"untagColumnOperation":{"$ref":"#/types/aws-native:quicksight:DataSetUntagColumnOperation"}},"type":"object"},"aws-native:quicksight:DataSetTransformOperationSource":{"properties":{"columnIdMappings":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetColumnIdMapping"},"description":"The mappings between source column identifiers and target column identifiers for this transformation."},"transformOperationId":{"type":"string","description":"The identifier of the transform operation that provides input data."}},"type":"object","required":["transformOperationId"]},"aws-native:quicksight:DataSetTransformStep":{"properties":{"aggregateStep":{"$ref":"#/types/aws-native:quicksight:DataSetAggregateOperation","description":"A transform step that groups data and applies aggregation functions to calculate summary values."},"appendStep":{"$ref":"#/types/aws-native:quicksight:DataSetAppendOperation","description":"A transform step that combines rows from multiple sources by stacking them vertically."},"castColumnTypesStep":{"$ref":"#/types/aws-native:quicksight:DataSetCastColumnTypesOperation","description":"A transform step that changes the data types of one or more columns."},"createColumnsStep":{"$ref":"#/types/aws-native:quicksight:DataSetCreateColumnsOperation"},"filtersStep":{"$ref":"#/types/aws-native:quicksight:DataSetFiltersOperation","description":"A transform step that applies filter conditions."},"importTableStep":{"$ref":"#/types/aws-native:quicksight:DataSetImportTableOperation","description":"A transform step that brings data from a source table."},"joinStep":{"$ref":"#/types/aws-native:quicksight:DataSetJoinOperation","description":"A transform step that combines data from two sources based on specified join conditions."},"pivotStep":{"$ref":"#/types/aws-native:quicksight:DataSetPivotOperation","description":"A transform step that converts row values into columns to reshape the data structure."},"projectStep":{"$ref":"#/types/aws-native:quicksight:DataSetProjectOperation"},"renameColumnsStep":{"$ref":"#/types/aws-native:quicksight:DataSetRenameColumnsOperation","description":"A transform step that changes the names of one or more columns."},"unpivotStep":{"$ref":"#/types/aws-native:quicksight:DataSetUnpivotOperation","description":"A transform step that converts columns into rows to normalize the data structure."}},"type":"object"},"aws-native:quicksight:DataSetUniqueKey":{"properties":{"columnNames":{"type":"array","items":{"type":"string"}}},"type":"object","required":["columnNames"]},"aws-native:quicksight:DataSetUnpivotOperation":{"properties":{"alias":{"type":"string","description":"Alias for this operation."},"columnsToUnpivot":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetColumnToUnpivot"},"description":"The list of columns to unpivot from the source data."},"source":{"$ref":"#/types/aws-native:quicksight:DataSetTransformOperationSource","description":"The source transform operation that provides input data for unpivoting."},"unpivotedLabelColumnId":{"type":"string","description":"A unique identifier for the new column that will contain the unpivoted column names."},"unpivotedLabelColumnName":{"type":"string","description":"The name for the new column that will contain the unpivoted column names."},"unpivotedValueColumnId":{"type":"string","description":"A unique identifier for the new column that will contain the unpivoted values."},"unpivotedValueColumnName":{"type":"string","description":"The name for the new column that will contain the unpivoted values."}},"type":"object","required":["alias","columnsToUnpivot","source","unpivotedLabelColumnId","unpivotedLabelColumnName","unpivotedValueColumnId","unpivotedValueColumnName"]},"aws-native:quicksight:DataSetUntagColumnOperation":{"description":"\u003cp\u003eA transform operation that removes tags associated with a column.\u003c/p\u003e","properties":{"columnName":{"type":"string","description":"\u003cp\u003eThe column that this operation acts on.\u003c/p\u003e"},"tagNames":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSetColumnTagName"},"description":"\u003cp\u003eThe column tags to remove from this column.\u003c/p\u003e"}},"type":"object","required":["columnName","tagNames"]},"aws-native:quicksight:DataSetUploadSettings":{"description":"\u003cp\u003eInformation about the format for a source file or files.\u003c/p\u003e","properties":{"containsHeader":{"type":"boolean","description":"\u003cp\u003eWhether the file has a header row, or the files each have a header row.\u003c/p\u003e"},"delimiter":{"type":"string","description":"\u003cp\u003eThe delimiter between values in the file.\u003c/p\u003e"},"format":{"$ref":"#/types/aws-native:quicksight:DataSetFileFormat","description":"File format."},"startFromRow":{"type":"number","description":"\u003cp\u003eA row number to start reading data from.\u003c/p\u003e"},"textQualifier":{"$ref":"#/types/aws-native:quicksight:DataSetTextQualifier","description":"Text qualifier."}},"type":"object"},"aws-native:quicksight:DataSetUsageConfiguration":{"description":"\u003cp\u003eThe usage configuration to apply to child datasets that reference this dataset as a source.\u003c/p\u003e","properties":{"disableUseAsDirectQuerySource":{"type":"boolean","description":"\u003cp\u003eAn option that controls whether a child dataset of a direct query can use this dataset as a source.\u003c/p\u003e"},"disableUseAsImportedSource":{"type":"boolean","description":"\u003cp\u003eAn option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSetUseAs":{"type":"string","enum":[{"name":"RlsRules","value":"RLS_RULES"}]},"aws-native:quicksight:DataSetValueColumnConfiguration":{"properties":{"aggregationFunction":{"$ref":"#/types/aws-native:quicksight:DataSetDataPrepAggregationFunction","description":"The aggregation function to apply when multiple values map to the same pivoted cell."}},"type":"object"},"aws-native:quicksight:DataSourceAmazonElasticsearchParameters":{"description":"\u003cp\u003eThe parameters for OpenSearch.\u003c/p\u003e","properties":{"domain":{"type":"string","description":"\u003cp\u003eThe OpenSearch domain.\u003c/p\u003e"}},"type":"object","required":["domain"]},"aws-native:quicksight:DataSourceAmazonOpenSearchParameters":{"description":"\u003cp\u003eThe parameters for OpenSearch.\u003c/p\u003e","properties":{"domain":{"type":"string","description":"\u003cp\u003eThe OpenSearch domain.\u003c/p\u003e"}},"type":"object","required":["domain"]},"aws-native:quicksight:DataSourceAthenaParameters":{"description":"\u003cp\u003eParameters for Amazon Athena.\u003c/p\u003e","properties":{"identityCenterConfiguration":{"$ref":"#/types/aws-native:quicksight:DataSourceIdentityCenterConfiguration","description":"An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.\n\nThis parameter can only be specified if your Quick Sight account is configured with IAM Identity Center."},"roleArn":{"type":"string","description":"\u003cp\u003eUse the \u003ccode\u003eRoleArn\u003c/code\u003e structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use \u003ccode\u003eRoleArn\u003c/code\u003e to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.\u003c/p\u003e"},"workGroup":{"type":"string","description":"\u003cp\u003eThe workgroup that Amazon Athena uses.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSourceAuroraParameters":{"description":"\u003cp\u003eParameters for Amazon Aurora.\u003c/p\u003e","properties":{"database":{"type":"string","description":"\u003cp\u003eDatabase.\u003c/p\u003e"},"host":{"type":"string","description":"\u003cp\u003eHost.\u003c/p\u003e"},"port":{"type":"number","description":"\u003cp\u003ePort.\u003c/p\u003e"}},"type":"object","required":["database","host","port"]},"aws-native:quicksight:DataSourceAuroraPostgreSqlParameters":{"description":"\u003cp\u003eParameters for Amazon Aurora PostgreSQL-Compatible Edition.\u003c/p\u003e","properties":{"database":{"type":"string","description":"\u003cp\u003eThe Amazon Aurora PostgreSQL database to connect to.\u003c/p\u003e"},"host":{"type":"string","description":"\u003cp\u003eThe Amazon Aurora PostgreSQL-Compatible host to connect to.\u003c/p\u003e"},"port":{"type":"number","description":"\u003cp\u003eThe port that Amazon Aurora PostgreSQL is listening on.\u003c/p\u003e"}},"type":"object","required":["database","host","port"]},"aws-native:quicksight:DataSourceAuthenticationType":{"type":"string","enum":[{"name":"Password","value":"PASSWORD"},{"name":"Token","value":"TOKEN"},{"name":"X509","value":"X509"},{"name":"Keypair","value":"KEYPAIR"}]},"aws-native:quicksight:DataSourceCredentialPair":{"description":"\u003cp\u003eThe combination of user name and password that are used as credentials.\u003c/p\u003e","properties":{"alternateDataSourceParameters":{"type":"array","items":{"$ref":"#/types/aws-native:quicksight:DataSourceParameters"},"description":"\u003cp\u003eA set of alternate data source parameters that you want to share for these\n            credentials. The credentials are applied in tandem with the data source parameters when\n            you copy a data source by using a create or update request. The API operation compares\n            the \u003ccode\u003eDataSourceParameters\u003c/code\u003e structure that's in the request with the\n            structures in the \u003ccode\u003eAlternateDataSourceParameters\u003c/code\u003e allow list. If the\n            structures are an exact match, the request is allowed to use the new data source with\n            the existing credentials. If the \u003ccode\u003eAlternateDataSourceParameters\u003c/code\u003e list is\n            null, the \u003ccode\u003eDataSourceParameters\u003c/code\u003e originally used with these\n                \u003ccode\u003eCredentials\u003c/code\u003e is automatically allowed.\u003c/p\u003e"},"password":{"type":"string","description":"\u003cp\u003ePassword.\u003c/p\u003e"},"username":{"type":"string","description":"\u003cp\u003eUser name.\u003c/p\u003e"}},"type":"object","required":["password","username"]},"aws-native:quicksight:DataSourceCredentials":{"description":"\u003cp\u003eData source credentials. This is a variant type structure. For this structure to be\n            valid, only one of the attributes can be non-null.\u003c/p\u003e","properties":{"copySourceArn":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) of a data source that has the credential pair that you\n            want to use. When \u003ccode\u003eCopySourceArn\u003c/code\u003e is not null, the credential pair from the\n            data source in the ARN is used as the credentials for the\n            \u003ccode\u003eDataSourceCredentials\u003c/code\u003e structure.\u003c/p\u003e"},"credentialPair":{"$ref":"#/types/aws-native:quicksight:DataSourceCredentialPair","description":"Credential pair. For more information, see `[CredentialPair](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html)` ."},"keyPairCredentials":{"$ref":"#/types/aws-native:quicksight:DataSourceKeyPairCredentials","description":"The credentials for connecting using key-pair."},"secretArn":{"type":"string","description":"\u003cp\u003eThe Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.\u003c/p\u003e"}},"type":"object"},"aws-native:quicksight:DataSourceDatabricksParameters":{"description":"\u003cp\u003eThe parameters that are required to connect to a Databricks data source.\u003c/p\u003e","properties":{"host":{"type":"string","description":"\u003cp\u003eThe host name of the Databricks data source.\u003c/p\u003e"},"port":{"type":"number","description":"\u003cp\u003eThe port for the Databricks data source.\u003c/p\u003e"},"sqlEndpointPath":{"type":"string","description":"\u003cp\u003eThe HTTP path of the Databricks data source.\u003c/p\u003e"}},"type":"object","required":["host","port","sqlEndpointPath"]},"aws-native:quicksight:DataSourceErrorInfo":{"description":"\u003cp\u003eError information for the data source creation or update.\u003c/p\u003e","properties":{"message":{"type":"string","description":"\u003cp\u003eError message.\u003c/p\u003e"},"type":{"$ref":"#/types/aws-native:quicksight:DataSourceErrorInfoType","description":"Error type."}},"type":"object"},"aws-native:quicksight:DataSourceErrorInfoType":{"type":"string","enum":[{"name":"AccessDenied","value":"ACCESS_DENIED"},{"name":"CopySourceNotFound","value":"COPY_SOURCE_NOT_FOUND"},{"name":"Timeout","value":"TIMEOUT"},{"name":"EngineVersionNotSupported","value":"ENGINE_VERSION_NOT_SUPPORTED"},{"name":"UnknownHost","value":"UNKNOWN_HOST"},{"name":"GenericSqlFailure","value":"GENERIC_SQL_FAILURE"},{"name":"Conflict","value":"CONFLICT"},{"name":"Unknown","value":"UNKNOWN"}]},"aws-native:quicksight:DataSourceIdentityCenterConfiguration":{"description":"\u00